org.qi4j.api.configuration
Class Configuration.ConfigurationMixin<T>

java.lang.Object
  org.qi4j.api.configuration.Configuration.ConfigurationMixin<T>

Type Parameters:

T -

All Implemented Interfaces:

Configuration<T>, Activatable

Enclosing interface:

Configuration<T>

public static class Configuration.ConfigurationMixin<T>
extends Object
implements Configuration<T>, Activatable

Implementation of Configuration.

This is effectively an internal class in Qi4j and should never be used directly by user code.

Nested Class Summary

Nested classes/interfaces inherited from interface org.qi4j.api.configuration.Configuration

Configuration.ConfigurationMixin<T>

Constructor Summary

Configuration.ConfigurationMixin()

Method Summary

void	activate() This is invoked on the service when the instance is being activated
T	configuration() Retrieves the user configuration instance managed by this Configuration.
void	passivate() This is invoked on the service when the instance is being passivated
void	refresh() Updates the values of the managed user ConfigurationComposite instance from the underlying EntityStore.
void	save() Persists the modified values in the user configuration instance to the underlying store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration.ConfigurationMixin

public Configuration.ConfigurationMixin()

Method Detail

configuration

public T configuration()

Description copied from interface: Configuration

Retrieves the user configuration instance managed by this Configuration.

Even if the user configuration is initialized from properties file, the consistency rules of Qi4j composites still applies. If the the properties file is missing a value, then the initialization will fail with a RuntimeException. If Constraints has been defined, those will need to be satisfied as well. The user configuration instance returned will fulfill the constraints and consistency normal to all composites, and can therefor safely be used with additional checks.

Specified by:

configuration in interface Configuration<T>

Returns:

The fully initialized and ready-to-use user configuration instance.

refresh

public void refresh()

Description copied from interface: Configuration

Updates the values of the managed user ConfigurationComposite instance from the underlying EntityStore. Any modified values in the current user configuration that has not been saved, via Configuration.save() method, will be lost.

Specified by:

refresh in interface Configuration<T>

save

public void save()

Description copied from interface: Configuration

Persists the modified values in the user configuration instance to the underlying store.

Specified by:

save in interface Configuration<T>

activate

public void activate()
              throws Exception

Description copied from interface: Activatable

This is invoked on the service when the instance is being activated

Specified by:

activate in interface Activatable

Throws:

Exception - if service could not be activated

passivate

public void passivate()
               throws Exception

Description copied from interface: Activatable

This is invoked on the service when the instance is being passivated

Specified by:

passivate in interface Activatable

Throws:

Exception - if the service could not be passivated