org.glassfish.hk2.api

Interface DynamicConfiguration

All Known Implementing Classes:

AbstractBinder

public interface DynamicConfiguration

This class is used to add Descriptors to a ServiceLocator instance. No operation performed on this object will be reflected in the ServiceLocator until the commit method is called.

Author:

jwells

Method Summary

Methods

Modifier and Type	Method and Description
<T> ActiveDescriptor<T>	addActiveDescriptor(ActiveDescriptor<T> activeDescriptor) This allows third party systems to add reified active descriptors to the system.
<T> ActiveDescriptor<T>	addActiveDescriptor(ActiveDescriptor<T> activeDescriptor, boolean requiresDeepCopy) This allows third party systems to add reified active descriptors to the system.
<T> ActiveDescriptor<T>	addActiveDescriptor(Class<T> rawClass) This adds an active descriptor to the system based completely on the analysis of the given class.
void	addUnbindFilter(Filter unbindFilter) This filter will added to the list of filters in this Configuration that will determine which Descriptors will be removed from the system.
<T> ActiveDescriptor<T>	bind(Descriptor key) This method will bind the given descriptor to this Module.
<T> ActiveDescriptor<T>	bind(Descriptor key, boolean requiresDeepCopy) This method will bind the given descriptor to this Module.
FactoryDescriptors	bind(FactoryDescriptors factoryDescriptors) This method will bind the descriptors found in the FactoryDescriptors.
FactoryDescriptors	bind(FactoryDescriptors factoryDescriptors, boolean requiresDeepCopy) This method will bind the descriptors found in the FactoryDescriptors.
void	commit() This causes the configuration to get committed.

Method Detail

bind

<T> ActiveDescriptor<T> bind(Descriptor key)

This method will bind the given descriptor to this Module. If the descriptor given is not an ActiveDescriptor then a non-reified ActiveDescriptor will be returned with the system provided fields set. If the descriptor given is a reified ActiveDescriptor then the descriptor returned will be a reified ActiveDescriptor that takes all values except for the id from the given descriptor. A deep copy will be made of the incoming descriptor

Parameters:

key - May not be null. Will be used to derive the various key fields associated with the given provider

Returns:

The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

Throws:

IllegalArgumentException - if there is an error in the key

bind

<T> ActiveDescriptor<T> bind(Descriptor key,
                           boolean requiresDeepCopy)

This method will bind the given descriptor to this Module. If the descriptor given is not an ActiveDescriptor then a non-reified ActiveDescriptor will be returned with the system provided fields set. If the descriptor given is a reified ActiveDescriptor then the descriptor returned will be a reified ActiveDescriptor that takes all values except for the id from the given descriptor.

Parameters:

key - May not be null. Will be used to derive the various key fields associated with the given provider

requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)

Returns:

The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

Throws:

IllegalArgumentException - if there is an error in the key

bind

FactoryDescriptors bind(FactoryDescriptors factoryDescriptors)

This method will bind the descriptors found in the FactoryDescriptors. This method will first validate the descriptors from the FactoryDescriptors and then simply bind them into this configuration as two independent descriptors. A deep copy will be made of both descriptors

Parameters:

factoryDescriptors - A description of a factory service and the type the factory service provides. May not be null

Returns:

The descriptors returned from this object may be cast to ActiveDescriptor and will contain all the fields of the descriptors filled in by the system

Throws:

IllegalArgumentException - if there is an error in the input parameter

bind

FactoryDescriptors bind(FactoryDescriptors factoryDescriptors,
                      boolean requiresDeepCopy)

This method will bind the descriptors found in the FactoryDescriptors. This method will first validate the descriptors from the FactoryDescriptors and then simply bind them into this configuration as two independent descriptors. A deep copy will be made of both descriptors

Parameters:

factoryDescriptors - A description of a factory service and the type the factory service provides. May not be null

requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)

Returns:

The descriptors returned from this object may be cast to ActiveDescriptor and will contain all the fields of the descriptors filled in by the system

Throws:

IllegalArgumentException - if there is an error in the input parameter

addActiveDescriptor

<T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor)
                                        throws IllegalArgumentException

This allows third party systems to add reified active descriptors to the system. The active descriptor given must be fully reified (isReified must return true) and the create and destroy methods must be implemented. A deep copy will be made of the descriptor

Parameters:

activeDescriptor - The reified active descriptor to be added to the system. The system will not attempt to reify this descriptor itself

Returns:

The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

Throws:

IllegalArgumentException - if the descriptor is not reified

addActiveDescriptor

<T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor,
                                          boolean requiresDeepCopy)
                                        throws IllegalArgumentException

This allows third party systems to add reified active descriptors to the system. The active descriptor given must be fully reified (isReified must return true) and the create and destroy methods must be implemented. A deep copy will be made of the descriptor

Parameters:

activeDescriptor - The reified active descriptor to be added to the system. The system will not attempt to reify this descriptor itself

requiresDeepCopy - If true a deep copy will be made of the key. If false then the Descriptor will be used as is, and it is the responsibility of the caller to ensure that the fields of the Descriptor never change (with the exception of any writeable fields, such as ranking)

Returns:

The entry as added to the service registry, with fields of the Descriptor filled in by the system as appropriate

Throws:

IllegalArgumentException - if the descriptor is not reified

addActiveDescriptor

<T> ActiveDescriptor<T> addActiveDescriptor(Class<T> rawClass)
                                        throws MultiException,
                                               IllegalArgumentException

This adds an active descriptor to the system based completely on the analysis of the given class. The class itself and all interfaces marked contract will be in the list of advertised services. The scope and qualifiers will be taken from the annotations on the class.

Parameters:

rawClass - The class to analyze, must not be null

Returns:

The active (reified) descriptor that has been added to the system, with all fields filled in based on the rawClass

Throws:

MultiException - If this class cannot be a service

IllegalArgumentException - if rawClass is null

addUnbindFilter

void addUnbindFilter(Filter unbindFilter)
                     throws IllegalArgumentException

This filter will added to the list of filters in this Configuration that will determine which Descriptors will be removed from the system. Only services directly from this Configuration objects' associated ServiceLocator will be given to this Filter (it will not be given descriptors from the ServiceLocators parent). The descriptors passed into this filter may be cast to ActiveDescriptor. The descriptors passed into this filter may or may not have been reified. This filter should not reify passed in descriptors.

And descriptor for which this filter returns true will be removed from the ServiceLocator prior to any additions that are performed with this Configuration object. Hence a Configuration can remove and add a descriptor of the same type in one commit.

In order to unbind a filter the caller of commit must pass the LOOKUP validators and the UNBIND validators.

Parameters:

unbindFilter - This filter will be added to the list of filters that this configuration object will use to determine which descriptors to unbind from the system. May not be null

Throws:

IllegalArgumentException - if unbindFilter is null

commit

void commit()
            throws MultiException

This causes the configuration to get committed. This method may only be called once

Throws:

MultiException - If errors were found in the commit process

IllegalStateException - if this method was called more than once