ExternalRequestContext (OpenAM Server Only 7.4.1 Documentation)

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
`String`	`authId`	The authId.
`String`	`clientIp`	The IP address associated with the current HTTP request.
`Map<String,String>`	`cookies`	The cookie name-value pairs for the current authenticate HTTP request.
`ListMultimap<String,String>`	`headers`	The HTTP headers from the current authenticate HTTP request.
`String`	`hostName`	The host name associated with the current HTTP request.
`PreferredLocales`	`locales`	The preferred locales for the request.
`Map<String,List<String>>`	`parameters`	The parameters of the request.
`String`	`serverUrl`	The URL of the server.
`javax.servlet.http.HttpServletRequest`	`servletRequest`	The `HttpServletRequest` of the current authentication context.
`javax.servlet.http.HttpServletResponse`	`servletResponse`	The `HttpServletResponse` of the current authentication context.
`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 Detail
  - 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.