public interface DynamicConfiguration
Descriptor
s to a ServiceLocator
instance. No operation performed on this object will be reflected
in the ServiceLocator
until the commit method is called.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.
|
<T> FactoryDescriptors |
addActiveFactoryDescriptor(Class<? extends Factory<T>> rawFactoryClass)
This adds two active descriptors to the system based completely on the analysis
of the given
Factory class. |
void |
addIdempotentFilter(Filter... idempotentFilter)
At commit time all idempotent filters in this dynamic configuration will be run
against all validation-visible descriptors.
|
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.
|
void |
registerTwoPhaseResources(TwoPhaseResource... resources)
Registers two-phase resources in the order in which they are to run.
|
<T> ActiveDescriptor<T> bind(Descriptor key)
key
- May not be null. Will be used to derive the various
key fields associated with the given providerIllegalArgumentException
- if there is an error in the key<T> ActiveDescriptor<T> bind(Descriptor key, boolean requiresDeepCopy)
key
- May not be null. Will be used to derive the various
key fields associated with the given providerrequiresDeepCopy
- 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)IllegalArgumentException
- if there is an error in the keyFactoryDescriptors bind(FactoryDescriptors factoryDescriptors)
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 descriptorsfactoryDescriptors
- A description of a factory service
and the type the factory service provides. May not be nullIllegalArgumentException
- if there is an error in the input parameterFactoryDescriptors bind(FactoryDescriptors factoryDescriptors, boolean requiresDeepCopy)
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 descriptorsfactoryDescriptors
- A description of a factory service
and the type the factory service provides. May not be nullrequiresDeepCopy
- 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)IllegalArgumentException
- if there is an error in the input parameter<T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor) throws IllegalArgumentException
activeDescriptor
- The reified active descriptor to be added to the system. The
system will not attempt to reify this descriptor itselfIllegalArgumentException
- if the descriptor is not reified<T> ActiveDescriptor<T> addActiveDescriptor(ActiveDescriptor<T> activeDescriptor, boolean requiresDeepCopy) throws IllegalArgumentException
activeDescriptor
- The reified active descriptor to be added to the system. The
system will not attempt to reify this descriptor itselfrequiresDeepCopy
- 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)IllegalArgumentException
- if the descriptor is not reified<T> ActiveDescriptor<T> addActiveDescriptor(Class<T> rawClass) throws MultiException, IllegalArgumentException
rawClass
- The class to analyze, must not be nullMultiException
- If this class cannot be a serviceIllegalArgumentException
- if rawClass is null<T> FactoryDescriptors addActiveFactoryDescriptor(Class<? extends Factory<T>> rawFactoryClass) throws MultiException, IllegalArgumentException
Factory
class. The Factory
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. The annotations
on the Factory.provide()
method will provide the scope and qualifiers of the
service produced by the Factory
rawFactoryClass
- The class to analyze, must not be nullMultiException
- If this class cannot be a serviceIllegalArgumentException
- if rawClass is nullvoid addUnbindFilter(Filter unbindFilter) throws IllegalArgumentException
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.
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 nullIllegalArgumentException
- if unbindFilter is nullvoid addIdempotentFilter(Filter... idempotentFilter) throws IllegalArgumentException
The normal use case for the use of this filter is to ensure that a service is only added
once to the ServiceLocator
, even when multiple threads may be attempting to add the
same service
The filter passed in should not do any change to the set of descriptors itself, any attempt
to do so will leave the system in an inconsistent state. IndexedFilter
is supported
and is the normal use of an idempotent filter, though it is not required
idempotentFilter
- A non-null idempotent filter to use during commit. If any descriptors
match the filter, the commit will failIllegalArgumentException
- If any of the filters are nullvoid registerTwoPhaseResources(TwoPhaseResource... resources)
resources
- A list of resources to add to this dynamic configurationvoid commit() throws MultiException
MultiException
- If errors were found in the commit processIllegalStateException
- if this method was called more than onceCopyright © 2009–2019 Oracle Corporation. All rights reserved.