org.pac4j.play

Class PlayWebContext

java.lang.Object

org.pac4j.play.PlayWebContext

All Implemented Interfaces:

org.pac4j.core.context.WebContext

public class PlayWebContext
extends Object
implements org.pac4j.core.context.WebContext

This class is the web context for Play (used both for Java and Scala).

"Session objects" are managed by the defined SessionStore.

"Request attributes" are saved/restored to/from the context.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected play.mvc.Http.Context	context
protected Map<String,String[]>	formParameters
static play.libs.typedmap.TypedKey<Object>	PAC4J_USER_PROFILES
protected play.mvc.Http.Request	request
protected play.mvc.Http.Response	response
protected String	responseContent
protected play.mvc.Http.Session	session
protected org.pac4j.core.context.session.SessionStore<PlayWebContext>	sessionStore

Constructor Summary

Constructors

Constructor and Description
PlayWebContext(play.mvc.Http.Context context, org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore)
PlayWebContext(play.api.mvc.RequestHeader requestHeader, Object body, org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore) We retrieve the body apart from the request.
PlayWebContext(play.api.mvc.RequestHeader requestHeader, org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore)

Method Summary

Modifier and Type	Method and Description
void	addResponseCookie(org.pac4j.core.context.Cookie cookie)
String	getFullRequestURL()
play.mvc.Http.Context	getJavaContext() Get the Java context.
play.mvc.Http.Session	getJavaSession() Get the Java session.
String	getLocation()
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() Get the response content.
String	getScheme()
String	getServerName()
int	getServerPort()
org.pac4j.core.context.session.SessionStore	getSessionStore()
boolean	isSecure()
void	setRequestAttribute(String name, Object value)
void	setResponseContentType(String content)
void	setResponseHeader(String name, String value)
void	setResponseStatus(int code)
void	writeResponseContent(String content)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pac4j.core.context.WebContext

getProtocol, getRequestContent

Field Detail

PAC4J_USER_PROFILES

public static final play.libs.typedmap.TypedKey<Object> PAC4J_USER_PROFILES

context

protected final play.mvc.Http.Context context

request

protected final play.mvc.Http.Request request

response

protected final play.mvc.Http.Response response

session

protected final play.mvc.Http.Session session

formParameters

protected Map<String,String[]> formParameters

sessionStore

protected org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore

responseContent

protected String responseContent

Constructor Detail

PlayWebContext

public PlayWebContext(play.mvc.Http.Context context,
                      org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore)

PlayWebContext

public PlayWebContext(play.api.mvc.RequestHeader requestHeader,
                      org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore)

PlayWebContext

public PlayWebContext(play.api.mvc.RequestHeader requestHeader,
                      Object body,
                      org.pac4j.core.context.session.SessionStore<PlayWebContext> sessionStore)

We retrieve the body apart from the request. Otherwise, there is an issue in casting the body between Scala and Java.

Parameters:

requestHeader - the request without the body

body - the body (maybe)

sessionStore - the session store

Method Detail

getSessionStore

public org.pac4j.core.context.session.SessionStore getSessionStore()

Specified by:

getSessionStore in interface org.pac4j.core.context.WebContext

getJavaSession

public play.mvc.Http.Session getJavaSession()

Get the Java session.

Returns:

the Java session

getJavaContext

public play.mvc.Http.Context getJavaContext()

Get the Java context.

Returns:

the Java context.

setResponseStatus

public void setResponseStatus(int code)

Specified by:

setResponseStatus in interface org.pac4j.core.context.WebContext

writeResponseContent

public void writeResponseContent(String content)

Specified by:

writeResponseContent in interface org.pac4j.core.context.WebContext

getResponseContent

public String getResponseContent()

Get the response content.

Returns:

the response content

getRequestHeader

public String getRequestHeader(String name)

Specified by:

getRequestHeader in interface org.pac4j.core.context.WebContext

getRequestMethod

public String getRequestMethod()

Specified by:

getRequestMethod in interface org.pac4j.core.context.WebContext

getRequestParameter

public String getRequestParameter(String name)

Specified by:

getRequestParameter in interface org.pac4j.core.context.WebContext

getRequestParameters

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

Specified by:

getRequestParameters 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

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

getScheme

public String getScheme()

Specified by:

getScheme in interface org.pac4j.core.context.WebContext

isSecure

public boolean isSecure()

Specified by:

isSecure in interface org.pac4j.core.context.WebContext

getFullRequestURL

public String getFullRequestURL()

Specified by:

getFullRequestURL in interface org.pac4j.core.context.WebContext

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface org.pac4j.core.context.WebContext

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

getRequestCookies

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

Specified by:

getRequestCookies in interface org.pac4j.core.context.WebContext

getPath

public String getPath()

Specified by:

getPath in interface org.pac4j.core.context.WebContext

addResponseCookie

public void addResponseCookie(org.pac4j.core.context.Cookie cookie)

Specified by:

addResponseCookie in interface org.pac4j.core.context.WebContext

setResponseContentType

public void setResponseContentType(String content)

Specified by:

setResponseContentType in interface org.pac4j.core.context.WebContext

getLocation

public String getLocation()