Interface ProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ProxyProfile, Sourceable

public interface ProxyManager
extends OsidManager, ProxyProfile

The proxy manager provides access to proxy sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ProxySession : a session to acquire proxy interfaces

Method Summary

Modifier and Type	Method	Description
ProxySession	getProxySession()	Gets a ProxySession which is responsible for acquiring authentication credentials on behalf of a service client.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
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.
LocaleList	getLocales()	Gets the locales supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
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 specification version.

Methods inherited from interface ProxyProfile

getProxyConditionRecordTypes, getProxyRecordTypes, supportsProxy, supportsProxyConditionRecordType, supportsProxyRecordType

Modifier and Type	Method	Description
TypeList	getProxyConditionRecordTypes()	Gets the supported ProxyCondition record interface types.
TypeList	getProxyRecordTypes()	Gets the supported Proxy record interface types.
boolean	supportsProxy()	Tests if a proxy session is supported.
boolean	supportsProxyConditionRecordType(Type proxyConditionRecordType)	Tests if the given ProxyCondition record interface type is supported.
boolean	supportsProxyRecordType(Type proxyRecordType)	Tests if the given Proxy record interface type is supported.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getProxySession

ProxySession getProxySession()
                      throws OperationFailedException

Gets a ProxySession which is responsible for acquiring authentication credentials on behalf of a service client.

Returns:

a proxy session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProxy() is false

Compliance:

optional - This method must be implemented if {@code supportsProxy()} is {@code true} .