org.osid

Interface OsidRuntimeManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, OsidRuntimeProfile, Sourceable

public interface OsidRuntimeManager
extends OsidManager, OsidRuntimeProfile

The OsidRuntimeManager represents and OSID platform and contains the information required for running OSID implementations such as search paths and configurations.

The OsidRuntimeManager is defined as an interface to provide flexibility for managing an OSID environment. The instantiation of a OsidRuntimeManager implementation is defined by the OSID platform.

The OsidRuntimeManager should be instantiated with a string that identifies the application or environment current at the time of instantiation. This key is used soley for the purpose of seeding the configuration service as a means to enable lower level OSIDs to tune their configuration in response to this key, or, it can be used by the application to retrieve configuration data for itself.

Method Summary

Methods

Modifier and Type	Method and Description
ValueLookupSession	getConfiguration() Gets the current configuration in the runtime environment.
OsidManager	getManager(OSID osid, java.lang.String implClassName, Version version) Finds, loads and instantiates providers of OSID managers.
OsidProxyManager	getProxyManager(OSID osid, java.lang.String implementation, Version version) Finds, loads and instantiates providers of OSID managers.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.OsidRuntimeProfile

supportsConfiguration

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getManager

OsidManager getManager(OSID osid,
                     java.lang.String implClassName,
                     Version version)
                       throws ConfigurationErrorException,
                              NotFoundException,
                              OperationFailedException

Finds, loads and instantiates providers of OSID managers. Providers must conform to an OsidManager interface. The interfaces are defined in the OSID enumeration. For all OSID requests, an instance of OsidManager that implements the OsidManager interface is returned. In bindings where permitted, this can be safely cast into the requested manager.

Parameters:

osid - represents the OSID

implClassName - the name of the implementation

version - the minimum required OSID specification version

Returns:

the manager of the service

Throws:

ConfigurationErrorException - an error in configuring the implementation

NotFoundException - the implementation class was not found

NullArgumentException - implClassName or version is null

OperationFailedException - unable to complete request

UnsupportedException - implClassName does not support the requested OSID

Compliance:

mandatory - This method must be implemented.

Notes:

After - finding and instantiating the requested OsidManager, providers must invoke OsidManager.initialize(OsidRuntimeManager) where the environment is an instance of the current environment that includes the configuration for the service being initialized. The OsidRuntimeManager passed may include information useful for the configuration such as the identity of the service being instantiated.

getProxyManager

OsidProxyManager getProxyManager(OSID osid,
                               java.lang.String implementation,
                               Version version)
                                 throws ConfigurationErrorException,
                                        NotFoundException,
                                        OperationFailedException

Finds, loads and instantiates providers of OSID managers. Providers must conform to an OsidManager interface. The interfaces are defined in the OSID enumeration. For all OSID requests, an instance of OsidManager that implements the OsidManager interface is returned. In bindings where permitted, this can be safely cast into the requested manager.

Parameters:

osid - represents the OSID

implementation - the name of the implementation

version - the minimum required OSID specification version

Returns:

the manager of the service

Throws:

ConfigurationErrorException - an error in configuring the implementation

NotFoundException - the implementation class was not found

NullArgumentException - implementation or version is null

OperationFailedException - unable to complete request

UnsupportedException - implementation does not support the requested OSID

Compliance:

mandatory - This method must be implemented.

Notes:

After - finding and instantiating the requested OsidManager, providers must invoke OsidManager.initialize(OsidRuntimeManager) where the environment is an instance of the current environment that includes the configuration for the service being initialized. The OsidRuntimeManager passed may include information useful for the configuration such as the identity of the service being instantiated.

getConfiguration

ValueLookupSession getConfiguration()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the current configuration in the runtime environment.

Returns:

a configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occured

UnimplementedException - a configuration service is not supported

Compliance:

optional - This method must be implemented if supportsConfiguration() is true.