org.pac4j.core.context

Class MockWebContext

java.lang.Object

org.pac4j.core.context.BaseResponseContext

org.pac4j.core.context.MockWebContext

All Implemented Interfaces:

org.pac4j.core.context.WebContext

public class MockWebContext
extends org.pac4j.core.context.BaseResponseContext

This is a mocked web context to interact with request, response and session (for tests purpose).

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	attributes
protected String	fullRequestURL
protected Map<String,String>	headers
protected String	ip
protected String	method
protected Map<String,String>	parameters
protected String	path
protected Collection<org.pac4j.core.context.Cookie>	requestCookies
protected String	scheme
protected boolean	secure
protected String	serverName
protected int	serverPort
protected Map<String,Object>	session

Fields inherited from class org.pac4j.core.context.BaseResponseContext

responseContent, responseContentType, responseCookies, responseEncoding, responseHeaders, responseLocation, responseStatus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockWebContext()

Method Summary

Modifier and Type	Method and Description
MockWebContext	addRequestHeader(String key, String value) Add a request header for mock purpose.
MockWebContext	addRequestParameter(String key, String value) Add a request parameter for mock purpose.
MockWebContext	addRequestParameters(Map<String,String> parameters) Add request parameters for mock purpose.
MockWebContext	addSessionAttribute(String name, Object value) Add a session attribute for mock purpose.
static MockWebContext	create() Create a new instance.
String	getFullRequestURL()
String	getPath()
String	getRemoteAddr()
Object	getRequestAttribute(String name)
Collection<org.pac4j.core.context.Cookie>	getRequestCookies()
String	getRequestHeader(String name)
String	getRequestMethod()
String	getRequestParameter(String name)
Map<String,String[]>	getRequestParameters()
Collection<org.pac4j.core.context.Cookie>	getResponseCookies()
String	getScheme()
String	getServerName()
int	getServerPort()
Object	getSessionAttribute(String name)
Object	getSessionIdentifier()
void	invalidateSession()
boolean	isSecure()
MockWebContext	setFullRequestURL(String fullRequestURL)
MockWebContext	setPath(String path)
MockWebContext	setRemoteAddress(String ip)
void	setRequestAttribute(String name, Object value)
MockWebContext	setRequestMethod(String method) Set the request method for mock purpose.
MockWebContext	setScheme(String scheme)
MockWebContext	setSecure(boolean secure)
void	setServerName(String serverName)
void	setServerPort(int serverPort)
void	setSessionAttribute(String name, Object value)

Methods inherited from class org.pac4j.core.context.BaseResponseContext

addResponseCookie, getResponseContent, getResponseContentType, getResponseEncoding, getResponseHeaders, getResponseLocation, getResponseStatus, setResponseCharacterEncoding, setResponseContentType, setResponseHeader, setResponseStatus, writeResponseContent

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected final Map<String,String> parameters

headers

protected final Map<String,String> headers

session

protected final Map<String,Object> session

attributes

protected final Map<String,Object> attributes

method

protected String method

serverName

protected String serverName

scheme

protected String scheme

secure

protected boolean secure

serverPort

protected int serverPort

fullRequestURL

protected String fullRequestURL

ip

protected String ip

requestCookies

protected final Collection<org.pac4j.core.context.Cookie> requestCookies

path

protected String path

Constructor Detail

MockWebContext

protected MockWebContext()

Method Detail

create

public static MockWebContext create()

Create a new instance.

Returns:

a new instance

addRequestParameters

public MockWebContext addRequestParameters(Map<String,String> parameters)

Add request parameters for mock purpose.

Parameters:

parameters - parameters

Returns:

this mock web context

addRequestParameter

public MockWebContext addRequestParameter(String key,
                                          String value)

Add a request parameter for mock purpose.

Parameters:

key - parameter name

value - parameter value

Returns:

this mock web context

addRequestHeader

public MockWebContext addRequestHeader(String key,
                                       String value)

Add a request header for mock purpose.

Parameters:

key - request name

value - request value

Returns:

this mock web context

addSessionAttribute

public MockWebContext addSessionAttribute(String name,
                                          Object value)

Add a session attribute for mock purpose.

Parameters:

name - session attribute name

value - session attribute value

Returns:

this mock web context

setRequestMethod

public MockWebContext setRequestMethod(String method)

Set the request method for mock purpose.

Parameters:

method - request method

Returns:

this mock web context

getRequestAttribute

public Object getRequestAttribute(String name)

setRequestAttribute

public void setRequestAttribute(String name,
                                Object value)

getRequestParameter

public String getRequestParameter(String name)

setRemoteAddress

public MockWebContext setRemoteAddress(String ip)

getRequestHeader

public String getRequestHeader(String name)

setSessionAttribute

public void setSessionAttribute(String name,
                                Object value)

getSessionAttribute

public Object getSessionAttribute(String name)

invalidateSession

public void invalidateSession()

getSessionIdentifier

public Object getSessionIdentifier()

getRequestMethod

public String getRequestMethod()

getRemoteAddr

public String getRemoteAddr()

getRequestParameters

public Map<String,String[]> getRequestParameters()

getServerName

public String getServerName()

getServerPort

public int getServerPort()

setServerName

public void setServerName(String serverName)

setServerPort

public void setServerPort(int serverPort)

getScheme

public String getScheme()

setScheme

public MockWebContext setScheme(String scheme)

isSecure

public boolean isSecure()

setSecure

public MockWebContext setSecure(boolean secure)

getFullRequestURL

public String getFullRequestURL()

setFullRequestURL

public MockWebContext setFullRequestURL(String fullRequestURL)

getRequestCookies

public Collection<org.pac4j.core.context.Cookie> getRequestCookies()

getResponseCookies

public Collection<org.pac4j.core.context.Cookie> getResponseCookies()

getPath

public String getPath()

setPath

public MockWebContext setPath(String path)