Interface AuthenticationManager

All Superinterfaces:

AuthenticationProfile, AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 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

Modifier and Type	Method	Description
TypeList	getAgencyRecordTypes()	Gets the supported Agency record types.
TypeList	getAgencySearchRecordTypes()	Gets the supported Agency search record types.
TypeList	getAgentRecordTypes()	Gets the supported Agent record types.
TypeList	getAgentSearchRecordTypes()	Gets the supported Agent search record types.
boolean	supportsAgencyAdmin()	Tests if an agency administrative service is supported.
boolean	supportsAgencyHierarchy()	Tests if an agency hierarchy traversal is supported.
boolean	supportsAgencyHierarchyDesign()	Tests if an agency hierarchy design is supported.
boolean	supportsAgencyLookup()	Tests if an agency lookup service is supported.
boolean	supportsAgencyNotification()	Tests if agency notification is supported.
boolean	supportsAgencyQuery()	Tests if an agency query service is supported.
boolean	supportsAgencyRecordType(Type agencyRecordType)	Tests if the given Agency record type is supported.
boolean	supportsAgencySearch()	Tests if an agency search service is supported.
boolean	supportsAgencySearchRecordType(Type agencySearchRecordType)	Tests if the given Agency search record type is supported.
boolean	supportsAgentAdmin()	Tests if an agent administrative service is supported.
boolean	supportsAgentAgency()	Tests if retrieving mappings of agents and agencies is supported.
boolean	supportsAgentAgencyAssignment()	Tests if managing mappings of agents and agencies is supported.
boolean	supportsAgentLookup()	Tests if an agent lookup service is supported.
boolean	supportsAgentNotification()	Tests if agent notification is supported.
boolean	supportsAgentQuery()	Tests if an agent query service is supported.
boolean	supportsAgentRecordType(Type agentRecordType)	Tests if the given Agent record type is supported.
boolean	supportsAgentSearch()	Tests if an agent search service is supported.
boolean	supportsAgentSearchRecordType(Type agentSearchRecordType)	Tests if the given Agent search record type is supported.
boolean	supportsAgentSmartAgency()	Tests if agent smart agency is available.
boolean	supportsAuthenticationAcquisition()	Tests is authentication acquisition is supported.
boolean	supportsAuthenticationKeys()	Tests if an authentication key service is available.
boolean	supportsAuthenticationProcess()	Tests if an authentication process service is available.
boolean	supportsAuthenticationValidation()	Tests if authentication validation is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsAgentLookup()} is {@code 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 {@code supportsAgentLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgentQuery()} is {@code 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 {@code supportsAgentQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgentSearch()} is {@code 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 {@code supportsAgentSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgentAdmin()} is {@code 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 {@code supportsAgentAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgentNotification()} is {@code 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 {@code supportsAgentNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgentAgency()} is {@code 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 {@code supportsAgentAgencyAssignment()} is {@code 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 {@code supportsAgentSmartAgency()} and {@code supportsVisibeFederation()} is {@code 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 {@code supportsAgencyLookup()} is {@code 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 {@code supportsAgencySearch()} is {@code 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 {@code supportsAgencyAdmin()} is {@code 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 {@code supportsAgencyNotification()} is {@code 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 {@code supportsAgencyHierarchy()} is {@code 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 {@code supportsAgencyHierarchyDesign()} is {@code 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 {@code supportsAuthenticationBatch()} is {@code 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 {@code supportsAuthenticationKeys()} is {@code 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 {@code supportsAuthenticationProcess()} is {@code true} .