com.prosyst.mprm.backend.login

Interface LoginService

public interface LoginService

LoginService provides user authentication and session management of users logged in to the mPRM.

Method Summary

Modifier and Type	Method and Description
UserSession	getSession(byte[] sessionId) Returns UserSession object for a session with a given identifier or null if there is no such session.
byte[]	getSystemSessionId() Returns the identifier of the system session.
UserSession	login(java.lang.String userName, java.util.Dictionary credentials) Authenticates the user and creates a session object which unique identifies the current session of the user with the mPRM.
UserSession	resumeSession(java.lang.String userName, java.util.Dictionary credentials, byte[] sessionId) Authenticates the user and creates a session object with a supplied session identifier.

Method Detail

login

UserSession login(java.lang.String userName,
                  java.util.Dictionary credentials)
           throws LoginException

Authenticates the user and creates a session object which unique identifies the current session of the user with the mPRM.

Parameters:

userName - the user identifier

credentials - parameters used for verifying the authenticity of the user. The content of the credentials dictionary depends of the used authentication mechanism.

Returns:

encapsulates current session of the logged in user.

Throws:

LoginException - if the user does not exists or its credentials could not be verified.

resumeSession

UserSession resumeSession(java.lang.String userName,
                          java.util.Dictionary credentials,
                          byte[] sessionId)
                   throws LoginException

Authenticates the user and creates a session object with a supplied session identifier. This method is used to resume a user session which was established with one mPRM RAS to another.

Parameters:

userName - the user identifier

credentials - parameters used for verifying the authenticity of the user. The content of the credentials dictionary depends of the used authentication mechanism.

sessionId - the session id of previously established session.

Returns:

encapsulates current session of the logged in user.

Throws:

LoginException - if the user does not exists or its credentials could not be verified.

getSession

UserSession getSession(byte[] sessionId)

Returns UserSession object for a session with a given identifier or null if there is no such session.

Parameters:

sessionId - the identifier of the session

Returns:

the user session object.

getSystemSessionId

byte[] getSystemSessionId()

Returns the identifier of the system session. This session is not initiated by the user but is used for system level communication between backend hosts.

Returns:

sessionId of the system session