de.aristaflow.adept2.model

Class ModelFactoryRegistry

java.lang.Object

de.aristaflow.adept2.base.service.AbstractADEPT2Service

de.aristaflow.adept2.base.service.AbstractAuthenticatedService

de.aristaflow.adept2.base.registry.AbstractRegistry

de.aristaflow.adept2.base.registry.PluginRegistry

de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry

de.aristaflow.adept2.model.ModelFactoryRegistry

All Implemented Interfaces:

ConfMgrRegistry, ADEPT2Service, AuthenticatingService, LogService, NameResolution, ServiceThreadHandling, ModelViewerProvider

@ConfigurationDescription(properties={@Property(name="Components.ProcessModelFactory",isRequired=true,description="the process model factory"),,,,,,,,,})
public final class ModelFactoryRegistry
extends InstanceToInstanceRegistry
implements ModelViewerProvider

This class extends the InstanceToInstanceRegistry to support all model factories in ADEPT2. These factories are used to encapsulate the users of data models (defined via interfaces) from the underlying implementations.

This class parses the following properties from the registry configuration (when checking instance declarations):

• Components.<ComponentType>
• PluginData.Instances
• <InstanceName>.Implementation

Author:

Kevin Goeser, Ulrich Kreher

Nested Class Summary

Nested classes/interfaces inherited from class de.aristaflow.adept2.base.registry.PluginRegistry

PluginRegistry.ConfigurationValidator, PluginRegistry.URLClassloaderPrivilegedAction

Nested classes/interfaces inherited from class de.aristaflow.adept2.base.registry.AbstractRegistry

AbstractRegistry.DefaultNameResolution, AbstractRegistry.InstanceInformation, AbstractRegistry.InstantiationMode

Nested classes/interfaces inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

AbstractADEPT2Service.ActiveSessions

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Class<?>>	declaredModelViewers The model viewer class objects for the plug-in data (ID -> class).

Fields inherited from class de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry

usedInstances

Fields inherited from class de.aristaflow.adept2.base.registry.PluginRegistry

declaredPluginTypes, defaultInstances, dynamicPlugins, pluginInstances, runtimePlugins, runtimePluginTypeCLs, singletonPlugins

Fields inherited from class de.aristaflow.adept2.base.registry.AbstractRegistry

componentInterfaces, configurationManager, declaredInstances, INIT_INSTANTIATED_OBJECT_METHOD, nameResolution, singletonInstances

Fields inherited from class de.aristaflow.adept2.base.service.AbstractAuthenticatedService

CFG_EARLY_SERVICEAUTH_ORGPOSID, CFG_EARLY_SERVICEAUTH_ORGPOSNAME, CFG_EARLY_SERVICEAUTH_PASSWORD, CFG_EARLY_SERVICEAUTH_USERNAME, CFG_SERVICEAUTH_ORGPOSID, CFG_SERVICEAUTH_ORGPOSNAME, CFG_SERVICEAUTH_PASSWORD, CFG_SERVICEAUTH_USERNAME

Fields inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

CONF_CSV_LOGGING, configuration, logger, registry, runtimeRequiredServices, startupRequiredServices

Constructor Summary

Constructors

Constructor and Description
ModelFactoryRegistry(UrlConfigurationManager confMgr, Configuration configuration, Registry registry) Constructs a new model factory registry supporting factory for the creation of model implementations.

Method Summary

Modifier and Type	Method and Description
protected void	authenticateService() The ModelFactoryRegistry does not need an authentication, therefore this implementation is empty.
ActivityModelFactory	getActivityModelFactory(java.lang.String instanceName) Gets the instance of the activity model factory configured for the designated component instance.
ExecutionFactory	getExecutionFactory(java.lang.String instanceName) Gets the designated instance of the execution factory configured for the designated component instance.
SystemDataFormatterFactory	getFormatterFactory(java.lang.String instanceName) Gets the designated instance of the system data formatter configured for the designated component instance.
GraphicalModelFactory	getGraphicalModelFactory(java.lang.String instanceName) Gets the designated instance of the graphical model factory configured for the designated component instance.
InitTabFactory	getInitTabFactory(java.lang.String instanceName) Gets the designated instance of the init tab model factory configured for the designated component instance.
LocalisationFactory	getLocalisationFactory(java.lang.String instanceName) Gets the designated instance of the localisation factory configured for the designated component instance.
static ModelFactoryRegistry	getModelFactoryRegistry() Deprecated.
FilterFactory	getModelFilterFactory(java.lang.String instanceName) Gets the instance of the filter factory configured for the designated component instance.
java.lang.Class<?>	getModelViewerClass(java.lang.String pluginID) Gets the model viewer class for the designated plugin ID.
ProcessModelFactory	getProcessModelFactory(java.lang.String instanceName) Gets the instance of the process model factory configured for the designated component instance.
WorklistModelFactory	getWorklistModelFactory(java.lang.String instanceName) Gets the instance of the worklist model factory configured for the designated component instance.
protected void	readDeclaredModelViewerClasses(Configuration conf) Reads all declared model viewer classes from the configuration and loads the classes.
protected void	renewConfiguration(Configuration conf) Renews the configuration of this registry by renewing via the superclass and reading the declared model viewer classes for plugin data.
void	shutdown(boolean emergency) Signals the shutdown of this registry.

Methods inherited from class de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry

getUsedComponentInstanceNameForInstance, getUsedObjectForInstance

Methods inherited from class de.aristaflow.adept2.base.registry.PluginRegistry

createPluginLoader, getConfiguredPlugin, getConfiguredPlugin, getConfiguredPlugin, getConfiguredPlugins, prepareRuntimePlugin, readMetaConfiguration

Methods inherited from class de.aristaflow.adept2.base.registry.AbstractRegistry

checkAndStoreProvidedObject, checkConfiguration, checkImplementingClass, checkSupertype, createInstanceForInterface, getAppropriateMethod, getArbitrarilyNamedObject, getComponentType, getFormattedSignature, getHierarchicalInstanceName, getInstanceInformation, getInstantiationMode, getInterfaceForComponentType, getObjectForInstanceName, getObjectForInstanceName, getObjectForInstanceName, getSimpleInstanceName, init, initialiseInstantiatedObject, readMetaConfiguration

Methods inherited from class de.aristaflow.adept2.base.service.AbstractAuthenticatedService

_sessionActive, awaitActiveSessions, createChildSession, createSession, getAgent, getSecurityManager, getSessionFactory, getStartupRequired, getTopLevelAgent, getUserCredentials, globalSecurityManagerAvailable, isEarlyService, sessionHasCapability

Methods inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

_sessionFinished, activeOrInvalidServiceStateException, changeLogContext, changeLogContext, changeLogContext, consoleLog, csvLoggingEnabled, getClassSpecificJulLogger, getDependencyRegistry, getLocalUris, getLogger, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, isActive, isSessionActive, isShutdown, logMethodEntry, logMethodEntry, logMethodEntry, logMethodExit, logMethodExit, ping, preShutdown, privilegeSession, privilegeThread, revertLogContextChanges, sessionActive, sessionActive, sessionActive, sessionActive, sessionFinished, sessionFinished, signalShutdown, signalStart, start, unprivilegeThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, ping, preShutdown, start

Field Detail

declaredModelViewers

protected final java.util.Map<java.lang.String,java.lang.Class<?>> declaredModelViewers

The model viewer class objects for the plug-in data (ID -> class). Model viewer allow to extend normal model elements ( PluginDataContainer) by additional data and provide type-safe access. This way they build a special view on the model elements and their additional plugin data.

Constructor Detail

ModelFactoryRegistry

public ModelFactoryRegistry(UrlConfigurationManager confMgr,
                            Configuration configuration,
                            Registry registry)
                     throws ConfigurationException

Constructs a new model factory registry supporting factory for the creation of model implementations. It calls the constructor of InstanceToInstanceRegistry.

Parameters:

confMgr - The initial configuration manager that provides configurations for the loaded component instances.

configuration - The configuration of the registry.

registry - The parent registry of this registry.

Throws:

ConfigurationException - If the password cannot be parsed from the configuration, a ConfigurationException will be thrown.

Method Detail

authenticateService

protected void authenticateService()

The ModelFactoryRegistry does not need an authentication, therefore this implementation is empty.

Overrides:

authenticateService in class AbstractAuthenticatedService

renewConfiguration

protected void renewConfiguration(Configuration conf)
                           throws ConfigurationException

Renews the configuration of this registry by renewing via the superclass and reading the declared model viewer classes for plugin data.

Overrides:

renewConfiguration in class InstanceToInstanceRegistry

Parameters:

conf - The (new) root configuration for this registry.

Throws:

ConfigurationException - If a model viewer class is declared but it is not found by this registry, a ConfigurationException will be thrown.

readDeclaredModelViewerClasses

protected void readDeclaredModelViewerClasses(Configuration conf)
                                       throws ConfigurationException

Reads all declared model viewer classes from the configuration and loads the classes.

Parameters:

conf - The (new) root configuration for this registry containing the declared model viewer classes.

Throws:

ConfigurationException - If a model viewer class is declared but it is not found by this registry, a ConfigurationException will be thrown.

getProcessModelFactory

public ProcessModelFactory getProcessModelFactory(java.lang.String instanceName)
                                           throws ServiceNotKnownException

Gets the instance of the process model factory configured for the designated component instance.

Parameters:

instanceName - The name of the component instance requesting the process model factory. Use the empty string if the instance name is not defined.

Returns:

The instance of a process model factory configured for the requesting component instance or the anonymous instance of the process model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the process model factory,
• the instantiation mode of the process model factory is set to off,
• the creation of the process model factory instance fails,
• the used instance of the process model factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getActivityModelFactory

public ActivityModelFactory getActivityModelFactory(java.lang.String instanceName)
                                             throws ServiceNotKnownException

Gets the instance of the activity model factory configured for the designated component instance.

Parameters:

instanceName - The name of the component instance requesting the activity model factory. Use the empty string if the instance name is not defined.

Returns:

The instance of an activity model factory configured for the requesting component instance or the anonymous instance of the activity model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the activity model factory,
• the instantiation mode of the activity model factory is set to off,
• the creation of the activity model factory instance fails,
• the used instance of the activity model factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getWorklistModelFactory

public WorklistModelFactory getWorklistModelFactory(java.lang.String instanceName)
                                             throws ServiceNotKnownException

Gets the instance of the worklist model factory configured for the designated component instance.

Parameters:

instanceName - The name of the component instance requesting the worklist model factory. Use the empty string if the instance name is not defined.

Returns:

The instance of a worklist model factory configured for the requesting component instance or the anonymous instance of the worklist model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the worklist model factory,
• the instantiation mode of the worklist model factory is set to off,
• the creation of the worklist model factory instance fails,
• the used instance of the worklist model factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getModelFilterFactory

public FilterFactory getModelFilterFactory(java.lang.String instanceName)
                                    throws ServiceNotKnownException

Gets the instance of the filter factory configured for the designated component instance.

Parameters:

instanceName - The name of the component instance requesting the filter factory. Use the empty string if the instance name is not defined.

Returns:

The instance of a filter factory configured for the requesting component instance or the anonymous instance of the activity model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the filter factory,
• the instantiation mode of the filter factory is set to off,
• the creation of the filter factory instance fails,
• the used instance of the filter factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getExecutionFactory

public ExecutionFactory getExecutionFactory(java.lang.String instanceName)
                                     throws ServiceNotKnownException

Gets the designated instance of the execution factory configured for the designated component instance.

Parameters:

instanceName - The name of the component instance requesting the execution factory. Use the empty string if the instance name is not defined.

Returns:

The instance of an execution factory configured for the requesting component instance or the anonymous instance of the activity model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the execution factory,
• the instantiation mode of the execution factory is set to off,
• the creation of the execution factory instance fails,
• the used instance of the execution factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getGraphicalModelFactory

public GraphicalModelFactory getGraphicalModelFactory(java.lang.String instanceName)
                                               throws ServiceNotKnownException

Gets the designated instance of the graphical model factory configured for the designated component instance.

Parameters:

instanceName - The name of the graphical model factory instance. Use the component type if the instance name is not defined.

Returns:

The designated instance of the graphical model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the graphical model factory,
• the instantiation mode of the graphical model factory is set to off,
• the creation of the graphical model factory instance fails,
• the used instance of the graphical model factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getInitTabFactory

public InitTabFactory getInitTabFactory(java.lang.String instanceName)
                                 throws ServiceNotKnownException

Gets the designated instance of the init tab model factory configured for the designated component instance.

Parameters:

instanceName - The name of the init tab model factory instance. Use the component type if the instance name is not defined.

Returns:

The designated instance of the init tab model factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the init tab model factory,
• the instantiation mode of the init tab factory is set to off,
• the creation of the init tab factory instance fails,
• the used instance of the init tab factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getLocalisationFactory

public LocalisationFactory getLocalisationFactory(java.lang.String instanceName)
                                           throws ServiceNotKnownException

Gets the designated instance of the localisation factory configured for the designated component instance.

Parameters:

instanceName - The name of the localisation factory instance. Use the component type if the instance name is not defined.

Returns:

The designated instance of the localisation factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the localisation factory,
• the instantiation mode of the localisation factory is set to off,
• the creation of the localisation factory instance fails,
• the used instance of the localisation factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getFormatterFactory

public SystemDataFormatterFactory getFormatterFactory(java.lang.String instanceName)
                                               throws ServiceNotKnownException

Gets the designated instance of the system data formatter configured for the designated component instance.

Parameters:

instanceName - The name of the system data formatter factory instance. Use the component type if the instance name is not defined.

Returns:

The designated instance of the system data formatter factory.

Throws:

ServiceNotKnownException - If

• no component interface is registered/configured for the system data formatter factory,
• the instantiation mode of the system data formatter factory is set to off,
• the creation of the system data formatter factory instance fails,
• the used instance of the system data formatter factory is not declared properly,
• the configuration of the used instance does not provide required configuration values,

a ServiceNotKnownException will be thrown.

getModelViewerClass

public java.lang.Class<?> getModelViewerClass(java.lang.String pluginID)

Gets the model viewer class for the designated plugin ID. If the plugin ID is not known, null will be returned.

Specified by:

getModelViewerClass in interface ModelViewerProvider

Parameters:

pluginID - The ID of the plugin to retrieve a model viewer class for. This provides type-safe access to the data of the plugin which is stored by a PluginDataContainer.

Returns:

The model viewer class for the designated plugin or null in case the plugin ID is not known.

getModelFactoryRegistry

@Deprecated
public static ModelFactoryRegistry getModelFactoryRegistry()
                                                                throws ServiceNotKnownException

Deprecated.

Throws:

ServiceNotKnownException

shutdown

public void shutdown(boolean emergency)

Description copied from class: AbstractRegistry

Signals the shutdown of this registry. No access except the privileged threads may access this registry afterwards.

This method has to be called at an arbitrary time in the shutdown-procedure of overriding classes.

Specified by:

shutdown in interface ADEPT2Service

Overrides:

shutdown in class AbstractRegistry

Parameters:

emergency - Whether the shutdown will be an emergency shutdown.