Package com.webmethods.portal.framework.auth

Interface IAuthInfo

All Superinterfaces:

IPrincipalData, Map<String,Object>

All Known Implementing Classes:

AuthInfo

public interface IAuthInfo
extends IPrincipalData, Map<String,Object>

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANONYMOUS_AUTH_TYPE
static final String	IDSUSER
static final String	PORTAL_USER
static final String	REMOTEADDR
static final String	SESSION_ID
static final String	SSO_CAPABLE
static final String	UNKNOWN_TYPE
static final String	USERS

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

ID

Method Summary

Modifier and Type	Method	Description
void	copy(IAuthInfo targetAuthInfo)	Copies the current values into the targetAuthInfo
String	getAuthType()	Get the authorization type (usually the type of auth handler that accepted the auth, like 'simple', 'cookie', 'complex', etc.)
String	getRemoteAddr()	Get the Internet Protocol (IP) address of the client that sent the request.
String	getSessionID()	return the current user's session id
String	getSessionState()	Returns persisted session state in string form.
void	setAuthType(String authType)
void	setRemoteAddr(String remoteAddr)	Set the Internet Protocol (IP) address of the client that sent the request.
void	setSessionID(String sessionID)	This stores the current user's Session ID

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 Details

UNKNOWN_TYPE

static final String UNKNOWN_TYPE

See Also:

• Constant Field Values

USERS

static final String USERS

See Also:

• Constant Field Values

IDSUSER

static final String IDSUSER

See Also:

• Constant Field Values

REMOTEADDR

static final String REMOTEADDR

See Also:

• Constant Field Values

SESSION_ID

static final String SESSION_ID

See Also:

• Constant Field Values

PORTAL_USER

static final String PORTAL_USER

See Also:

• Constant Field Values

ANONYMOUS_AUTH_TYPE

static final String ANONYMOUS_AUTH_TYPE

See Also:

• Constant Field Values

SSO_CAPABLE

static final String SSO_CAPABLE

See Also:

• Constant Field Values

Method Details

getAuthType

String getAuthType()

Get the authorization type (usually the type of auth handler that accepted the auth, like 'simple', 'cookie', 'complex', etc.)

Returns:

the auth type

setAuthType

void setAuthType(String authType)

See Also:

• getAuthType()

setRemoteAddr

void setRemoteAddr(String remoteAddr)

Set the Internet Protocol (IP) address of the client that sent the request.

Parameters:

remoteAddr - Internet Protocol (IP) address

getRemoteAddr

String getRemoteAddr()

Get the Internet Protocol (IP) address of the client that sent the request.

Returns:

remoteAddr Internet Protocol (IP) address

setSessionID

void setSessionID(String sessionID)

This stores the current user's Session ID

See Also:

• HttpSession.getId()

getSessionID

String getSessionID()

return the current user's session id

See Also:

• HttpSession.getId()

getSessionState

String getSessionState()

Returns persisted session state in string form.

copy

void copy(IAuthInfo targetAuthInfo)

Copies the current values into the targetAuthInfo

Parameters:

targetAuthInfo -