public interface AuthenticationKeysProxyManager extends OsidProxyManager, AuthenticationKeysProfile
The authentication proxy manager provides access to authentication
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager support the passing of a Proxy
object. The sessions included in this manager are:
KeyLookupSession:
a session to access the keys of
Agents
KeyQuerySession:
a session to query keys
KeySearchSession
: a session to search for keys
KeyAdminSession:
a session to update the keys of
Agents
KeyNotificationSession:
a session to receive
messages pertaining to Key
changes KeyAgencySession:
a session to retrieve Key
to Agency
mappings KeyAgencyAssignmentSession:
a session to manage
Key
to Agency
mappings KeySmartAgencySession:
a session to create dynamic
agencies of keys Modifier and Type | Method and Description |
---|---|
KeyAdminSession |
getKeyAdminSession(Proxy proxy)
Gets the
OsidSession associated with the key
administration service. |
KeyAdminSession |
getKeyAdminSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the key admin
service for the given agency. |
KeyAgencyAssignmentSession |
getKeyAgencyAssignmentSession(Proxy proxy)
Gets the session for assigning key to agency mappings.
|
KeyAgencySession |
getKeyAgencySession(Proxy proxy)
Gets the session for retrieving key to agency mappings.
|
KeyLookupSession |
getKeyLookupSession(Proxy proxy)
Gets the
OsidSession associated with the key lookup
service. |
KeyLookupSession |
getKeyLookupSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the key lookup
service for the given agency. |
KeyNotificationSession |
getKeyNotificationSession(KeyReceiver keyReceiver,
Proxy proxy)
Gets the messaging receiver session for notifications pertaining to
key changes.
|
KeyNotificationSession |
getKeyNotificationSessionForAgency(KeyReceiver keyReceiver,
Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the key
notification service for the given agency. |
KeySearchSession |
getKeySearchSession(Proxy proxy)
Gets the
OsidSession associated with the key search
service. |
KeySearchSession |
getKeySearchSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the key search
service for the given agency. |
KeySmartAgencySession |
getKeySmartAgencySession(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the key smart
agency service for the given agency. |
changeBranch, initialize, rollbackService
close
getKeyRecordTypes, getKeySearchRecordTypes, supportsKeyAdmin, supportsKeyAgency, supportsKeyAgencyAssignment, supportsKeyLookup, supportsKeyNotification, supportsKeyRecordType, supportsKeySearch, supportsKeySearchRecordType, supportsKeySmartAgency, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
KeyLookupSession getKeyLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the key lookup
service.proxy
- a proxy KeyLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyLookup()
is false
optional
- This method must be implemented if
supportsKeyLookup()
is true.
KeyLookupSession getKeyLookupSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the key lookup
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy a KeyLookupSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsKeyLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsKeyLookup()
and
supportsVisibleFederation()
are true.
KeySearchSession getKeySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the key search
service.proxy
- a proxy KeySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeySearch()
is false
optional
- This method must be implemented if
supportsKeySearch()
is true.
KeySearchSession getKeySearchSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the key search
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy a KeySearchSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsKeySearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsKeySearch()
and
supportsVisibleFederation()
are true.
KeyAdminSession getKeyAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the key
administration service.proxy
- a proxy KeyAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyAdmin()
is false
optional
- This method must be implemented if
supportsKeyAdmin()
is true.
KeyAdminSession getKeyAdminSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the key admin
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy a KeyAdminSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsKeyAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsKeyAdmin()
and
supportsVisibleFederation()
are true.
KeyNotificationSession getKeyNotificationSession(KeyReceiver keyReceiver, Proxy proxy) throws OperationFailedException
keyReceiver
- the key receiverproxy
- a proxy KeyNotificationSession
NullArgumentException
- proxy
or
keyReceiver
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeyNotification()
is false
optional
- This method must be implemented if
supportsKeyNotification()
is true.
KeyNotificationSession getKeyNotificationSessionForAgency(KeyReceiver keyReceiver, Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the key
notification service for the given agency.keyReceiver
- the key receiveragencyId
- the Id
of the agencyproxy
- a proxy an KeyNotificationSession
NotFoundException
- agencyId
not foundNullArgumentException
- keyReceiver, agencyId
or proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsKeyNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsKeyNotification()
and
supportsVisibleFederation()
are true.
KeyAgencySession getKeyAgencySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy KeyAgencySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyAgency()
is false
optional
- This method must be implemented if
supportsKeyAgency()
is true.
KeyAgencyAssignmentSession getKeyAgencyAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy KeyAgencyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeyAgencyAssignment()
is false
optional
- This method must be implemented if
supportsKeyAgencyAssignment()
is true.
KeySmartAgencySession getKeySmartAgencySession(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the key smart
agency service for the given agency.agencyId
- the Id
of the bankproxy
- a proxy KeySmartAgencySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeySmartAgency()
is false
optional
- This method must be implemented if
supportsKeySmartAgency()
and
supportsVisibeFederation()
is true.