com.goldencode.p2j.main

Class WebDriverRequestParameters

java.lang.Object

com.goldencode.p2j.main.WebDriverRequestParameters

public class WebDriverRequestParameters
extends java.lang.Object

The container for the web request details fetched from the servlet request.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.servlet.http.Cookie[]	cookies Cookies attached to the request.
private java.lang.String	externalUserIp The external user IP.
private java.lang.String	forwardedHost X-Forwarded-Host HTTP header, i.e.
private java.lang.String	forwardedProto X-Forwarded-Proto HTTP header, i.e.
private java.lang.String	internalUserIp The internal user IP.
private java.util.Map<java.lang.String,java.lang.String[]>	paramMap A map of all query / form params.
private java.lang.String	password If SSO is disabled or SSO auto-login has completed, it's the operating system user password.
private org.eclipse.jetty.util.MultiMap<java.lang.String>	queryParams The login url query parameters as map.
private java.lang.String	serverName The server name.
private int	serverPort The server port.
private java.lang.String	theme The selected UI theme.
private java.lang.String	user If SSO is disabled or SSO auto-login has completed, it's the operating system userid.

Constructor Summary

Constructors

Constructor and Description
WebDriverRequestParameters() Package-private constructor.

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.Cookie[]	getCookies() Getter for cookies.
java.lang.String	getExternalUserIp() Getter for externalUserIp.
java.lang.String	getForwardedHost() Getter for forwardedHost.
java.lang.String	getForwardedProto() Getter for forwardedProto.
java.lang.String	getInternalUserIp() Getter for internalUserIp.
java.lang.String	getParameter(java.lang.String paramNameToken) Returns the first value of for the param name or null if not found.
java.util.Map<java.lang.String,java.lang.String[]>	getParamMap() Getter for paramMap.
java.lang.String	getPassword() Getter for password.
org.eclipse.jetty.util.MultiMap<java.lang.String>	getQueryParams() Getter for queryParams.
java.lang.String	getServerName() Getter for serverName.
int	getServerPort() Getter for serverPort.
java.lang.String	getTheme() Getter for theme.
java.lang.String	getUser() Getter for user.
WebDriverRequestParameters	setCookies(javax.servlet.http.Cookie[] cookies) Setter for cookies.
WebDriverRequestParameters	setExternalUserIp(java.lang.String clientIp) Setter for externalUserIp.
WebDriverRequestParameters	setForwardedHost(java.lang.String forwardedHost) Setter for forwardedHost.
WebDriverRequestParameters	setForwardedProto(java.lang.String forwardedProto) Setter for forwardedProto.
WebDriverRequestParameters	setInternalUserIp(java.lang.String internalUserIp) Setter for internalUserIp.
WebDriverRequestParameters	setParamMap(java.util.Map<java.lang.String,java.lang.String[]> paramMap) Setter for paramMap.
WebDriverRequestParameters	setPassword(java.lang.String password) Setter for password.
WebDriverRequestParameters	setQueryParams(org.eclipse.jetty.util.MultiMap<java.lang.String> queryParams) Setter for queryParams.
WebDriverRequestParameters	setServerName(java.lang.String serverName) Setter for serverName.
WebDriverRequestParameters	setServerPort(int serverPort) Setter for serverPort.
WebDriverRequestParameters	setTheme(java.lang.String theme) Setter for theme.
WebDriverRequestParameters	setUser(java.lang.String user) Setter for user.

Methods inherited from class java.lang.Object

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

Field Detail

user

private java.lang.String user

If SSO is disabled or SSO auto-login has completed, it's the operating system userid. If the SSO login attempt hasn't been processed, it's the app user.

password

private java.lang.String password

If SSO is disabled or SSO auto-login has completed, it's the operating system user password. If the SSO login attempt hasn't been processed, it's the app password.

theme

private java.lang.String theme

The selected UI theme.

paramMap

private java.util.Map<java.lang.String,java.lang.String[]> paramMap

A map of all query / form params.

queryParams

private org.eclipse.jetty.util.MultiMap<java.lang.String> queryParams

The login url query parameters as map.

forwardedHost

private java.lang.String forwardedHost

X-Forwarded-Host HTTP header, i.e. www.example.com:port. Available with proxy forwarding.

forwardedProto

private java.lang.String forwardedProto

X-Forwarded-Proto HTTP header, i.e. https. Available with proxy forwarding.

externalUserIp

private java.lang.String externalUserIp

The external user IP.

internalUserIp

private java.lang.String internalUserIp

The internal user IP.

serverName

private java.lang.String serverName

The server name.

serverPort

private int serverPort

The server port.

cookies

private javax.servlet.http.Cookie[] cookies

Cookies attached to the request.

Constructor Detail

WebDriverRequestParameters

WebDriverRequestParameters()

Package-private constructor.

Method Detail

getUser

public java.lang.String getUser()

Getter for user.

Returns:

See above.

setUser

public WebDriverRequestParameters setUser(java.lang.String user)

Setter for user.

Parameters:

user - The user name

Returns:

The current object.

getPassword

public java.lang.String getPassword()

Getter for password.

Returns:

See above.

setPassword

public WebDriverRequestParameters setPassword(java.lang.String password)

Setter for password.

Parameters:

password - The user's password

Returns:

The current object.

getParamMap

public java.util.Map<java.lang.String,java.lang.String[]> getParamMap()

Getter for paramMap.

Returns:

See above.

setParamMap

public WebDriverRequestParameters setParamMap(java.util.Map<java.lang.String,java.lang.String[]> paramMap)

Setter for paramMap.

Parameters:

paramMap - The map of all query / form params.

Returns:

The current object.

getQueryParams

public org.eclipse.jetty.util.MultiMap<java.lang.String> getQueryParams()

Getter for queryParams.

Returns:

See above.

setQueryParams

public WebDriverRequestParameters setQueryParams(org.eclipse.jetty.util.MultiMap<java.lang.String> queryParams)

Setter for queryParams.

Parameters:

queryParams - The query parameters.

Returns:

The current object.

getParameter

public java.lang.String getParameter(java.lang.String paramNameToken)

Returns the first value of for the param name or null if not found.

Returns:

See above.

getTheme

public java.lang.String getTheme()

Getter for theme.

Returns:

See above.

setTheme

public WebDriverRequestParameters setTheme(java.lang.String theme)

Setter for theme.

Parameters:

theme - The selected theme

Returns:

The current object.

getForwardedHost

public java.lang.String getForwardedHost()

Getter for forwardedHost.

Returns:

See above.

setForwardedHost

public WebDriverRequestParameters setForwardedHost(java.lang.String forwardedHost)

Setter for forwardedHost.

Parameters:

forwardedHost - The X-Forwarded-Host header

Returns:

The current object.

getForwardedProto

public java.lang.String getForwardedProto()

Getter for forwardedProto.

Returns:

See above.

setForwardedProto

public WebDriverRequestParameters setForwardedProto(java.lang.String forwardedProto)

Setter for forwardedProto.

Parameters:

forwardedProto - The X-Forwarded-Proto header

Returns:

The current object.

getExternalUserIp

public java.lang.String getExternalUserIp()

Getter for externalUserIp.

Returns:

See above.

setExternalUserIp

public WebDriverRequestParameters setExternalUserIp(java.lang.String clientIp)

Setter for externalUserIp.

Parameters:

clientIp - The external client address

Returns:

The current object.

getInternalUserIp

public java.lang.String getInternalUserIp()

Getter for internalUserIp.

Returns:

See above.

setInternalUserIp

public WebDriverRequestParameters setInternalUserIp(java.lang.String internalUserIp)

Setter for internalUserIp.

Parameters:

internalUserIp - The internal client address

Returns:

The current object.

getServerName

public java.lang.String getServerName()

Getter for serverName.

Returns:

See above.

setServerName

public WebDriverRequestParameters setServerName(java.lang.String serverName)

Setter for serverName.

Parameters:

serverName - The server name.

Returns:

The current object.

getServerPort

public int getServerPort()

Getter for serverPort.

Returns:

See above.

setServerPort

public WebDriverRequestParameters setServerPort(int serverPort)

Setter for serverPort.

Parameters:

serverPort - The server port.

Returns:

The current object.

getCookies

public javax.servlet.http.Cookie[] getCookies()

Getter for cookies.

Returns:

See above.

setCookies

public WebDriverRequestParameters setCookies(javax.servlet.http.Cookie[] cookies)

Setter for cookies.

Parameters:

cookies - The cookies

Returns:

The current object.