Package org.forgerock.openam.auth.node.api

Class ExternalRequestContext

java.lang.Object

org.forgerock.openam.auth.node.api.ExternalRequestContext

@SupportedAll
public final class ExternalRequestContext
extends Object

A representation of the external HTTP request in the current tree authentication context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalRequestContext.Builder	A builder for ExternalRequestContext instances.

Field Summary

Fields

Modifier and Type	Field	Description
final String	authId	The authId.
final String	clientIp	The IP address associated with the current HTTP request.
final Map<String,String>	cookies	The cookie name-value pairs for the current authenticate HTTP request.
final ListMultimap<String,String>	headers	The HTTP headers from the current authenticate HTTP request.
final String	hostName	The host name associated with the current HTTP request.
final PreferredLocales	locales	The preferred locales for the request.
final Map<String,List<String>>	parameters	The parameters of the request.
final String	serverUrl	The URL of the server.
final javax.servlet.http.HttpServletRequest	servletRequest	The HttpServletRequest of the current authentication context.
final javax.servlet.http.HttpServletResponse	servletResponse	The HttpServletResponse of the current authentication context.
final String	ssoTokenId	The SSO token ID.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

headers

public final ListMultimap<String,String> headers

The HTTP headers from the current authenticate HTTP request.

cookies

public final Map<String,String> cookies

The cookie name-value pairs for the current authenticate HTTP request.

locales

public final PreferredLocales locales

The preferred locales for the request.

clientIp

public final String clientIp

The IP address associated with the current HTTP request.

hostName

public final String hostName

The host name associated with the current HTTP request.

ssoTokenId

public final String ssoTokenId

The SSO token ID. This is available if user already has a session, usually during upgrade.

authId

public final String authId

The authId. This is typically available after the first call to the authentication.

parameters

public final Map<String,List<String>> parameters

The parameters of the request.

serverUrl

public final String serverUrl

The URL of the server.

servletRequest

public final javax.servlet.http.HttpServletRequest servletRequest

The HttpServletRequest of the current authentication context.

servletResponse

public final javax.servlet.http.HttpServletResponse servletResponse

The HttpServletResponse of the current authentication context.