public interface AuthenticationManager extends OsidManager, AuthenticationProfile
The authentication manager provides access to authentication sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
AgentLookupSession:
a session to look up
Agents
AgentQuerySession:
a session to query
Agents
AgentSearchSession:
a session to search
Agents
AgentAdminSession:
a session to create, modify and
delete Agents
AgentNotificationSession: a
session to receive
messages pertaining to Agent
changes AgentAgencySession:
a session to retrieve
Agent
to Agency
mappings AgentAgencyAssignmentSession:
a session to manage
Agent
to Agency
mappings AgentSmartAgencySession:
a session to create
dynamic agencies AgencyLookupSession:
a session to lookup agencies
AgencyQuerySession:
a session to query agencies
AgencySearchSession
: a session to search agencies
AgencyAdminSession
: a session to create, modify
and delete agencies AgencyNotificationSession
: a session to receive
messages pertaining to Agency
changes AgencyHierarchySession
: a session to traverse the
Agency
hierarchy AgencyHierarchyDesignSession
: a session to manage
the Agency
hierarchy Modifier and Type | Method and Description |
---|---|
AgencyAdminSession |
getAgencyAdminSession()
Gets the
OsidSession associated with the agency
administration service. |
AgencyHierarchyDesignSession |
getAgencyHierarchyDesignSession()
Gets the session designing agency hierarchies.
|
AgencyHierarchySession |
getAgencyHierarchySession()
Gets the session traversing agency hierarchies.
|
AgencyLookupSession |
getAgencyLookupSession()
Gets the
OsidSession associated with the agency lookup
service. |
AgencyNotificationSession |
getAgencyNotificationSession(AgencyReceiver agencyReceiver)
Gets the notification session for notifications pertaining to agency
service changes.
|
AgencySearchSession |
getAgencySearchSession()
Gets the
OsidSession associated with the agency search
service. |
AgentAdminSession |
getAgentAdminSession()
Gets the
OsidSession associated with the agent
administration service. |
AgentAdminSession |
getAgentAdminSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the agent admin
service for the given agency. |
AgentAgencyAssignmentSession |
getAgentAgencyAssignmentSession()
Gets the session for assigning agent to agency mappings.
|
AgentAgencySession |
getAgentAgencySession()
Gets the session for retrieving agent to agency mappings.
|
AgentLookupSession |
getAgentLookupSession()
Gets the
OsidSession associated with the agent lookup
service. |
AgentLookupSession |
getAgentLookupSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the agent lookup
service for the given agency. |
AgentNotificationSession |
getAgentNotificationSession(AgentReceiver agentReceiver)
Gets the notification session for notifications pertaining to service
changes.
|
AgentNotificationSession |
getAgentNotificationSessionForAgency(AgentReceiver agentReceiver,
Id agencyId)
Gets the
OsidSession associated with the agent
notification service for the given agency. |
AgentQuerySession |
getAgentQuerySession()
Gets the
OsidSession associated with the agent query
service. |
AgentQuerySession |
getAgentQuerySessionForAgency(Id agencyId)
Gets the
OsidSession associated with the agent query
service for the given agency. |
AgentSearchSession |
getAgentSearchSession()
Gets the
OsidSession associated with the agent search
service. |
AgentSearchSession |
getAgentSearchSessionForAgency(Id agencyId)
Gets the
OsidSession associated with the agent search
service for the given agency. |
AgentSmartAgencySession |
getAgentSmartAgencySession(Id agencyId)
Gets the
OsidSession associated with the agent smart
agency service for the given agency. |
AuthenticationBatchManager |
getAuthenticationBatchManager()
Gets an
AuthenticationBatchManager. |
AuthenticationKeysManager |
getAuthenticationKeysManager()
Gets an
AuthenticationKeysManager. |
AuthenticationProcessManager |
getAuthenticationProcessManager()
Gets an
AuthenticationProcessManager. |
changeBranch, initialize, rollbackService
close
getAgencyRecordTypes, getAgencySearchRecordTypes, getAgentRecordTypes, getAgentSearchRecordTypes, supportsAgencyAdmin, supportsAgencyHierarchy, supportsAgencyHierarchyDesign, supportsAgencyLookup, supportsAgencyNotification, supportsAgencyQuery, supportsAgencyRecordType, supportsAgencySearch, supportsAgencySearchRecordType, supportsAgentAdmin, supportsAgentAgency, supportsAgentAgencyAssignment, supportsAgentLookup, supportsAgentNotification, supportsAgentQuery, supportsAgentRecordType, supportsAgentSearch, supportsAgentSearchRecordType, supportsAgentSmartAgency, supportsAuthenticationAcquisition, supportsAuthenticationKeys, supportsAuthenticationProcess, supportsAuthenticationValidation, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AgentLookupSession getAgentLookupSession() throws OperationFailedException
OsidSession
associated with the agent lookup
service. AgentLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentLookup()
is false
optional
- This method must be implemented if
supportsAgentLookup()
is true.
AgentLookupSession getAgentLookupSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent lookup
service for the given agency.agencyId
- the Id
of the agency an AgentLookupSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsAgentLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgentLookup()
and
supportsVisibleFederation()
are true.
AgentQuerySession getAgentQuerySession() throws OperationFailedException
OsidSession
associated with the agent query
service. AgentQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentQuery()
is false
optional
- This method must be implemented if
supportsAgentQuery()
is true.
AgentQuerySession getAgentQuerySessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent query
service for the given agency.agencyId
- the Id
of the agency an AgentQuerySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsAgentQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgentQuery()
and
supportsVisibleFederation()
are true.
AgentSearchSession getAgentSearchSession() throws OperationFailedException
OsidSession
associated with the agent search
service. AgentSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentSearch()
is false
optional
- This method must be implemented if
supportsAgentSearch()
is true.
AgentSearchSession getAgentSearchSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent search
service for the given agency.agencyId
- the Id
of the agency an AgentSearchSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsAgentSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgentSearch()
and
supportsVisibleFederation()
are true.
AgentAdminSession getAgentAdminSession() throws OperationFailedException
OsidSession
associated with the agent
administration service. AgentAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentAdmin()
is false
optional
- This method must be implemented if
supportsAgentAdmin()
is true.
AgentAdminSession getAgentAdminSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent admin
service for the given agency.agencyId
- the Id
of the agency an AgentAdminSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsAgentAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgentAdmin()
and
supportsVisibleFederation()
are true.
AgentNotificationSession getAgentNotificationSession(AgentReceiver agentReceiver) throws OperationFailedException
agentReceiver
- the agent receiver AgentNotificationSession
NullArgumentException
- agentReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentNotification()
is false
optional
- This method must be implemented if
supportsAgentNotification()
is true.
AgentNotificationSession getAgentNotificationSessionForAgency(AgentReceiver agentReceiver, Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent
notification service for the given agency.agentReceiver
- the agent receiveragencyId
- the Id
of the agency an AgentNotificationSession
NotFoundException
- agencyId
not foundNullArgumentException
- agentReceiver
or
agencyId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsAgentNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAgentNotification()
and
supportsVisibleFederation()
are true.
AgentAgencySession getAgentAgencySession() throws OperationFailedException
AgentAgencySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentAgency()
is false
optional
- This method must be implemented if
supportsAgentAgency()
is true.
AgentAgencyAssignmentSession getAgentAgencyAssignmentSession() throws OperationFailedException
AgentAgencyAsignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentAgencyAssignment()
is false
optional
- This method must be implemented if
supportsAgentAgencyAssignment()
is true.
AgentSmartAgencySession getAgentSmartAgencySession(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent smart
agency service for the given agency.agencyId
- the Id
of the agency AgentSmartAgencySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentSmartAgency()
is false
optional
- This method must be implemented if
supportsAgentSmartAgency()
and
supportsVisibeFederation()
is true.
AgencyLookupSession getAgencyLookupSession() throws OperationFailedException
OsidSession
associated with the agency lookup
service. AgencyLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencyLookup()
is false
optional
- This method must be implemented if
supportsAgencyLookup()
is true.
AgencySearchSession getAgencySearchSession() throws OperationFailedException
OsidSession
associated with the agency search
service. AgencySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencySearch()
is false
optional
- This method must be implemented if
supportsAgencySearch()
is true.
AgencyAdminSession getAgencyAdminSession() throws OperationFailedException
OsidSession
associated with the agency
administration service. AgencyAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencyAdmin()
is false
optional
- This method must be implemented if
supportsAgencyAdmin()
is true.
AgencyNotificationSession getAgencyNotificationSession(AgencyReceiver agencyReceiver) throws OperationFailedException
agencyReceiver
- the agency receiver AgencyNotificationSession
NullArgumentException
- agencyReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyNotification()
is false
optional
- This method must be implemented if
supportsAgencyNotification()
is true.
AgencyHierarchySession getAgencyHierarchySession() throws OperationFailedException
AgencyHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyHierarchy()
is false
optional
- This method must be implemented if
supportsAgencyHierarchy()
is true.
AgencyHierarchyDesignSession getAgencyHierarchyDesignSession() throws OperationFailedException
AgencyHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAgencyHierarchyDesign()
is true.
AuthenticationBatchManager getAuthenticationBatchManager() throws OperationFailedException
AuthenticationBatchManager.
AuthenticationBatchManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationBatch()
is false
optional
- This method must be implemented if
supportsAuthenticationBatch()
is true.
AuthenticationKeysManager getAuthenticationKeysManager() throws OperationFailedException
AuthenticationKeysManager.
AuthenticationKeysManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationKeys()
is false
optional
- This method must be implemented if
supportsAuthenticationKeys()
is true.
AuthenticationProcessManager getAuthenticationProcessManager() throws OperationFailedException
AuthenticationProcessManager.
AuthenticationProcessManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationProcess()
is false
optional
- This method must be implemented if
supportsAuthenticationProcess()
is true.