Package org.pac4j.core.context

Class JEEContext

java.lang.Object

org.pac4j.core.context.JEEContext

All Implemented Interfaces:

WebContext

public class JEEContext
extends Object
implements WebContext

This implementation uses the JEE HttpServletRequest and HttpServletResponse.

Since:

1.4.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor	Description
JEEContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Build a JEE context from the current HTTP request and response.
JEEContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SessionStore<JEEContext> sessionStore)	Build a JEE context from the current HTTP request and response.

Method Summary

Modifier and Type	Method	Description
void	addResponseCookie(Cookie cookie)	Adds cookies to the response
String	getFullRequestURL()	Return the full URL (with query string) the client used to request the server.
javax.servlet.http.HttpServletRequest	getNativeRequest()	Return the native HTTP request.
javax.servlet.http.HttpServletResponse	getNativeResponse()	Return the native HTTP response.
String	getPath()	This is not implemented using HttpServletRequest.getServletPath() or HttpServletRequest.getPathInfo() because they both have strange behaviours in different contexts (inside servlets, inside filters, various container implementation, etc)
String	getProtocol()	Get the protocol version.
String	getRemoteAddr()	Return the remote address.
Optional	getRequestAttribute(String name)	Return a request attribute.
String	getRequestContent()	Gets content body of the original request.
Collection<Cookie>	getRequestCookies()	Retrieves request cookies.
Optional<String>	getRequestHeader(String name)	Return a request header.
String	getRequestMethod()	Return the request method.
Optional<String>	getRequestParameter(String name)	Return a request parameter.
Map<String,String[]>	getRequestParameters()	Return all request parameters.
String	getScheme()	Return the scheme.
String	getServerName()	Return the server name.
int	getServerPort()	Return the server port.
SessionStore	getSessionStore()	Get the session store.
boolean	isSecure()	Return whether the request is secure.
void	setRequestAttribute(String name, Object value)	Save a request attribute.
void	setResponseContentType(String content)	Sets the response content type.
void	setResponseHeader(String name, String value)	Add a header to the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

JEEContext

public JEEContext(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)

Build a JEE context from the current HTTP request and response.

Parameters:

request - the current request

response - the current response

JEEContext

public JEEContext(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  SessionStore<JEEContext> sessionStore)

Build a JEE context from the current HTTP request and response.

Parameters:

request - the current request

response - the current response

sessionStore - the session store to use

Method Detail

getSessionStore

public SessionStore getSessionStore()

Description copied from interface: WebContext

Get the session store.

Specified by:

getSessionStore in interface WebContext

Returns:

the session store

getRequestParameter

public Optional<String> getRequestParameter(String name)

Description copied from interface: WebContext

Return a request parameter.

Specified by:

getRequestParameter in interface WebContext

Parameters:

name - name of the parameter

Returns:

the request parameter

getRequestAttribute

public Optional getRequestAttribute(String name)

Description copied from interface: WebContext

Return a request attribute.

Specified by:

getRequestAttribute in interface WebContext

Parameters:

name - the name of the attribute

Returns:

the attribute

setRequestAttribute

public void setRequestAttribute(String name,
                                Object value)

Description copied from interface: WebContext

Save a request attribute.

Specified by:

setRequestAttribute in interface WebContext

Parameters:

name - the name of the attribute

value - the attribute

getRequestParameters

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

Description copied from interface: WebContext

Return all request parameters.

Specified by:

getRequestParameters in interface WebContext

Returns:

all request parameters

getRequestHeader

public Optional<String> getRequestHeader(String name)

Description copied from interface: WebContext

Return a request header.

Specified by:

getRequestHeader in interface WebContext

Parameters:

name - name of the header

Returns:

the request header

getRequestMethod

public String getRequestMethod()

Description copied from interface: WebContext

Return the request method.

Specified by:

getRequestMethod in interface WebContext

Returns:

the request method

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: WebContext

Return the remote address.

Specified by:

getRemoteAddr in interface WebContext

Returns:

the remote address.

getNativeRequest

public javax.servlet.http.HttpServletRequest getNativeRequest()

Return the native HTTP request.

Returns:

the native HTTP request

getNativeResponse

public javax.servlet.http.HttpServletResponse getNativeResponse()

Return the native HTTP response.

Returns:

the native HTTP response

setResponseHeader

public void setResponseHeader(String name,
                              String value)

Description copied from interface: WebContext

Add a header to the response.

Specified by:

setResponseHeader in interface WebContext

Parameters:

name - name of the header

value - value of the header

setResponseContentType

public void setResponseContentType(String content)

Description copied from interface: WebContext

Sets the response content type.

Specified by:

setResponseContentType in interface WebContext

Parameters:

content - the content type

getServerName

public String getServerName()

Description copied from interface: WebContext

Return the server name.

Specified by:

getServerName in interface WebContext

Returns:

the server name

getServerPort

public int getServerPort()

Description copied from interface: WebContext

Return the server port.

Specified by:

getServerPort in interface WebContext

Returns:

the server port

getScheme

public String getScheme()

Description copied from interface: WebContext

Return the scheme.

Specified by:

getScheme in interface WebContext

Returns:

the scheme

isSecure

public boolean isSecure()

Description copied from interface: WebContext

Return whether the request is secure.

Specified by:

isSecure in interface WebContext

Returns:

whether the request is secure

getFullRequestURL

public String getFullRequestURL()

Description copied from interface: WebContext

Return the full URL (with query string) the client used to request the server.

Specified by:

getFullRequestURL in interface WebContext

Returns:

the URL

getRequestCookies

public Collection<Cookie> getRequestCookies()

Description copied from interface: WebContext

Retrieves request cookies.

Specified by:

getRequestCookies in interface WebContext

Returns:

the request cookies

addResponseCookie

public void addResponseCookie(Cookie cookie)

Description copied from interface: WebContext

Adds cookies to the response

Specified by:

addResponseCookie in interface WebContext

Parameters:

cookie - a cookie to add to the response

getPath

public String getPath()

This is not implemented using HttpServletRequest.getServletPath() or HttpServletRequest.getPathInfo() because they both have strange behaviours in different contexts (inside servlets, inside filters, various container implementation, etc)

Specified by:

getPath in interface WebContext

Returns:

the "servlet path"

getRequestContent

public String getRequestContent()

Description copied from interface: WebContext

Gets content body of the original request.

Specified by:

getRequestContent in interface WebContext

Returns:

the request content

getProtocol

public String getProtocol()

Description copied from interface: WebContext

Get the protocol version.

Specified by:

getProtocol in interface WebContext

Returns:

the protocol version