public interface AuthenticationProxyManager extends OsidProxyManager, AuthenticationProfile
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:
AgentLookupSession:
session to look up
Agents
AgentQuerySession
: a session to query
Agents
AgentSearchSession:
session to search
Agents
AgentAdminSession:
session to create, modify and
delete Agents
NotificationSession:
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(Proxy proxy)
Gets the
OsidSession associated with the agency
administration service. |
AgencyHierarchyDesignSession |
getAgencyHierarchyDesignSession(Proxy proxy)
Gets the session designing agency hierarchies.
|
AgencyHierarchySession |
getAgencyHierarchySession(Proxy proxy)
Gets the session traversing agency hierarchies.
|
AgencyLookupSession |
getAgencyLookupSession(Proxy proxy)
Gets the
OsidSession associated with the agency lookup
service. |
AgencyNotificationSession |
getAgencyNotificationSession(AgencyReceiver agencyReceiver,
Proxy proxy)
Gets the messaging receiver session for notifications pertaining to
agency changes.
|
AgencySearchSession |
getAgencySearchSession(Proxy proxy)
Gets the
OsidSession associated with the agency search
service. |
AgentAdminSession |
getAgentAdminSession(Proxy proxy)
Gets the
OsidSession associated with the agent
administration service. |
AgentAdminSession |
getAgentAdminSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent admin
service for the given agency. |
AgentAgencyAssignmentSession |
getAgentAgencyAssignmentSession(Proxy proxy)
Gets the session for assigning agent to agency mappings.
|
AgentAgencySession |
getAgentAgencySession(Proxy proxy)
Gets the session for retrieving agent to agency mappings.
|
AgentLookupSession |
getAgentLookupSession(Proxy proxy)
Gets the
OsidSession associated with the agent lookup
service. |
AgentLookupSession |
getAgentLookupSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent lookup
service for the given agency. |
AgentNotificationSession |
getAgentNotificationSession(AgentReceiver agentReceiver,
Proxy proxy)
Gets the messaging receiver session for notifications pertaining to
agent changes.
|
AgentNotificationSession |
getAgentNotificationSessionForAgency(AgentReceiver agentReceiver,
Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent
notification service for the given agency. |
AgentQuerySession |
getAgentQuerySession(Proxy proxy)
Gets the
OsidSession associated with the agent query
service. |
AgentQuerySession |
getAgentQuerySessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent query
service for the given agency. |
AgentSearchSession |
getAgentSearchSession(Proxy proxy)
Gets the
OsidSession associated with the agent search
service. |
AgentSearchSession |
getAgentSearchSessionForAgency(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent search
service for the given agency. |
AgentSmartAgencySession |
getAgentSmartAgencySession(Id agencyId,
Proxy proxy)
Gets the
OsidSession associated with the agent smart
agency service for the given agency. |
AuthenticationBatchProxyManager |
getAuthenticationBatchProxyManager()
Gets an
AuthenticationBatchProxyManager. |
AuthenticationKeysProxyManager |
getAuthenticationKeysProxyManager()
Gets an
AuthenticationKeysProxyManager. |
AuthenticationProcessProxyManager |
getAuthenticationProcessProxyManager()
Gets an
AuthenticationProcessProxyManager. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agent lookup
service.proxy
- a proxy AgentLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentLookup()
is false
optional
- This method must be implemented if
supportsAgentLookup()
is true.
AgentLookupSession getAgentLookupSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent lookup
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy an AgentLookupSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agent query
service.proxy
- a proxy AgentQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentQuery()
is false
optional
- This method must be implemented if
supportsAgentQuery()
is true.
AgentQuerySession getAgentQuerySessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent query
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy AgentQuerySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agent search
service.proxy
- a proxy AgentSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentSearch()
is false
optional
- This method must be implemented if
supportsAgentSearch()
is true.
AgentSearchSession getAgentSearchSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent search
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy an AgentSearchSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agent
administration service.proxy
- a proxy AgentAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentAdmin()
is false
optional
- This method must be implemented if
supportsAgentAdmin()
is true.
AgentAdminSession getAgentAdminSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent admin
service for the given agency.agencyId
- the Id
of the agencyproxy
- a proxy an AgentAdminSession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
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, Proxy proxy) throws OperationFailedException
agentReceiver
- the agent receiverproxy
- a proxy AgentNotificationSession
NullArgumentException
- proxy
or
agentReceiver
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentNotification()
is false
optional
- This method must be implemented if
supportsAgentNotification()
is true.
AgentNotificationSession getAgentNotificationSessionForAgency(AgentReceiver agentReceiver, Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent
notification service for the given agency.agentReceiver
- the agent receiveragencyId
- the Id
of the agencyproxy
- a proxy an AgentNotificationSession
NotFoundException
- agencyId
not foundNullArgumentException
- agentReceiver, agencyId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy AgentAgencySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgentAgency()
is false
optional
- This method must be implemented if
supportsAgentAgency()
is true.
AgentAgencyAssignmentSession getAgentAgencyAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AgentAgencyAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentAgencyAssignment()
is false
optional
- This method must be implemented if
supportsAgentAgencyAssignment()
is true.
AgentSmartAgencySession getAgentSmartAgencySession(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agent smart
agency service for the given agency.agencyId
- the Id
of the bankproxy
- a proxy AgentSmartAgencySession
NotFoundException
- agencyId
not foundNullArgumentException
- agencyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentSmartAgency()
is false
optional
- This method must be implemented if
supportsAgentSmartAgency()
and
supportsVisibeFederation()
is true.
AgencyLookupSession getAgencyLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agency lookup
service.proxy
- a proxy AgencyLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencyLookup()
is false
optional
- This method must be implemented if
supportsAgencyLookup()
is true.
AgencySearchSession getAgencySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agency search
service.proxy
- a proxy AgencySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencySearch()
is false
optional
- This method must be implemented if
supportsAgencySearch()
is true.
AgencyAdminSession getAgencyAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agency
administration service.proxy
- a proxy AgencyAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgencyAdmin()
is false
optional
- This method must be implemented if
supportsAgencyAdmin()
is true.
AgencyNotificationSession getAgencyNotificationSession(AgencyReceiver agencyReceiver, Proxy proxy) throws OperationFailedException
agencyReceiver
- the agency receiverproxy
- a proxy AgencyNotificationSession
NullArgumentException
- agencyReceiver
or proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyNotification()
is false
optional
- This method must be implemented if
supportsAgencyNotification()
is true.
AgencyHierarchySession getAgencyHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AgencyHierarchySession
NullArgumentException
- proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyHierarchy()
is false
optional
- This method must be implemented if
supportsAgencyHierarchy()
is true.
AgencyHierarchyDesignSession getAgencyHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AgencyHierarchyDesignSession
NullArgumentException
- proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyHierarchyDesign()
is false
optional
- This method must be implemented if
supportsAgencyHierarchyDesign()
is true.
AuthenticationBatchProxyManager getAuthenticationBatchProxyManager() throws OperationFailedException
AuthenticationBatchProxyManager.
AuthenticationBatchProxyManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationBatch()
is false
optional
- This method must be implemented if
supportsAuthenticationBatch()
is true.
AuthenticationKeysProxyManager getAuthenticationKeysProxyManager() throws OperationFailedException
AuthenticationKeysProxyManager.
AuthenticationKeysProxyManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationKeys()
is false
optional
- This method must be implemented if
supportsAuthenticationKeys()
is true.
AuthenticationProcessProxyManager getAuthenticationProcessProxyManager() throws OperationFailedException
AuthenticationProcessProxyManager.
AuthenticationProcessproxyManager.
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAuthenticationProcess()
is false
optional
- This method must be implemented if
supportsAuthenticationProcess()
is true.