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

Class ExternalRequestContext.Builder

java.lang.Object

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

Enclosing class:

ExternalRequestContext

public static class ExternalRequestContext.Builder
extends Object

A builder for ExternalRequestContext instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExternalRequestContext.Builder	authId(String authId)	Sets the authId of the request.
ExternalRequestContext	build()	Creates a new ExternalRequestContext instance.
ExternalRequestContext.Builder	clientIp(String clientIp)	Sets the client IP address for the request.
ExternalRequestContext.Builder	cookies(Map<String,String> cookies)	Sets the cookies for the request.
ExternalRequestContext.Builder	headers(com.google.common.collect.ListMultimap<String,String> headers)	Sets the HTTP headers for the request.
ExternalRequestContext.Builder	hostName(String hostName)	Sets the hostname for the request.
ExternalRequestContext.Builder	locales(PreferredLocales locales)	Sets the preferred locales for the request.
ExternalRequestContext.Builder	parameters(Map<String,String[]> parameters)	Sets the parameterMap of the request.
ExternalRequestContext.Builder	serverUrl(String serverUrl)	Sets the serverUrl of the request.
ExternalRequestContext.Builder	servletRequest(javax.servlet.http.HttpServletRequest request)	Sets the HttpServletRequest.
ExternalRequestContext.Builder	servletResponse(javax.servlet.http.HttpServletResponse response)	Sets the HttpServletResponse.
ExternalRequestContext.Builder	ssoTokenId(String ssoTokenId)	Sets the ssoTokenId of the request.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

headers

public ExternalRequestContext.Builder headers(com.google.common.collect.ListMultimap<String,String> headers)

Sets the HTTP headers for the request.

Parameters:

headers - The HTTP headers.

Returns:

This builder instance.

cookies

public ExternalRequestContext.Builder cookies(Map<String,String> cookies)

Sets the cookies for the request.

Parameters:

cookies - The cookies.

Returns:

This builder instance.

locales

public ExternalRequestContext.Builder locales(PreferredLocales locales)

Sets the preferred locales for the request.

Parameters:

locales - The preferred locales.

Returns:

This builder instance.

clientIp

public ExternalRequestContext.Builder clientIp(String clientIp)

Sets the client IP address for the request.

Parameters:

clientIp - The client's IP address.

Returns:

This builder instance.

hostName

public ExternalRequestContext.Builder hostName(String hostName)

Sets the hostname for the request.

Parameters:

hostName - the host name.

Returns:

This builder instance.

ssoTokenId

public ExternalRequestContext.Builder ssoTokenId(String ssoTokenId)

Sets the ssoTokenId of the request.

Parameters:

ssoTokenId - the ssoTokenId.

Returns:

this builder.

authId

public ExternalRequestContext.Builder authId(String authId)

Sets the authId of the request.

Parameters:

authId - the authId.

Returns:

this builder.

parameters

public ExternalRequestContext.Builder parameters(Map<String,String[]> parameters)

Sets the parameterMap of the request.

Parameters:

parameters - the parameters

Returns:

this builder

serverUrl

public ExternalRequestContext.Builder serverUrl(String serverUrl)

Sets the serverUrl of the request.

Parameters:

serverUrl - the serverUrl.

Returns:

this builder.

servletRequest

public ExternalRequestContext.Builder servletRequest(javax.servlet.http.HttpServletRequest request)

Sets the HttpServletRequest.

Parameters:

request - the HttpServletRequest

Returns:

this builder.

servletResponse

public ExternalRequestContext.Builder servletResponse(javax.servlet.http.HttpServletResponse response)

Sets the HttpServletResponse.

Parameters:

response - the HttpServletResponse

Returns:

this builder.

build

public ExternalRequestContext build()

Creates a new ExternalRequestContext instance.

Returns:

A new instance of ExternalRequestContext.