org.osid.authentication

Interface AuthenticationProxyManager

All Superinterfaces:

AuthenticationProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

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
• Agent 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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.authentication.AuthenticationProfile

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAgentLookupSession

AgentLookupSession getAgentLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the agent lookup service.

Parameters:

proxy - a proxy

Returns:

an AgentLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentLookup() is false

Compliance:

optional - This method must be implemented if supportsAgentLookup() is true.

getAgentLookupSessionForAgency

AgentLookupSession getAgentLookupSessionForAgency(Id agencyId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the agent lookup service for the given agency.

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

an AgentLookupSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentLookup() and supportsVisibleFederation() are true.

getAgentQuerySession

AgentQuerySession getAgentQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the agent query service.

Parameters:

proxy - a proxy

Returns:

an AgentQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if supportsAgentQuery() is true.

getAgentQuerySessionForAgency

AgentQuerySession getAgentQuerySessionForAgency(Id agencyId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the agent query service for the given agency.

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

an AgentQuerySession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentQuery() and supportsVisibleFederation() are true.

getAgentSearchSession

AgentSearchSession getAgentSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the agent search service.

Parameters:

proxy - a proxy

Returns:

an AgentSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentSearch() is false

Compliance:

optional - This method must be implemented if supportsAgentSearch() is true.

getAgentSearchSessionForAgency

AgentSearchSession getAgentSearchSessionForAgency(Id agencyId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the agent search service for the given agency.

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

an AgentSearchSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentSearch() and supportsVisibleFederation() are true.

getAgentAdminSession

AgentAdminSession getAgentAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the agent administration service.

Parameters:

proxy - a proxy

Returns:

an AgentAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentAdmin() is false

Compliance:

optional - This method must be implemented if supportsAgentAdmin() is true.

getAgentAdminSessionForAgency

AgentAdminSession getAgentAdminSessionForAgency(Id agencyId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the agent admin service for the given agency.

Parameters:

agencyId - the Id of the agency

proxy - a proxy

Returns:

an AgentAdminSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentAdmin() and supportsVisibleFederation() are true.

getAgentNotificationSession

AgentNotificationSession getAgentNotificationSession(AgentReceiver agentReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the messaging receiver session for notifications pertaining to agent changes.

Parameters:

agentReceiver - the agent receiver

proxy - a proxy

Returns:

an AgentNotificationSession

Throws:

NullArgumentException - proxy or agentReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentNotification() is false

Compliance:

optional - This method must be implemented if supportsAgentNotification() is true.

getAgentNotificationSessionForAgency

AgentNotificationSession getAgentNotificationSessionForAgency(AgentReceiver agentReceiver,
                                                            Id agencyId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the agent notification service for the given agency.

Parameters:

agentReceiver - the agent receiver

agencyId - the Id of the agency

proxy - a proxy

Returns:

an AgentNotificationSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agentReceiver, agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentNotification() and supportsVisibleFederation() are true.

getAgentAgencySession

AgentAgencySession getAgentAgencySession(Proxy proxy)
                                         throws OperationFailedException

Gets the session for retrieving agent to agency mappings.

Parameters:

proxy - a proxy

Returns:

an AgentAgencySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentAgency() is false

Compliance:

optional - This method must be implemented if supportsAgentAgency() is true.

getAgentAgencyAssignmentSession

AgentAgencyAssignmentSession getAgentAgencyAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for assigning agent to agency mappings.

Parameters:

proxy - a proxy

Returns:

an AgentAgencyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentAgencyAssignment() is false

Compliance:

optional - This method must be implemented if supportsAgentAgencyAssignment() is true.

getAgentSmartAgencySession

AgentSmartAgencySession getAgentSmartAgencySession(Id agencyId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the agent smart agency service for the given agency.

Parameters:

agencyId - the Id of the bank

proxy - a proxy

Returns:

an AgentSmartAgencySession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentSmartAgency() is false

Compliance:

optional - This method must be implemented if supportsAgentSmartAgency() and supportsVisibeFederation() is true.

getAgencyLookupSession

AgencyLookupSession getAgencyLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the agency lookup service.

Parameters:

proxy - a proxy

Returns:

an AgencyLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyLookup() is false

Compliance:

optional - This method must be implemented if supportsAgencyLookup() is true.

getAgencySearchSession

AgencySearchSession getAgencySearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the agency search service.

Parameters:

proxy - a proxy

Returns:

an AgencySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencySearch() is false

Compliance:

optional - This method must be implemented if supportsAgencySearch() is true.

getAgencyAdminSession

AgencyAdminSession getAgencyAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the agency administration service.

Parameters:

proxy - a proxy

Returns:

an AgencyAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyAdmin() is false

Compliance:

optional - This method must be implemented if supportsAgencyAdmin() is true.

getAgencyNotificationSession

AgencyNotificationSession getAgencyNotificationSession(AgencyReceiver agencyReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the messaging receiver session for notifications pertaining to agency changes.

Parameters:

agencyReceiver - the agency receiver

proxy - a proxy

Returns:

an AgencyNotificationSession

Throws:

NullArgumentException - agencyReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyNotification() is false

Compliance:

optional - This method must be implemented if supportsAgencyNotification() is true.

getAgencyHierarchySession

AgencyHierarchySession getAgencyHierarchySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the session traversing agency hierarchies.

Parameters:

proxy - a proxy

Returns:

an AgencyHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyHierarchy() is false

Compliance:

optional - This method must be implemented if supportsAgencyHierarchy() is true.

getAgencyHierarchyDesignSession

AgencyHierarchyDesignSession getAgencyHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the session designing agency hierarchies.

Parameters:

proxy - a proxy

Returns:

an AgencyHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsAgencyHierarchyDesign() is true.

getAuthenticationBatchProxyManager

AuthenticationBatchProxyManager getAuthenticationBatchProxyManager()
                                                                   throws OperationFailedException

Gets an AuthenticationBatchProxyManager.

Returns:

an AuthenticationBatchProxyManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationBatch() is false

Compliance:

optional - This method must be implemented if supportsAuthenticationBatch() is true.

getAuthenticationKeysProxyManager

AuthenticationKeysProxyManager getAuthenticationKeysProxyManager()
                                                                 throws OperationFailedException

Gets an AuthenticationKeysProxyManager.

Returns:

an AuthenticationKeysProxyManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationKeys() is false

Compliance:

optional - This method must be implemented if supportsAuthenticationKeys() is true.

getAuthenticationProcessProxyManager

AuthenticationProcessProxyManager getAuthenticationProcessProxyManager()
                                                                       throws OperationFailedException

Gets an AuthenticationProcessProxyManager.

Returns:

an AuthenticationProcessproxyManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationProcess() is false

Compliance:

optional - This method must be implemented if supportsAuthenticationProcess() is true.