Package de.aristaflow.adept2.core.orgmodelmanager

Interface OrgModelManager

All Superinterfaces:

ADEPT2Service, ConfigurableService

public interface OrgModelManager
extends ConfigurableService

This is the central interface of the OrgModelManager service with the following sub-components:

• OrgModelInitialiser: Can initialize and adpat the org model during startup.
• PolicyResolution: Can verify and resolve org policies / staff assignment rules.
• OrgPolicyParser: Parses an org policy into objects.
• ModelExplorer: Provides read access to the org model.
• ModelChangeOperations: Provides write access to the org model.
• Authentication: Provides authentication-related methods that are targeted rather at users / agents than administrators.
• GlobalSecurityManager: Handles the security for the system and provides session factories needed for accessing the ADEPT2-API.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_TYPE_ORG_MODEL_EXTENSION	The plug-in type ID for org model extensions, e.
static final String	PLUGIN_TYPE_ORG_MODEL_INITIALISER	The plug-in type ID for org model initialisers.
static final String	PLUGIN_TYPE_ORG_POLICY_SCRIPT_HANDLER	The plug-in type ID for org policy script handlers.
static final String	PLUGIN_TYPE_PASSWORD_STRENGTH_ESTIMATOR	The plug-in type ID for the password strength estimator.

Fields inherited from interface de.aristaflow.adept2.base.service.ConfigurableService

CONF_RUNTIME_CONF_PREFIX

Method Summary

Modifier and Type	Method	Description
ClientAdministration	getClientAdministration()	Returns the client administration interface which allows users to manipulate their own data in a controlled way.
GlobalSecurityManager	getGlobalSecurityManager()	Returns the global security manager which provides access to session factories which in turn provide access to the ADEPT2-API.
ModelChangeOperations	getModelChangeOperations()	Returns an instance of ModelChangeOperations.
ModelExplorer	getModelExplorer()	Returns an instance of ModelExplorer.
Collection<String>	getOrgModelExtensions(SessionToken session)	Gets the names of all org model extensions registered (via corresponding plugins) at this org model manager.
PolicyResolution	getPolicyResolution()	Returns an instance of PolicyResolution.
void	synchroniseModel(SessionToken session)	Manually triggers synchronisation with external organisational models.

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

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

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

getChangeableConfigurationKeys, getConfiguration, getConfigurationValue, setConfigurationValue

Field Details

PLUGIN_TYPE_ORG_MODEL_INITIALISER

static final String PLUGIN_TYPE_ORG_MODEL_INITIALISER

The plug-in type ID for org model initialisers.

See Also:

• Constant Field Values

PLUGIN_TYPE_ORG_POLICY_SCRIPT_HANDLER

static final String PLUGIN_TYPE_ORG_POLICY_SCRIPT_HANDLER

The plug-in type ID for org policy script handlers.

See Also:

• Constant Field Values

PLUGIN_TYPE_ORG_MODEL_EXTENSION

static final String PLUGIN_TYPE_ORG_MODEL_EXTENSION

The plug-in type ID for org model extensions, e. g. LDAP connector.

See Also:

• Constant Field Values

PLUGIN_TYPE_PASSWORD_STRENGTH_ESTIMATOR

static final String PLUGIN_TYPE_PASSWORD_STRENGTH_ESTIMATOR

The plug-in type ID for the password strength estimator.

See Also:

• Constant Field Values

Method Details

getPolicyResolution

PolicyResolution getPolicyResolution()

Returns an instance of PolicyResolution.

Returns:

an instance of PolicyResolution

getModelExplorer

ModelExplorer getModelExplorer()

Returns an instance of ModelExplorer.

Returns:

an instance of ModelExplorer

getModelChangeOperations

ModelChangeOperations getModelChangeOperations()

Returns an instance of ModelChangeOperations.

Returns:

an instance of ModelChangeOperations

getClientAdministration

ClientAdministration getClientAdministration()

Returns the client administration interface which allows users to manipulate their own data in a controlled way. This is a convenient wrapper interface for ModelChangeOperations;

Returns:

The administration interface for simple manipulations of their data in the organisational model by end-users.

getGlobalSecurityManager

GlobalSecurityManager getGlobalSecurityManager()

Returns the global security manager which provides access to session factories which in turn provide access to the ADEPT2-API. One needs to authenticate correctly with an organisational position to retrieve SessionToken.

Returns:

The global security manager providing session factories.

getOrgModelExtensions

Collection<String> getOrgModelExtensions(SessionToken session)

Gets the names of all org model extensions registered (via corresponding plugins) at this org model manager.

Parameters:

session - The session which is used to check for access rights on this method.

Returns:

The names of all org model extensions registered (via corresponding plugins) at this org model manager. This may be the empty collection but never null.

synchroniseModel

void synchroniseModel(SessionToken session)

Manually triggers synchronisation with external organisational models. Synchronisation will occur asynchronously, i.e. this method will return immediately and not block until the synchronisation is finished.

Parameters:

session - The session which is used to check for access rights on this method.