MockWebContext (pac4j core 1.9.1 Test API)

java.lang.Object
- org.pac4j.core.context.MockWebContext

All Implemented Interfaces:

org.pac4j.core.context.WebContext
```
public final class MockWebContext
extends Object
implements org.pac4j.core.context.WebContext
```
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`	`responseContent`
`protected String`	`responseContentType`
`protected Collection<org.pac4j.core.context.Cookie>`	`responseCookies`
`protected Map<String,String>`	`responseHeaders`
`protected int`	`responseStatus`
`protected String`	`scheme`
`protected boolean`	`secure`
`protected String`	`serverName`
`protected int`	`serverPort`
`protected Map<String,Object>`	`session`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MockWebContext()

Constructors
Modifier	Constructor and Description
`protected`	`MockWebContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`void`	`addResponseCookie(org.pac4j.core.context.Cookie cookie)`
`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()`
`String`	`getResponseContent()`
`String`	`getResponseContentType()`
`Collection<org.pac4j.core.context.Cookie>`	`getResponseCookies()`
`Map<String,String>`	`getResponseHeaders()`
`String`	`getResponseLocation()`
`int`	`getResponseStatus()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`Object`	`getSessionAttribute(String name)`
`Object`	`getSessionIdentifier()`
`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.
`void`	`setResponseContentType(String content)`
`void`	`setResponseHeader(String name, String value)`
`void`	`setResponseStatus(int code)`
`MockWebContext`	`setScheme(String scheme)`
`MockWebContext`	`setSecure(boolean secure)`
`void`	`setServerName(String serverName)`
`void`	`setServerPort(int serverPort)`
`void`	`setSessionAttribute(String name, Object value)`
`void`	`writeResponseContent(String content)`

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
```

responseContent
```
protected String responseContent
```

responseStatus
```
protected int responseStatus
```

responseContentType
```
protected String responseContentType
```

responseHeaders

protected final Map<String,String> responseHeaders

responseCookies

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

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)
```
  Specified by:
  
  getRequestAttribute in interface org.pac4j.core.context.WebContext
- setRequestAttribute
```
public void setRequestAttribute(String name,
                                Object value)
```
  Specified by:
  
  setRequestAttribute in interface org.pac4j.core.context.WebContext
- getRequestParameter
```
public String getRequestParameter(String name)
```
  Specified by:
  
  getRequestParameter in interface org.pac4j.core.context.WebContext
- setRemoteAddress
```
public MockWebContext setRemoteAddress(String ip)
```
- getRequestHeader
```
public String getRequestHeader(String name)
```
  Specified by:
  
  getRequestHeader in interface org.pac4j.core.context.WebContext
- setSessionAttribute
```
public void setSessionAttribute(String name,
                                Object value)
```
  Specified by:
  
  setSessionAttribute in interface org.pac4j.core.context.WebContext
- getSessionAttribute
```
public Object getSessionAttribute(String name)
```
  Specified by:
  
  getSessionAttribute in interface org.pac4j.core.context.WebContext
- getSessionIdentifier
```
public Object getSessionIdentifier()
```
  Specified by:
  
  getSessionIdentifier in interface org.pac4j.core.context.WebContext
- getRequestMethod
```
public String getRequestMethod()
```
  Specified by:
  
  getRequestMethod in interface org.pac4j.core.context.WebContext
- getRemoteAddr
```
public String getRemoteAddr()
```
  Specified by:
  
  getRemoteAddr in interface org.pac4j.core.context.WebContext
- getRequestParameters
```
public Map<String,String[]> getRequestParameters()
```
  Specified by:
  
  getRequestParameters in interface org.pac4j.core.context.WebContext
- getServerName
```
public String getServerName()
```
  Specified by:
  
  getServerName in interface org.pac4j.core.context.WebContext
- getServerPort
```
public int getServerPort()
```
  Specified by:
  
  getServerPort in interface org.pac4j.core.context.WebContext
- setServerName
```
public void setServerName(String serverName)
```
- setServerPort
```
public void setServerPort(int serverPort)
```
- getScheme
```
public String getScheme()
```
  Specified by:
  
  getScheme in interface org.pac4j.core.context.WebContext
- setScheme
```
public MockWebContext setScheme(String scheme)
```
- isSecure
```
public boolean isSecure()
```
  Specified by:
  
  isSecure in interface org.pac4j.core.context.WebContext
- setSecure
```
public MockWebContext setSecure(boolean secure)
```
- getFullRequestURL
```
public String getFullRequestURL()
```
  Specified by:
  
  getFullRequestURL in interface org.pac4j.core.context.WebContext
- setFullRequestURL
```
public MockWebContext setFullRequestURL(String fullRequestURL)
```
- getRequestCookies
```
public Collection<org.pac4j.core.context.Cookie> getRequestCookies()
```
  Specified by:
  
  getRequestCookies in interface org.pac4j.core.context.WebContext
- getResponseCookies
```
public Collection<org.pac4j.core.context.Cookie> getResponseCookies()
```
- getPath
```
public String getPath()
```
  Specified by:
  
  getPath in interface org.pac4j.core.context.WebContext
- setPath
```
public MockWebContext setPath(String path)
```
- writeResponseContent
```
public void writeResponseContent(String content)
```
  Specified by:
  
  writeResponseContent in interface org.pac4j.core.context.WebContext
- setResponseStatus
```
public void setResponseStatus(int code)
```
  Specified by:
  
  setResponseStatus in interface org.pac4j.core.context.WebContext
- setResponseHeader
```
public void setResponseHeader(String name,
                              String value)
```
  Specified by:
  
  setResponseHeader in interface org.pac4j.core.context.WebContext
- getResponseContent
```
public String getResponseContent()
```
- getResponseStatus
```
public int getResponseStatus()
```
- getResponseLocation
```
public String getResponseLocation()
```
- getResponseHeaders
```
public Map<String,String> getResponseHeaders()
```
- setResponseContentType
```
public void setResponseContentType(String content)
```
  Specified by:
  
  setResponseContentType in interface org.pac4j.core.context.WebContext
- getResponseContentType
```
public String getResponseContentType()
```
- addResponseCookie
```
public void addResponseCookie(org.pac4j.core.context.Cookie cookie)
```
  Specified by:
  
  addResponseCookie in interface org.pac4j.core.context.WebContext

Class MockWebContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parameters

headers

session

attributes

method

serverName

scheme

secure

serverPort

fullRequestURL

ip

requestCookies

path

responseContent

responseStatus

responseContentType

responseHeaders

responseCookies

Constructor Detail

MockWebContext

Method Detail

create

addRequestParameters

addRequestParameter

addRequestHeader

addSessionAttribute

setRequestMethod

getRequestAttribute

setRequestAttribute

getRequestParameter

setRemoteAddress

getRequestHeader

setSessionAttribute

getSessionAttribute

getSessionIdentifier

getRequestMethod

getRemoteAddr

getRequestParameters

getServerName

getServerPort

setServerName

setServerPort

getScheme

setScheme

isSecure

setSecure

getFullRequestURL

setFullRequestURL

getRequestCookies

getResponseCookies

getPath

setPath

writeResponseContent

setResponseStatus

setResponseHeader

getResponseContent

getResponseStatus

getResponseLocation

getResponseHeaders

setResponseContentType

getResponseContentType

addResponseCookie