org.dspace.app.util

Class AuthenticationUtil

java.lang.Object

org.dspace.app.util.AuthenticationUtil

public class AuthenticationUtil
extends Object

Methods for authenticating the user. This is DSpace platform code, as opposed to the site-specific authentication code, that resides in implementations of the org.dspace.eperson.AuthenticationMethod interface.

Author:

Scott Phillips, Robert Tansley, MArk Diggory

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_INTERRUPTED Session attribute name for storing the return URL where the user should be redirected too once successfully authenticated.
static String	REQUEST_INTERRUPTED_CHARACTERS
static String	REQUEST_INTERRUPTED_HEADER These store a message giving a reason for why the request is being interrupted.
static String	REQUEST_INTERRUPTED_MESSAGE
static String	REQUEST_RESUME

Constructor Summary

Constructors

Constructor and Description
AuthenticationUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static org.dspace.core.Context	authenticate(javax.servlet.http.HttpServletRequest request, String email, String password, String realm) Authenticate the current DSpace content based upon given authentication credentials.
static org.dspace.core.Context	authenticateImplicit(javax.servlet.http.HttpServletRequest request) Perform implicit authentication.
static boolean	isLoggedIn(javax.servlet.http.HttpServletRequest request) Has this user authenticated?
static void	logIn(javax.servlet.http.HttpServletRequest request, org.dspace.eperson.EPerson eperson) Log the given user in as a real authenticated user.
static void	logOut(org.dspace.core.Context context, javax.servlet.http.HttpServletRequest request) Log the user out.
static void	resumeLogin(org.dspace.core.Context context, javax.servlet.http.HttpServletRequest request) Check to see if there are any session attributes indicating a currently authenticated user.
static javax.servlet.http.HttpServletRequest	resumeRequest(javax.servlet.http.HttpServletRequest realHttpRequest) Check to see if this request should be resumed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUEST_INTERRUPTED

public static final String REQUEST_INTERRUPTED

Session attribute name for storing the return URL where the user should be redirected too once successfully authenticated.

See Also:

Constant Field Values

REQUEST_RESUME

public static final String REQUEST_RESUME

See Also:

Constant Field Values

REQUEST_INTERRUPTED_HEADER

public static final String REQUEST_INTERRUPTED_HEADER

These store a message giving a reason for why the request is being interrupted.

See Also:

Constant Field Values

REQUEST_INTERRUPTED_MESSAGE

public static final String REQUEST_INTERRUPTED_MESSAGE

See Also:

Constant Field Values

REQUEST_INTERRUPTED_CHARACTERS

public static final String REQUEST_INTERRUPTED_CHARACTERS

See Also:

Constant Field Values

Constructor Detail

AuthenticationUtil

public AuthenticationUtil()

Method Detail

authenticate

public static org.dspace.core.Context authenticate(javax.servlet.http.HttpServletRequest request,
                                   String email,
                                   String password,
                                   String realm)
                                            throws SQLException

Authenticate the current DSpace content based upon given authentication credentials. The AuthenticationManager will consult the configured authentication stack to determine the best method.

Parameters:

request - Http Request Object

email - The email credentials provided by the user.

password - The password credentials provided by the user.

realm - The realm credentials provided by the user.

Returns:

Return a current context with either the eperson attached if the authentication was successful or or no eperson attached if the attempt failed.

Throws:

SQLException

authenticateImplicit

public static org.dspace.core.Context authenticateImplicit(javax.servlet.http.HttpServletRequest request)
                                                    throws SQLException

Perform implicit authentication. The authenticationManager will consult the authentication stack for any methods that can implicitly authenticate this session. If the attempt was successful then the returned context will have an eperson attached other wise the context will not have an eperson attached.

Parameters:

request - Http Request

Returns:

This requests DSpace context.

Throws:

SQLException

logIn

public static void logIn(javax.servlet.http.HttpServletRequest request,
         org.dspace.eperson.EPerson eperson)
                  throws SQLException

Log the given user in as a real authenticated user. This should only be used after a user has presented credentials and they have been validated. This method signature is provided to be easier to call from flow scripts.

Parameters:

request - HTTP request

eperson - the eperson logged in

Throws:

SQLException

resumeLogin

public static void resumeLogin(org.dspace.core.Context context,
               javax.servlet.http.HttpServletRequest request)
                        throws SQLException

Check to see if there are any session attributes indicating a currently authenticated user. If there is then log this user in.

Parameters:

context - DSpace context

request - HTTP Request

Throws:

SQLException

logOut

public static void logOut(org.dspace.core.Context context,
          javax.servlet.http.HttpServletRequest request)
                   throws SQLException

Log the user out.

Parameters:

context - DSpace context

request - HTTP request

Throws:

SQLException

isLoggedIn

public static boolean isLoggedIn(javax.servlet.http.HttpServletRequest request)

Has this user authenticated?

Parameters:

request -

Returns:

true if request is in a session having a user ID.

resumeRequest

public static javax.servlet.http.HttpServletRequest resumeRequest(javax.servlet.http.HttpServletRequest realHttpRequest)

Check to see if this request should be resumed.

Parameters:

realHttpRequest - The current real request

Returns:

Either the current real request or a stored request that was previously interrupted.