public interface AuthenticationKeysManager extends OsidManager, AuthenticationKeysProfile
The authentication keys manager provides access to authenticationkeys sessions and provides interoperability tests for various aspects of this service. 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()
Gets the
OsidSession associated with the key
administration service. |
KeyAdminSession |
getKeyAdminSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the key admin
service for the given agency. |
KeyAgencyAssignmentSession |
getKeyAgencyAssignmentSession()
Gets the session for assigning key to agency mappings.
|
KeyAgencySession |
getKeyAgencySession()
Gets the session for retrieving key to agency mappings.
|
KeyLookupSession |
getKeyLookupSession()
Gets the
OsidSession associated with the key lookup
service. |
KeyLookupSession |
getKeyLookupSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the key lookup
service for the given agency. |
KeyNotificationSession |
getKeyNotificationSession(KeyReceiver keyReceiver)
Gets the notification session for notifications pertaining to service
changes.
|
KeyNotificationSession |
getKeyNotificationSessionForAgency(KeyReceiver keyReceiver,
Id agencyId)
Gets the
OsidSession associated with the key
notification service for the given agency. |
KeySearchSession |
getKeySearchSession()
Gets the
OsidSession associated with the key search
service. |
KeySearchSession |
getKeySearchSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the key search
service for the given agency. |
KeySmartAgencySession |
getKeySmartAgencySession(Id agencyId)
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() throws OperationFailedException
OsidSession
associated with the key lookup
service. KeyLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyLookup()
is false
optional
- This method must be implemented if
supportsKeyLookup()
is true.
KeyLookupSession getKeyLookupSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the key lookup
service for the given agency.agencyId
- the Id
of the agency a KeyLookupSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
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() throws OperationFailedException
OsidSession
associated with the key search
service. KeySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeySearch()
is false
optional
- This method must be implemented if
supportsKeySearch()
is true.
KeySearchSession getKeySearchSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the key search
service for the given agency.agencyId
- the Id
of the agency a KeySearchSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
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() throws OperationFailedException
OsidSession
associated with the key
administration service. KeyAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyAdmin()
is false
optional
- This method must be implemented if
supportsKeyAdmin()
is true.
KeyAdminSession getKeyAdminSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the key admin
service for the given agency.agencyId
- the Id
of the agency a KeyAdminSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
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) throws OperationFailedException
keyReceiver
- the key receiver KeyNotificationSession
NullArgumentException
- keyReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeyNotification()
is false
optional
- This method must be implemented if
supportsKeyNotification()
is true.
KeyNotificationSession getKeyNotificationSessionForAgency(KeyReceiver keyReceiver, Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the key
notification service for the given agency.keyReceiver
- the key receiveragencyId
- the Id
of the agency an KeyNotificationSession
NotFoundException
- agencyId
not foundNullArgumentException
- keyReceiver
or
agencyId
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() throws OperationFailedException
KeyAgencySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsKeyAgency()
is false
optional
- This method must be implemented if
supportsKeyAgency()
is true.
KeyAgencyAssignmentSession getKeyAgencyAssignmentSession() throws OperationFailedException
KeyAgencyAsignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeyAgencyAssignment()
is false
optional
- This method must be implemented if
supportsKeyAgencyAssignment()
is true.
KeySmartAgencySession getKeySmartAgencySession(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the key smart
agency service for the given agency.agencyId
- the Id
of the agency KeySmartAgencySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsKeySmartAgency()
is false
optional
- This method must be implemented if
supportsKeySmartAgency()
and
supportsVisibeFederation()
is true.