org.osid.authentication

Interface AuthenticationManager

All Superinterfaces:

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

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                         throws OperationFailedException

Gets the OsidSession associated with the agent lookup service.

Returns:

an AgentLookupSession

Throws:

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)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an AgentLookupSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the agent query service.

Returns:

an AgentQuerySession

Throws:

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)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an AgentQuerySession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the agent search service.

Returns:

an AgentSearchSession

Throws:

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)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an AgentSearchSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the agent administration service.

Returns:

an AgentAdminSession

Throws:

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)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an AgentAdminSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId 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)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to service changes.

Parameters:

agentReceiver - the agent receiver

Returns:

an AgentNotificationSession

Throws:

NullArgumentException - 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)
                                                              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

Returns:

an AgentNotificationSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agentReceiver or agencyId 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()
                                         throws OperationFailedException

Gets the session for retrieving agent to agency mappings.

Returns:

an AgentAgencySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentAgency() is false

Compliance:

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

getAgentAgencyAssignmentSession

AgentAgencyAssignmentSession getAgentAgencyAssignmentSession()
                                                             throws OperationFailedException

Gets the session for assigning agent to agency mappings.

Returns:

a AgentAgencyAsignmentSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an AgentSmartAgencySession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the agency lookup service.

Returns:

an AgencyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyLookup() is false

Compliance:

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

getAgencySearchSession

AgencySearchSession getAgencySearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the agency search service.

Returns:

an AgencySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencySearch() is false

Compliance:

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

getAgencyAdminSession

AgencyAdminSession getAgencyAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the agency administration service.

Returns:

an AgencyAdminSession

Throws:

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)
                                                       throws OperationFailedException

Gets the notification session for notifications pertaining to agency service changes.

Parameters:

agencyReceiver - the agency receiver

Returns:

an AgencyNotificationSession

Throws:

NullArgumentException - agencyReceiver 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()
                                                 throws OperationFailedException

Gets the session traversing agency hierarchies.

Returns:

an AgencyHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyHierarchy() is false

Compliance:

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

getAgencyHierarchyDesignSession

AgencyHierarchyDesignSession getAgencyHierarchyDesignSession()
                                                             throws OperationFailedException

Gets the session designing agency hierarchies.

Returns:

an AgencyHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyHierarchyDesign() is false

Compliance:

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

getAuthenticationBatchManager

AuthenticationBatchManager getAuthenticationBatchManager()
                                                         throws OperationFailedException

Gets an AuthenticationBatchManager.

Returns:

an AuthenticationBatchManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationBatch() is false

Compliance:

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

getAuthenticationKeysManager

AuthenticationKeysManager getAuthenticationKeysManager()
                                                       throws OperationFailedException

Gets an AuthenticationKeysManager.

Returns:

an AuthenticationKeysManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationKeys() is false

Compliance:

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

getAuthenticationProcessManager

AuthenticationProcessManager getAuthenticationProcessManager()
                                                             throws OperationFailedException

Gets an AuthenticationProcessManager.

Returns:

an AuthenticationProcessManager.

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuthenticationProcess() is false

Compliance:

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