com.webmethods.portal.framework.auth

Class AuthInfo

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.webmethods.portal.framework.auth.AuthInfo

All Implemented Interfaces:

IPrincipalData, IAuthInfo, Serializable, Cloneable, Map<String,Object>

public abstract class AuthInfo
extends HashMap<String,Object>
implements IAuthInfo, IPrincipalData, Serializable, Cloneable

AuthInfo is a bean that manages some simple authentication information describing the current user. This includes whether the user is anonymous, authenticated, what the userID is etc...

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_AUTH_TYPE Deprecated. use IAuthInfo.ANONYMOUS_AUTH_TYPE instead
static String	IDSUSER Deprecated. use IAuthInfo.IDSUSER instead
static String	PORTAL_USER Deprecated. use IAuthInfo.PORTAL_USER instead
static String	REMOTEADDR Deprecated. use IAuthInfo.REMOTEADDR instead
static String	SESSION_ID Deprecated. use IAuthInfo.SESSION_ID instead
static String	SSO_CAPABLE Deprecated. use IAuthInfo.SSO_CAPABLE instead
static String	UNKNOWN_TYPE Deprecated. use IAuthInfo.UNKNOWN_TYPE instead
static String	USERS Deprecated. use IAuthInfo.USERS instead

Fields inherited from interface com.webmethods.portal.bizPolicy.IPrincipalData

ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthInfo(int initialAuthSize)

Method Summary

Modifier and Type	Method and Description
static AuthInfo	getAuthInfo(HttpSession session) Helper function to retrieve the authorization information for the current session
static IThingID	getUserID(HttpSession session) Convience method to get the user id.
static boolean	isAdminSession(HttpSession session) Helper function to determine if the given session is an Admin session
static boolean	isGuestSession(HttpSession session) Helper function to determine if the given session is a Guest session
static boolean	isSessionValid(HttpSession session) Determines if a given session is valid.
static void	setAuthInfo(HttpSession session, IAuthInfo authInfo) Helper function to set the AuthInfo information on the given session
String	toString()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.webmethods.portal.framework.auth.IAuthInfo

copy, getAuthType, getRemoteAddr, getSessionID, getSessionState, setAuthType, setRemoteAddr, setSessionID

Methods inherited from interface com.webmethods.portal.bizPolicy.IPrincipalData

getDN, getDomain, getDomainUserName, getPassword, getUri, getUserDirectoryURI, getUserID, getUserName, isAdminSession, isAnonymous, isAuthenticated, isLoginSession, isPrivilegedInfo, setAuthentication, setDN, setDomain, setInfo, setIsAdminSession, setIsAnonymous, setIsLoginSession, setIsPrivilegedInfo, setUri, setUserID, setUserName

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

UNKNOWN_TYPE

@Deprecated
public static final String UNKNOWN_TYPE

Deprecated. use IAuthInfo.UNKNOWN_TYPE instead

See Also:

Constant Field Values

USERS

@Deprecated
public static final String USERS

Deprecated. use IAuthInfo.USERS instead

See Also:

Constant Field Values

IDSUSER

@Deprecated
public static final String IDSUSER

Deprecated. use IAuthInfo.IDSUSER instead

See Also:

Constant Field Values

REMOTEADDR

@Deprecated
public static final String REMOTEADDR

Deprecated. use IAuthInfo.REMOTEADDR instead

See Also:

Constant Field Values

SESSION_ID

@Deprecated
public static final String SESSION_ID

Deprecated. use IAuthInfo.SESSION_ID instead

See Also:

Constant Field Values

PORTAL_USER

@Deprecated
public static final String PORTAL_USER

Deprecated. use IAuthInfo.PORTAL_USER instead

See Also:

Constant Field Values

ANONYMOUS_AUTH_TYPE

@Deprecated
public static final String ANONYMOUS_AUTH_TYPE

Deprecated. use IAuthInfo.ANONYMOUS_AUTH_TYPE instead

See Also:

Constant Field Values

SSO_CAPABLE

@Deprecated
public static final String SSO_CAPABLE

Deprecated. use IAuthInfo.SSO_CAPABLE instead

See Also:

Constant Field Values

Constructor Detail

AuthInfo

protected AuthInfo(int initialAuthSize)

Method Detail

getAuthInfo

public static AuthInfo getAuthInfo(HttpSession session)

Helper function to retrieve the authorization information for the current session

Parameters:

session - the HttpSession to retrieve the AuthInfo from

Returns:

the AuthInfo information for the given session

See Also:

setAuthInfo(javax.servlet.http.HttpSession, com.webmethods.portal.framework.auth.IAuthInfo)

setAuthInfo

public static void setAuthInfo(HttpSession session,
                               IAuthInfo authInfo)

Helper function to set the AuthInfo information on the given session

Parameters:

session - the HttpSession to set the AuthInfo onto

authInfo - the AuthInfo object to set

See Also:

getAuthInfo(javax.servlet.http.HttpSession)

isAdminSession

public static boolean isAdminSession(HttpSession session)

Helper function to determine if the given session is an Admin session

Parameters:

session - the HttpSession to examine

Returns:

true if the session is an admin session, false otherwise

isGuestSession

public static boolean isGuestSession(HttpSession session)

Helper function to determine if the given session is a Guest session

Parameters:

session - the HttpSession to examine

Returns:

true if the session is a guest session, false otherwise

isSessionValid

public static boolean isSessionValid(HttpSession session)

Determines if a given session is valid. A valid session contains an AuthInfo object with the isAuthValidated () option set to true

Parameters:

session - the HttpSession to validate

Returns:

true if session is valid, false otherwise

getUserID

public static IThingID getUserID(HttpSession session)

Convience method to get the user id.

Parameters:

session - is the current HttpSession containing the authinfo object

Returns:

the current user ID or NULL if not found

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>