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 Modifier and Type | Method and 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. |
changeBranch, initialize, rollbackService
close
getAuthorizationEnablerRecordTypes, getAuthorizationEnablerSearchRecordTypes, supportsAuthorizationEnablerAdmin, supportsAuthorizationEnablerLookup, supportsAuthorizationEnablerNotification, supportsAuthorizationEnablerQuery, supportsAuthorizationEnablerRecordType, supportsAuthorizationEnablerRuleApplication, supportsAuthorizationEnablerRuleLookup, supportsAuthorizationEnablerSearch, supportsAuthorizationEnablerSearchRecordType, supportsAuthorizationEnablerSmartVault, supportsAuthorizationEnablerVault, supportsAuthorizationEnablerVaultAssignment, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler lookup service.proxy
- a proxy AuthorizationEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerLookup()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerLookup()
is
true.
AuthorizationEnablerLookupSession getAuthorizationEnablerLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler lookup service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerLookupSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerLookup()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler query service.proxy
- a proxy AuthorizationEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerQuery()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerQuery()
is
true.
AuthorizationEnablerQuerySession getAuthorizationEnablerQuerySessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler query service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerQuerySession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerQuery()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler search service.proxy
- a proxy AuthorizationEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSearch()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerSearch()
is
true.
AuthorizationEnablerSearchSession getAuthorizationEnablerSearchSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enablers earch service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerSearchSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerSearch()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler administration service.proxy
- a proxy AuthorizationEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerAdmin()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerAdmin()
is
true.
AuthorizationEnablerAdminSession getAuthorizationEnablerAdminSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler administration service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerAdminSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerAdmin()
and
supportsVisibleFederation()
are true.
AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSession(AuthorizationEnablerReceiver authorizationEnablerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler notification service.authorizationEnablerReceiver
- the notification callbackproxy
- a proxy AuthorizationEnablerNotificationSession
NullArgumentException
-
authorizationEnablerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerNotification()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerNotification()
is
true.
AuthorizationEnablerNotificationSession getAuthorizationEnablerNotificationSessionForVault(AuthorizationEnablerReceiver authorizationEnablerReceiver, Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler notification service for the given vault.authorizationEnablerReceiver
- the notification callbackvaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerNotificationSession
NotFoundException
- no vault found by the given
Id
NullArgumentException
-
authorizationEnablerReceiver, vaultId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerNotification()
and
supportsVisibleFederation()
are
true.
AuthorizationEnablerVaultSession getAuthorizationEnablerVaultSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup authorization
enabler/vault mappings for authorization enablers.proxy
- a proxy AuthorizationEnablerVaultSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerVault()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerVault()
is
true.
AuthorizationEnablerVaultAssignmentSession getAuthorizationEnablerVaultAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
authorization enablers to vaults for authorization.proxy
- a proxy AuthorizationEnablerVaultAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerVaultAssignment()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerVaultAssignment()
is
true.
AuthorizationEnablerSmartVaultSession getAuthorizationEnablerSmartVaultSession(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage authorization enabler
smart vaults.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerSmartVaultSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerSmartVault()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerSmartVault()
is
true.
AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler mapping lookup service for looking up the rules applied to the
vault.proxy
- a proxy AuthorizationEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerAuthorizationRuleLookup()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleLookup()
is
true.
AuthorizationEnablerRuleLookupSession getAuthorizationEnablerRuleLookupSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler authorization mapping lookup service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerRuleLookupSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleLookup()
and
supportsVisibleFederation()
are
true.
AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the authorization
enabler authorization assignment service.proxy
- a proxy AuthorizationEnablernRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleApplication()
is
true.
AuthorizationEnablerRuleApplicationSession getAuthorizationEnablerRuleApplicationSessionForVault(Id vaultId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the authorization
enabler authorization assignment service for the given vault.vaultId
- the Id
of the Vault
proxy
- a proxy AuthorizationEnablerRuleApplicationSession
NotFoundException
- no Vault
found by
the given Id
NullArgumentException
- vaultId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthorizationEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAuthorizationEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.