OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidRuntimeManager
Implementsosid.OsidManager
osid.OsidRuntimeProfile
Description

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.

MethodgetManager
Description

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.

Parametersosid.OSIDosidrepresents the OSID
stringimplClassNamethe name of the implementation
osid.installation.Versionversionthe minimum required OSID specification version
Returnosid.OsidManagerthe manager of the service
ErrorsCONFIGURATION_ERRORan error in configuring the implementation
NOT_FOUNDthe implementation class was not found
NULL_ARGUMENT implClassName or version is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED implClassName does not support the requested OSID
CompliancemandatoryThis method must be implemented.
Provider 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.

MethodgetProxyManager
Description

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.

Parametersosid.OSIDosidrepresents the OSID
stringimplementationthe name of the implementation
osid.installation.Versionversionthe minimum required OSID specification version
Returnosid.OsidProxyManagerthe manager of the service
ErrorsCONFIGURATION_ERRORan error in configuring the implementation
NOT_FOUNDthe implementation class was not found
NULL_ARGUMENT implementation or version is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED implementation does not support the requested OSID
CompliancemandatoryThis method must be implemented.
Provider 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.

MethodgetConfiguration
Description

Gets the current configuration in the runtime environment.

Returnosid.configuration.ValueLookupSessiona configuration
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDan authorization failure occured
UNIMPLEMENTEDa configuration service is not supported
ComplianceoptionalThis method must be implemented if supportsConfiguration() is true.