au.org.ala.cas.util

Class AuthenticationUtils

java.lang.Object

au.org.ala.cas.util.AuthenticationUtils

public class AuthenticationUtils
extends Object

Helper methods that simplify getting key User Principal attributes from a Web Request

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_EMAIL_ADDRESS
static String	ATTR_FIRST_NAME
static String	ATTR_LAST_NAME
static String	ATTR_ROLES
static String	ATTR_USER_ID

Constructor Summary

Constructors

Constructor and Description
AuthenticationUtils()

Method Summary

Modifier and Type	Method and Description
static String	getDisplayName(javax.servlet.http.HttpServletRequest request)
static String	getEmailAddress(javax.servlet.http.HttpServletRequest request)
static String	getFirstName(javax.servlet.http.HttpServletRequest request)
static String	getLastName(javax.servlet.http.HttpServletRequest request)
static String	getPrincipalAttribute(javax.servlet.http.HttpServletRequest request, String attributeKey) Helper method that extracts the value of a specified attribute value from a AttributePrincipal
static String	getUserId(javax.servlet.http.HttpServletRequest request)
static Set<String>	getUserRoles(javax.servlet.http.HttpServletRequest request)
static boolean	isUserInRole(javax.servlet.http.HttpServletRequest request, String role) Tests to see if the currently authenticated user has the specified role

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_USER_ID

public static final String ATTR_USER_ID

See Also:

Constant Field Values

ATTR_EMAIL_ADDRESS

public static final String ATTR_EMAIL_ADDRESS

See Also:

Constant Field Values

ATTR_FIRST_NAME

public static final String ATTR_FIRST_NAME

See Also:

Constant Field Values

ATTR_LAST_NAME

public static final String ATTR_LAST_NAME

See Also:

Constant Field Values

ATTR_ROLES

public static final String ATTR_ROLES

See Also:

Constant Field Values

Constructor Detail

AuthenticationUtils

public AuthenticationUtils()

Method Detail

getUserId

public static String getUserId(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The numeric user id of the currently authenticated user, or null if not authenticated

getEmailAddress

public static String getEmailAddress(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The email address of the currently authenticated user, or null if not authenticated

getDisplayName

public static String getDisplayName(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The users display name (suitable for display in user interfaces), or null if not authenticated

getFirstName

public static String getFirstName(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The users first name, or null if not authenticated

getLastName

public static String getLastName(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The users first name, or null if not authenticated

getUserRoles

public static Set<String> getUserRoles(javax.servlet.http.HttpServletRequest request)

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

Returns:

The users roles in a set or an empty set if the user is not authenticated

isUserInRole

public static boolean isUserInRole(javax.servlet.http.HttpServletRequest request,
                                   String role)

Tests to see if the currently authenticated user has the specified role

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

role - The name of the role to test. E.g. ALA_ADMIN

Returns:

True if the user has the specified role. False if not, or not authenticated

getPrincipalAttribute

public static String getPrincipalAttribute(javax.servlet.http.HttpServletRequest request,
                                           String attributeKey)

Helper method that extracts the value of a specified attribute value from a AttributePrincipal

Parameters:

request - Needs to be a AlaHttpServletRequestWrapperFilter or HttpServletRequestWrapperFilter

attributeKey - The name of the attribute to retrieve

Returns:

The value of the specified attribute, or null