enterprises.orbital.oauth

Class AuthUtil

java.lang.Object

enterprises.orbital.oauth.AuthUtil

public class AuthUtil
extends Object

Singleton class providing authentication utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDAUTH_REDIRECT_SESSION_VAR The session variable holding the redirect when adding a source for a signed in user
static String	SOURCE_SESSION_VAR The session variable holding the sign on source for the currently signed in user
static String	UID_SESSION_VAR The session variable holding the UID for the currently signed in user

Constructor Summary

Constructors

Constructor and Description
AuthUtil()

Method Summary

Modifier and Type	Method and Description
static void	addListener(UserActionListener listener)
static UserAccount	createNewUserAccount(boolean b)
static UserAuthSource	createSource(UserAccount newUser, String source, String screenName, String body)
static UserAuthSource	getBySourceScreenname(String source, String screenName)
static UserAuthSource	getCurrentSource(javax.servlet.http.HttpServletRequest req) Get the UserAuthSource for the currently signed in user, or null if no user is signed in.
static UserAccount	getCurrentUser(javax.servlet.http.HttpServletRequest req) Return the currently signed in user, or null if no user is signed in.
static void	prepAuthFlow(javax.servlet.http.HttpServletRequest req)
static void	removeSourceIfExists(UserAccount acct, String source)
static void	setUserAccountProvider(UserAccountProvider provider)
static void	signOff(javax.servlet.http.HttpServletRequest req) Mark a user as signed off.
static void	signOn(javax.servlet.http.HttpServletRequest req, UserAccount user, UserAuthSource source) Mark a user as signed on unless the account is inactive, in which case we throw an error.

Methods inherited from class java.lang.Object

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

Field Detail

UID_SESSION_VAR

public static final String UID_SESSION_VAR

The session variable holding the UID for the currently signed in user

See Also:

Constant Field Values

SOURCE_SESSION_VAR

public static final String SOURCE_SESSION_VAR

The session variable holding the sign on source for the currently signed in user

See Also:

Constant Field Values

ADDAUTH_REDIRECT_SESSION_VAR

public static final String ADDAUTH_REDIRECT_SESSION_VAR

The session variable holding the redirect when adding a source for a signed in user

See Also:

Constant Field Values

Constructor Detail

AuthUtil

public AuthUtil()

Method Detail

setUserAccountProvider

public static void setUserAccountProvider(UserAccountProvider provider)

prepAuthFlow

public static void prepAuthFlow(javax.servlet.http.HttpServletRequest req)

getCurrentUser

public static UserAccount getCurrentUser(javax.servlet.http.HttpServletRequest req)

Return the currently signed in user, or null if no user is signed in.

Parameters:

req - the HttpServletRequest holding auth credentials.

Returns:

the current signed in UserAccount, or null if no user signed in.

getCurrentSource

public static UserAuthSource getCurrentSource(javax.servlet.http.HttpServletRequest req)

Get the UserAuthSource for the currently signed in user, or null if no user is signed in.

Parameters:

req - the HttpServletRequest holding auth credentials.

Returns:

the UserAuthSource of the currently signed in UserAccount, or null if no user signed in.

signOn

public static void signOn(javax.servlet.http.HttpServletRequest req,
                          UserAccount user,
                          UserAuthSource source)
                   throws IOException

Mark a user as signed on unless the account is inactive, in which case we throw an error.

Parameters:

req - the HttpServletRequest holding auth credentials.

user - the UserAccount to sign on.

source - the source from which the user account signed on.

Throws:

IOException - if an error occurs processing signon.

signOff

public static void signOff(javax.servlet.http.HttpServletRequest req)

Mark a user as signed off.

Parameters:

req - the HttpServletRequest holding auth credentials.

removeSourceIfExists

public static void removeSourceIfExists(UserAccount acct,
                                        String source)

getBySourceScreenname

public static UserAuthSource getBySourceScreenname(String source,
                                                   String screenName)

createSource

public static UserAuthSource createSource(UserAccount newUser,
                                          String source,
                                          String screenName,
                                          String body)

createNewUserAccount

public static UserAccount createNewUserAccount(boolean b)

addListener

public static void addListener(UserActionListener listener)