com.neeve.managed.toa.hk2

Class AbstractHK2TopicOrientedApplication

java.lang.Object

com.neeve.toa.TopicOrientedApplication

com.neeve.managed.toa.hk2.AbstractHK2TopicOrientedApplication

All Implemented Interfaces:

MessageInjector, MessageSender

public abstract class AbstractHK2TopicOrientedApplication
extends TopicOrientedApplication

The AbstractHK2TopicOrientedApplication is the base class for TOA Applications that want to leverage the HK2 Dependency Injection Framework. HK2 provides a light-weight but powerful dependency injection mechanism. The AbstractHK2TopicOrientedApplication integrates HK2 with Rumi Application Server and the Hornet Application Framework so that HK2 can be used to discover Rumi Managed Objects and Hornet Applications gain access to a Application ServiceLocator. Hornet Applications that want to leverage HK2 must extend this class and not TopicOrientedApplication.

See Also:

com.neeve.managed.toa.hk2

Nested Class Summary

Nested classes/interfaces inherited from class com.neeve.toa.TopicOrientedApplication

TopicOrientedApplication.ChannelJoin

Field Summary

Fields inherited from class com.neeve.toa.TopicOrientedApplication

_tracer, PROP_ALERT_TRACE_LEVEL, PROP_ALERT_TRACE_LEVEL_DEFAULT, PROP_DEFAULT_INJECTION_DELAY, PROP_DEFAULT_INJECTION_DELAY_DEFAULT, PROP_DISABLE_COMPAT_CHECK, PROP_DISABLE_COMPAT_CHECK_DEFAULT, PROP_ENABLED_DELAYED_ACK_CONTROLLER, PROP_ENABLED_DELAYED_ACK_CONTROLLER_DEFAULT, PROP_FAIL_ON_SERVICE_CHANNEL_NAME_COLLISION, PROP_FAIL_ON_SERVICE_CHANNEL_NAME_COLLISION_DEFAULT, PROP_GENERIC_HANDLER_JOINS_ALL, PROP_GENERIC_HANDLER_JOINS_ALL_DEFAULT, PROP_IGNORE_UNMAPPED_CHANNELS, PROP_IGNORE_UNMAPPED_CHANNELS_DEFAULT, PROP_USE_BUS_CONFIGURATION_TO_RESOLVE_CHANNEL_BUS, PROP_USE_BUS_CONFIGURATION_TO_RESOLVE_CHANNEL_BUS_DEFAULT

Constructor Summary

Constructors

Constructor and Description
AbstractHK2TopicOrientedApplication()

Method Summary

Modifier and Type	Method and Description
protected HK2ManagedObjectLocator	createManagedObjectLocator() Subclasses may override this method to construct a subclass of HK2ManagedObjectLocator.
protected abstract List<org.glassfish.hk2.utilities.Binder>	getApplicationModules() Get the Application Modules.
protected org.glassfish.hk2.api.ServiceLocator	getApplicationServiceLocator() Return the Application ServiceLocator.
protected ManagedObjectLocator	getManagedObjectLocator()
protected abstract String	getName() Get the Application Name.
protected void	onEngineDescriptorInjected(AepEngineDescriptor engineDescriptor) The AbstractHK2TopicOrientedApplication extends the life-cycle of the TopicOrientedApplication to allow for the creation of an HK2 ServiceLocator.

Methods inherited from class com.neeve.toa.TopicOrientedApplication

addAppCommandHandlerContainers, addAppStatContainers, addChannelFilterProviders, addChannelInitialKeyResolutionTableProviders, addChannelJoinProviders, addChannelQosProviders, addConfiguredContainers, addHandlerContainers, addPostdispatchMessageHandler, addPredispatchMessageHandler, addTopicResolverProviders, getAepMessageSender, getChannelFilter, getChannelJoin, getChannelQos, getConfigurer, getDelayedAcknowledgmentController, getEngine, getEngineClock, getInitialChannelKeyResolutionTable, getMessageInjector, getMessageSender, getServiceDefinitionLocator, getServiceModel, getServiceModels, getTopicResolver, injectMessage, injectMessage, injectMessage, injectMessage, injectMessage, injectMessage, onAppFinalized, onAppInitialized, onAppLoaderInjected, onConfigured, onEngineInjected, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHK2TopicOrientedApplication

public AbstractHK2TopicOrientedApplication()

Method Detail

onEngineDescriptorInjected

protected void onEngineDescriptorInjected(AepEngineDescriptor engineDescriptor)
                                   throws Exception

The AbstractHK2TopicOrientedApplication extends the life-cycle of the TopicOrientedApplication to allow for the creation of an HK2 ServiceLocator. The construction of the Application ServiceLocator happens early, during the AepEngineDescriptor customization phase so that components and/or services can be given the chance to participate in the initialization of the Application and the AEP Engine. Specifically, when this method is invoked two things happen (after the standard TopicOrientedApplication life-cycle):

4.1 Application ServiceLocator Creation

When the AepEngineDescriptor is injected the AbstractHK2TopicOrientedApplication will construct the Application ServiceLocator. After this point the Application may use the Application Service Locator to retrieve Services or other information (such as Configuration) from the ServiceLocator.

4.2 Application Service Injection

Once Application ServiceLocator has been constructed the Application object may have dependencies injected into this instance. These injected dependencies will be satisfied based upon the standard HK2 injection strategy. Note that only after this point will injected dependencies be available.

Overrides:

onEngineDescriptorInjected in class TopicOrientedApplication

Throws:

Exception

createManagedObjectLocator

protected HK2ManagedObjectLocator createManagedObjectLocator()

Subclasses may override this method to construct a subclass of HK2ManagedObjectLocator.

Returns:

An HK2ManagedObjectLocator

getManagedObjectLocator

protected ManagedObjectLocator getManagedObjectLocator()

Overrides:

getManagedObjectLocator in class TopicOrientedApplication

getApplicationServiceLocator

protected org.glassfish.hk2.api.ServiceLocator getApplicationServiceLocator()

Return the Application ServiceLocator. Every TOA HK2 Application is associated with a single HK2 ServiceLocator. The Application ServiceLocator has a name that is the same as the Application Name. All the the Application Modules will be bound into the Application ServiceLocator. The Application ServiceLocator can be used (via the standard HK2 API) to retrieve any services or components that are configured in any of the Application Modules.

Returns:

the Application ServiceLocator

Throws:

IllegalStateException - if the Application ServiceLocator is not available. This may happen if onEngineDescriptorInjected(AepEngineDescriptor) has not been invoked yet or if the Application has been shutdown

getApplicationModules

protected abstract List<org.glassfish.hk2.utilities.Binder> getApplicationModules()

Get the Application Modules. The Application Modules is a list of HK2 Binders that will be bound to the Application ServiceLocator. This list may be empty but it must not be null.

Returns:

the Application Modules

getName

protected abstract String getName()

Get the Application Name. The Application Name is a short, human-readable string that uniquely identifies an Application in the Rumi Server. Note that the name must be unique; two Applications running in the same Rumi Server must not have the same Application Name. The Application Name will be used to construct a unique ServiceLocator for the Application. The Application Name will be made available to components and services and can also be used to support qualified injection. The Application Name must not be null and must not be an empty string or a string that contains only whitespace.

Returns:

the Application Name