Class AbstractSubOsidManager

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractSubOsidManager

All Implemented Interfaces:

Closeable, AutoCloseable, OsidManager, OsidProxyManager, OsidManager, OsidProfile, OsidProxyManager, Sourceable

public abstract class AbstractSubOsidManager
extends Object
implements OsidManager, OsidProxyManager

This is an alternative OsidManager class for use as a sub-manager to a top level OsidManager which does not need its own configuration and identity.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSubOsidManager(AbstractOsidManager parent)	Constructs a new AbstractSubOsidManager.

Method Summary

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	close()	Closes this manager.
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids, such as an image or logo, expressed using the Asset interface.
protected Value	getConfigurationValue(Id parameterId)	Gets a Value for the given parameter Id.
protected ValueList	getConfigurationValues(Id parameterId)	Gets all the Values for the given parameter Id.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
DisplayText	getLicense()	Gets the terms of usage with respect to this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
protected OsidManager	getOsidManager(OSID osid, String implClassName)	Instantiates an OsidManager.
protected OsidProxyManager	getOsidProxyManager(OSID osid, String implClassName)	Instantiates an OsidProxyManager.
Resource	getProvider()	Gets the provider of this service, expressed using the Resource interface.
Id	getProviderId()	Gets the Resource Id representing the provider of this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
protected OsidRuntimeManager	getRuntime()	Gets the runtime environment.
Version	getVersion()	Gets the version of this service implementation.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID version.

Methods inherited from class Object

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

Methods inherited from interface OsidProxyManager

getProxy, getProxyCondition

Constructor Details

AbstractSubOsidManager

protected AbstractSubOsidManager(AbstractOsidManager parent)

Constructs a new AbstractSubOsidManager.

Parameters:

parent - the main OsidManager

Throws:

NullArgumentException - parent is null

Method Details

initialize

@OSID
public void initialize(OsidRuntimeManager runtime)
                throws ConfigurationErrorException,
OperationFailedException

Initializes this manager. A manager is initialized once at the time of creation.

Specified by:

initialize in interface OsidManager

Specified by:

initialize in interface OsidProxyManager

Parameters:

runtime - the runtime environment

Throws:

ConfigurationErrorException - an error with implementation configuration

IllegalStateException - this manager has already been initialized by the OsidLoader

NullArgumentException - runtime is null

OperationFailedException - unable to complete request

getRuntime

protected OsidRuntimeManager getRuntime()

Gets the runtime environment.

Returns:

the runtime

getId

@OSID
public Id getId()

Gets an identifier for this service implementation. The identifier is unique among services but multiple instantiations of the same service use the same Id. This identifier is the same identifier used in managing OSID installations.

Specified by:

getId in interface OsidProfile

Returns:

the Id

Throws:

IllegalStateException - This manager has been closed.

getDisplayName

@OSID
public DisplayText getDisplayName()

Gets a display name for this service implementation.

Specified by:

getDisplayName in interface OsidProfile

Returns:

a display name

Throws:

IllegalStateException - This manager has been closed.

getDescription

@OSID
public DisplayText getDescription()

Gets a description of this service implementation.

Specified by:

getDescription in interface OsidProfile

Returns:

a description

Throws:

IllegalStateException - This manager has been closed.

getVersion

@OSID
public Version getVersion()

Gets the version of this service implementation.

Specified by:

getVersion in interface OsidProfile

Returns:

the version

Throws:

IllegalStateException - This manager has been closed.

getReleaseDate

@OSID
public DateTime getReleaseDate()

Gets the date this service implementation was released.

Specified by:

getReleaseDate in interface OsidProfile

Returns:

the release date

Throws:

IllegalStateException - This manager has been closed.

supportsOSIDVersion

@OSID
public boolean supportsOSIDVersion(Version version)

Test for support of an OSID version.

Specified by:

supportsOSIDVersion in interface OsidProfile

Parameters:

version - the version string to test

Returns:

true if this manager supports the given version, false otherwise

getLocales

@OSID
public LocaleList getLocales()

Gets the locales supported in this service.

Specified by:

getLocales in interface OsidProfile

Returns:

list of locales supported

supportsJournalRollback

public boolean supportsJournalRollback()

Test for support of a journaling rollback service.

Specified by:

supportsJournalRollback in interface OsidProfile

Returns:

true if this manager supports the journal rollback, false otherwise

supportsJournalBranching

@OSID
public boolean supportsJournalBranching()

Test for support of a journal branching service.

Specified by:

supportsJournalBranching in interface OsidProfile

Returns:

true if this manager supports the journal branching, false otherwise

getBranchId

@OSID
public Id getBranchId()

Gets the Branch Id representing this service branch.

Specified by:

getBranchId in interface OsidProfile

Returns:

the branch Id

Throws:

UnimplementedException - supportsJournalBranching() is false

getBranch

@OSID
public Branch getBranch()
                 throws OperationFailedException

Gets this service branch.

Specified by:

getBranch in interface OsidProfile

Returns:

the service branch

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalBranching() is false

rollbackService

@OSID
public JournalEntry rollbackService(Date rollbackTime)
                             throws OperationFailedException,
PermissionDeniedException

Rolls back this service to a point in time.

Specified by:

rollbackService in interface OsidManager

Parameters:

rollbackTime - the requested time

Returns:

the journal entry corresponding to the actual state of this service

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnimplementedException - supportsJournalRollback() is false

rollbackService

@OSID
public JournalEntry rollbackService(Date rollbackTime,
 Proxy proxy)
                             throws OperationFailedException

Rolls back this service to a point in time.

Specified by:

rollbackService in interface OsidProxyManager

Parameters:

rollbackTime - the requested time

proxy - a proxy

Returns:

the journal entry corresponding to the actual state of this service

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalRollback() is false

changeBranch

@OSID
public void changeBranch(Id branchId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Changes the service branch.

Specified by:

changeBranch in interface OsidManager

Parameters:

branchId - the new service branch

Throws:

NotFoundException - branchId not found

NullArgumentException - branchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnimplementedException - supportsJournalBranching() is false

changeBranch

@OSID
public void changeBranch(Id branchId,
 Proxy proxy)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Changes the service branch.

Specified by:

changeBranch in interface OsidProxyManager

Parameters:

branchId - the new service branch

proxy - a proxy

Throws:

NotFoundException - branchId not found

NullArgumentException - branchId or proxy is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnimplementedException - supportsJournalBranching() is false

getLicense

@OSID
public DisplayText getLicense()

Gets the terms of usage with respect to this service implementation.

Specified by:

getLicense in interface Sourceable

Returns:

the license

Throws:

IllegalStateException - This manager has been closed.

getProviderId

@OSID
public Id getProviderId()

Gets the Resource Id representing the provider of this service.

Specified by:

getProviderId in interface Sourceable

Returns:

the provider Id

Throws:

IllegalStateException - This manager has been closed.

getProvider

@OSID
public Resource getProvider()
                     throws OperationFailedException

Gets the provider of this service, expressed using the Resource interface.

Specified by:

getProvider in interface Sourceable

Returns:

the service provider resource

Throws:

IllegalStateException - This manager has been closed.

OperationFailedException - unable to complete request

getBrandingIds

@OSID
public IdList getBrandingIds()

Gets the branding asset Ids, such as an image or logo, expressed using the Asset interface.

Specified by:

getBrandingIds in interface Sourceable

Returns:

a list of asset Ids

getBranding

@OSID
public AssetList getBranding()
                      throws OperationFailedException

Gets a branding, such as an image or logo, expressed using the Asset interface.

Specified by:

getBranding in interface Sourceable

Returns:

a list of assets

Throws:

IllegalStateException - This manager has been closed.

OperationFailedException - unable to complete request

getOsidManager

protected OsidManager getOsidManager(OSID osid,
 String implClassName)
                              throws ConfigurationErrorException,
OperationFailedException

Instantiates an OsidManager.

Parameters:

osid - the OSID to load

implClassName - the name of the implementation

Returns:

the OsidManager

Throws:

ConfigurationErrorException - an error in configuring the implementation

IllegalStateException - manager not initialized

OperationFailedException - unable to complete request

NullArgumentException - implClassName or version is null

OperationFailedException - unable to complete

UnsupportedException - implClassName does not support the requested OSID

getOsidProxyManager

protected OsidProxyManager getOsidProxyManager(OSID osid,
 String implClassName)
                                        throws ConfigurationErrorException,
OperationFailedException

Instantiates an OsidProxyManager.

Parameters:

osid - the OSID to load

implClassName - the name of the implementation

Returns:

the OsidManager

Throws:

ConfigurationErrorException - an error in configuring the implementation

IllegalStateException - manager not initialized

OperationFailedException - unable to complete request

NullArgumentException - implClassName or version is null

OperationFailedException - unable to complete

UnsupportedException - implClassName does not support the requested OSID

getConfigurationValue

protected Value getConfigurationValue(Id parameterId)
                               throws ConfigurationErrorException,
OperationFailedException

Gets a Value for the given parameter Id. If more than one value exists for the given parameter, the most preferred value is returned. This method can be used as a convenience when only one value is expected. getApplicableValuesByParameters() should be used for getting all the active values.

Parameters:

parameterId - the Id of the Parameter to retrieve

Returns:

the value

Throws:

ConfigurationErrorException - the parameterId not found or no value available

IllegalStateException - manager not initialized

NullArgumentException - the parameterId is null

OperationFailedException - unable to complete request

getConfigurationValues

protected ValueList getConfigurationValues(Id parameterId)
                                    throws ConfigurationErrorException,
OperationFailedException

Gets all the Values for the given parameter Id.

Parameters:

parameterId - the Id of the Parameter to retrieve

Returns:

the value list

Throws:

ConfigurationErrorException - the parameterId not found

IllegalStateException - manager not initialized

NullArgumentException - the parameterId is null

OperationFailedException - unable to complete request

close

@OSIDBinding
public void close()

Closes this manager.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface OsidManager

Specified by:

close in interface OsidProxyManager

Throws:

IllegalStateException - this manager has been closed