WebContext (pac4j core 2.3.1 API)

All Known Implementing Classes:

J2EContext
```
public interface WebContext
```
This interface represents the web context to use HTTP request and session.

Since:

1.4.0

Author:

Jerome Leleu

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addResponseCookie(Cookie cookie)` Adds cookies to the response
`java.lang.String`	`getFullRequestURL()` Return the full URL (with query string) the client used to request the server.
`java.lang.String`	`getPath()` Get the "servlet path" (in a J2E style).
`java.lang.String`	`getRemoteAddr()` Return the remote address.
`java.lang.Object`	`getRequestAttribute(java.lang.String name)` Return a request attribute.
`default java.lang.String`	`getRequestContent()` Gets content body of the original request.
`java.util.Collection<Cookie>`	`getRequestCookies()` Retrieves request cookies.
`java.lang.String`	`getRequestHeader(java.lang.String name)` Return a request header.
`java.lang.String`	`getRequestMethod()` Return the request method.
`java.lang.String`	`getRequestParameter(java.lang.String name)` Return a request parameter.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getRequestParameters()` Return all request parameters.
`java.lang.String`	`getScheme()` Return the scheme.
`java.lang.String`	`getServerName()` Return the server name.
`int`	`getServerPort()` Return the server port.
`default java.lang.Object`	`getSessionAttribute(java.lang.String name)` Get an attribute from session.
`default java.lang.String`	`getSessionIdentifier()` Gets the session id for this context.
`SessionStore`	`getSessionStore()` Get the session store.
`boolean`	`isSecure()` Return whether the request is secure.
`void`	`setRequestAttribute(java.lang.String name, java.lang.Object value)` Save a request attribute.
`void`	`setResponseContentType(java.lang.String content)` Sets the response content type.
`void`	`setResponseHeader(java.lang.String name, java.lang.String value)` Add a header to the response.
`void`	`setResponseStatus(int code)` Set the response status.
`default void`	`setSessionAttribute(java.lang.String name, java.lang.Object value)` Save an attribute in session.
`void`	`setSessionStore(SessionStore sessionStore)` Deprecated.
`void`	`writeResponseContent(java.lang.String content)` Write some content in the response.

- Method Detail
  - getSessionStore
```
SessionStore getSessionStore()
```
    Get the session store.
    
    Returns:
    
    the session store
  - setSessionStore
```
@Deprecated
void setSessionStore(SessionStore sessionStore)
```
    Deprecated.
    
    Set the session store. WARNING! This will likely be removed in version 3.0.0 as changing the session during the lifetime of the web context does not make much sense. Reported by Jez from Vert.x
    
    Parameters:
    
    sessionStore - the session store
  - getRequestParameter
```
java.lang.String getRequestParameter(java.lang.String name)
```
    Return a request parameter.
    
    Parameters:
    
    name - name of the parameter
    
    Returns:
    
    the request parameter
  - getRequestParameters
```
java.util.Map<java.lang.String,java.lang.String[]> getRequestParameters()
```
    Return all request parameters.
    
    Returns:
    
    all request parameters
  - getRequestAttribute
```
java.lang.Object getRequestAttribute(java.lang.String name)
```
    Return a request attribute.
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    the attribute
  - setRequestAttribute
```
void setRequestAttribute(java.lang.String name,
                         java.lang.Object value)
```
    Save a request attribute.
    
    Parameters:
    
    name - the name of the attribute
    
    value - the attribute
  - getRequestHeader
```
java.lang.String getRequestHeader(java.lang.String name)
```
    Return a request header.
    
    Parameters:
    
    name - name of the header
    
    Returns:
    
    the request header
  - setSessionAttribute
```
default void setSessionAttribute(java.lang.String name,
                                 java.lang.Object value)
```
    Save an attribute in session.
    
    Parameters:
    
    name - name of the session attribute
    
    value - value of the session attribute
  - getSessionAttribute
```
default java.lang.Object getSessionAttribute(java.lang.String name)
```
    Get an attribute from session.
    
    Parameters:
    
    name - name of the session attribute
    
    Returns:
    
    the session attribute
  - getSessionIdentifier
```
default java.lang.String getSessionIdentifier()
```
    Gets the session id for this context.
    
    Returns:
    
    the session identifier
  - getRequestMethod
```
java.lang.String getRequestMethod()
```
    Return the request method.
    
    Returns:
    
    the request method
  - getRemoteAddr
```
java.lang.String getRemoteAddr()
```
    Return the remote address.
    
    Returns:
    
    the remote address.
  - writeResponseContent
```
void writeResponseContent(java.lang.String content)
```
    Write some content in the response.
    
    Parameters:
    
    content - content to write in response
  - setResponseStatus
```
void setResponseStatus(int code)
```
    Set the response status.
    
    Parameters:
    
    code - status code to set for the response
  - setResponseHeader
```
void setResponseHeader(java.lang.String name,
                       java.lang.String value)
```
    Add a header to the response.
    
    Parameters:
    
    name - name of the header
    
    value - value of the header
  - setResponseContentType
```
void setResponseContentType(java.lang.String content)
```
    Sets the response content type.
    
    Parameters:
    
    content - the content type
  - getServerName
```
java.lang.String getServerName()
```
    Return the server name.
    
    Returns:
    
    the server name
  - getServerPort
```
int getServerPort()
```
    Return the server port.
    
    Returns:
    
    the server port
  - getScheme
```
java.lang.String getScheme()
```
    Return the scheme.
    
    Returns:
    
    the scheme
  - isSecure
```
boolean isSecure()
```
    Return whether the request is secure.
    
    Returns:
    
    whether the request is secure
  - getFullRequestURL
```
java.lang.String getFullRequestURL()
```
    Return the full URL (with query string) the client used to request the server.
    
    Returns:
    
    the URL
    
    Since:
    
    1.5.0
  - getRequestCookies
```
java.util.Collection<Cookie> getRequestCookies()
```
    Retrieves request cookies.
    
    Returns:
    
    the request cookies
    
    Since:
    
    1.8.0
  - addResponseCookie
```
void addResponseCookie(Cookie cookie)
```
    Adds cookies to the response
    
    Parameters:
    
    cookie - a cookie to add to the response
    
    Since:
    
    1.8.0
  - getPath
```
java.lang.String getPath()
```
    Get the "servlet path" (in a J2E style).
    
    Returns:
    
    the "servlet path"
    
    Since:
    
    1.8.1
  - getRequestContent
```
default java.lang.String getRequestContent()
```
    Gets content body of the original request.
    
    Returns:
    
    the request content
    
    Since:
    
    1.9.2

Interface WebContext

Method Summary

Method Detail

getSessionStore

setSessionStore

getRequestParameter

getRequestParameters

getRequestAttribute

setRequestAttribute

getRequestHeader

setSessionAttribute

getSessionAttribute

getSessionIdentifier

getRequestMethod

getRemoteAddr

writeResponseContent

setResponseStatus

setResponseHeader

setResponseContentType

getServerName

getServerPort

getScheme

isSecure

getFullRequestURL

getRequestCookies

addResponseCookie

getPath

getRequestContent