Interface AuthorizationRulesProxyManager

All Superinterfaces:

AuthorizationRulesProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface AuthorizationRulesProxyManager
extends OsidProxyManager, AuthorizationRulesProfile

The authorization rules proxy manager provides access to authorization rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• AuthorizationEnablerLookupSession : a session to retrieve authorization enablers
• AuthorizationEnablerQuerySession : a session to query for authorization enablers
• AuthorizationEnablerSearchSession : a session to search for authorization enablers
• AuthorizationEnablerAdminSession : a session to create and delete authorization enablers
• AuthorizationEnablerNotificationSession : a session to receive notifications pertaining to authorization enabler changes
• AuthorizationEnablerVaultSession : a session to look up authorization enabler vault mappings
• AuthorizationEnablerVaultAssignmentSession : a session to manage authorization enabler to vault mappings
• AuthorizationEnablerSmartVaultSession : a session to manage dynamic vaults of authorization enablers
• AuthorizationEnablerRuleLookupSession : a session to look up authorization enabler to authorization mappings
• AuthorizationEnablerRuleApplicationSession : a session to assign authorization enablers to authorizations

Method Summary

Modifier and Type	Method	Description
AuthorizationEnablerAdminSession	getAuthorizationEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler administration service.
AuthorizationEnablerAdminSession	getAuthorizationEnablerAdminSessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler administration service for the given vault.
AuthorizationEnablerLookupSession	getAuthorizationEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler lookup service.
AuthorizationEnablerLookupSession	getAuthorizationEnablerLookupSessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler lookup service for the given vault.
AuthorizationEnablerNotificationSession	getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the authorization enabler notification service.
AuthorizationEnablerNotificationSession	getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver, Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler notification service for the given vault.
AuthorizationEnablerQuerySession	getAuthorizationEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler query service.
AuthorizationEnablerQuerySession	getAuthorizationEnablerQuerySessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler query service for the given vault.
AuthorizationEnablerRuleApplicationSession	getAuthorizationEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler authorization assignment service.
AuthorizationEnablerRuleApplicationSession	getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler authorization assignment service for the given vault.
AuthorizationEnablerRuleLookupSession	getAuthorizationEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler mapping lookup service for looking up the rules applied to the vault.
AuthorizationEnablerRuleLookupSession	getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enabler authorization mapping lookup service for the given vault.
AuthorizationEnablerSearchSession	getAuthorizationEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the authorization enabler search service.
AuthorizationEnablerSearchSession	getAuthorizationEnablerSearchSessionForVault(Id vaultId, Proxy proxy)	Gets the OsidSession associated with the authorization enablers earch service for the given vault.
AuthorizationEnablerSmartVaultSession	getAuthorizationEnablerSmartVaultSession(Id vaultId, Proxy proxy)	Gets the OsidSession to manage authorization enabler smart vaults.
AuthorizationEnablerVaultAssignmentSession	getAuthorizationEnablerVaultAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning authorization enablers to vaults for authorization.
AuthorizationEnablerVaultSession	getAuthorizationEnablerVaultSession(Proxy proxy)	Gets the OsidSession to lookup authorization enabler/vault mappings for authorization enablers.

Methods inherited from interface AuthorizationRulesProfile

getAuthorizationEnablerRecordTypes, getAuthorizationEnablerSearchRecordTypes, supportsAuthorizationEnablerAdmin, supportsAuthorizationEnablerLookup, supportsAuthorizationEnablerNotification, supportsAuthorizationEnablerQuery, supportsAuthorizationEnablerRecordType, supportsAuthorizationEnablerRuleApplication, supportsAuthorizationEnablerRuleLookup, supportsAuthorizationEnablerSearch, supportsAuthorizationEnablerSearchRecordType, supportsAuthorizationEnablerSmartVault, supportsAuthorizationEnablerVault, supportsAuthorizationEnablerVaultAssignment, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAuthorizationEnablerRecordTypes()	Gets the supported AuthorizationEnabler record types.
TypeList	getAuthorizationEnablerSearchRecordTypes()	Gets the supported AuthorizationEnabler search record types.
boolean	supportsAuthorizationEnablerAdmin()	Tests if an authorization enabler administrative service is supported.
boolean	supportsAuthorizationEnablerLookup()	Tests if looking up authorization enablers is supported.
boolean	supportsAuthorizationEnablerNotification()	Tests if an authorization enabler notification service is supported.
boolean	supportsAuthorizationEnablerQuery()	Tests if querying authorization enablers is supported.
boolean	supportsAuthorizationEnablerRecordType(Type authorizationEnablerRecordType)	Tests if the given AuthorizationEnabler record type is supported.
boolean	supportsAuthorizationEnablerRuleApplication()	Tests if an authorization enabler authorization rule application service is supported.
boolean	supportsAuthorizationEnablerRuleLookup()	Tests if an authorization enabler authorization rule lookup service is supported.
boolean	supportsAuthorizationEnablerSearch()	Tests if searching authorization enablers is supported.
boolean	supportsAuthorizationEnablerSearchRecordType(Type authorizationEnablerSearchRecordType)	Tests if the given AuthorizationEnabler search record type is supported.
boolean	supportsAuthorizationEnablerSmartVault()	Tests if an authorization enabler vault lookup service is supported.
boolean	supportsAuthorizationEnablerVault()	Tests if an authorization enabler vault lookup service is supported.
boolean	supportsAuthorizationEnablerVaultAssignment()	Tests if an authorization enabler vault service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

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.
TypeList	getProxyRecordTypes()	Gets the proxy record Types 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.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

getAuthorizationEnablerLookupSession

AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the authorization enabler lookup service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerLookup() is false

Compliance:

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

getAuthorizationEnablerLookupSessionForVault

AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSessionForVault(Id vaultId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler lookup service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerLookupSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerQuerySession

AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the authorization enabler query service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerQuery() is false

Compliance:

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

getAuthorizationEnablerQuerySessionForVault

AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySessionForVault(Id vaultId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler query service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerQuerySession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerSearchSession

AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the authorization enabler search service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSearch() is false

Compliance:

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

getAuthorizationEnablerSearchSessionForVault

AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSessionForVault(Id vaultId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enablers earch service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerSearchSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerAdminSession

AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the authorization enabler administration service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAdmin() is false

Compliance:

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

getAuthorizationEnablerAdminSessionForVault

AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSessionForVault(Id vaultId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler administration service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerAdminSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerNotificationSession

AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver,
 Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with the authorization enabler notification service.

Parameters:

authorizationEnablerReceiver - the notification callback

proxy - a proxy

Returns:

an AuthorizationEnablerNotificationSession

Throws:

NullArgumentException - authorizationEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerNotification() is false

Compliance:

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

getAuthorizationEnablerNotificationSessionForVault

AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver,
 Id vaultId,
 Proxy proxy)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler notification service for the given vault.

Parameters:

authorizationEnablerReceiver - the notification callback

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerNotificationSession

Throws:

NotFoundException - no vault found by the given Id

NullArgumentException - authorizationEnablerReceiver, vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerVaultSession

AuthorizationEnablerVaultSession getAuthorizationEnablerVaultSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession to lookup authorization enabler/vault mappings for authorization enablers.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerVaultSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerVault() is false

Compliance:

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

getAuthorizationEnablerVaultAssignmentSession

AuthorizationEnablerVaultAssignmentSession getAuthorizationEnablerVaultAssignmentSession(Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning authorization enablers to vaults for authorization.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerVaultAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerVaultAssignment() is false

Compliance:

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

getAuthorizationEnablerSmartVaultSession

AuthorizationEnablerSmartVaultSession getAuthorizationEnablerSmartVaultSession(Id vaultId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage authorization enabler smart vaults.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerSmartVaultSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerSmartVault() is false

Compliance:

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

getAuthorizationEnablerRuleLookupSession

AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the authorization enabler mapping lookup service for looking up the rules applied to the vault.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerAuthorizationRuleLookup() is false

Compliance:

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

getAuthorizationEnablerRuleLookupSessionForVault

AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId,
 Proxy proxy)
                                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler authorization mapping lookup service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerRuleLookupSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getAuthorizationEnablerRuleApplicationSession

AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSession(Proxy proxy)
                                                                                  throws OperationFailedException

Gets the OsidSession associated with the authorization enabler authorization assignment service.

Parameters:

proxy - a proxy

Returns:

an AuthorizationEnablernRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleApplication() is false

Compliance:

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

getAuthorizationEnablerRuleApplicationSessionForVault

AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId,
 Proxy proxy)
                                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the authorization enabler authorization assignment service for the given vault.

Parameters:

vaultId - the Id of the Vault

proxy - a proxy

Returns:

an AuthorizationEnablerRuleApplicationSession

Throws:

NotFoundException - no Vault found by the given Id

NullArgumentException - vaultId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthorizationEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAuthorizationEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .