Interface OrgModelManager
-
- All Superinterfaces:
ADEPT2Service
public interface OrgModelManager extends ADEPT2Service
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.
- Author:
- Patrick Schmidt, Ulrich Kreher
-
-
Field Summary
Fields Modifier and Type Field Description static String
PLUGIN_TYPE_ORG_MODEL_EXTENSION
The plug-in type ID for org model extensions, e. g.static String
PLUGIN_TYPE_ORG_MODEL_INITIALISER
The plug-in type ID for org model initialisers.static String
PLUGIN_TYPE_ORG_POLICY_SCRIPT_HANDLER
The plug-in type ID for org policy script handlers.
-
Method Summary
All Methods Instance Methods Abstract Methods 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 ofModelChangeOperations
.ModelExplorer
getModelExplorer()
Returns an instance ofModelExplorer
.PolicyResolution
getPolicyResolution()
Returns an instance ofPolicyResolution
.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
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
getPolicyResolution
PolicyResolution getPolicyResolution()
Returns an instance ofPolicyResolution
.- Returns:
- an instance of
PolicyResolution
-
getModelExplorer
ModelExplorer getModelExplorer()
Returns an instance ofModelExplorer
.- Returns:
- an instance of
ModelExplorer
-
getModelChangeOperations
ModelChangeOperations getModelChangeOperations()
Returns an instance ofModelChangeOperations
.- 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 forModelChangeOperations
;- 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 retrieveSessionToken
.- Returns:
- The global security manager providing session factories.
-
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.
-
-