org.pac4j.core.context

Class BaseResponseContext

java.lang.Object

org.pac4j.core.context.BaseResponseContext

All Implemented Interfaces:

WebContext

Direct Known Subclasses:

J2ERequestContext

public abstract class BaseResponseContext
extends Object
implements WebContext

This class implements the methods related to the response as a POJO.

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	responseContent
protected String	responseContentType
protected Collection<Cookie>	responseCookies
protected String	responseEncoding
protected Map<String,String>	responseHeaders
protected String	responseLocation
protected int	responseStatus

Constructor Summary

Constructors

Constructor and Description
BaseResponseContext()

Method Summary

Modifier and Type	Method and Description
void	addResponseCookie(Cookie cookie) Adds cookies to the response
String	getResponseContent()
String	getResponseContentType()
String	getResponseEncoding()
Map<String,String>	getResponseHeaders()
String	getResponseLocation()
int	getResponseStatus()
void	setResponseContentType(String content) Sets the response content type.
void	setResponseHeader(String name, String value) Add a header to the response.
void	setResponseStatus(int code) Set the response status.
void	writeResponseContent(String content) Write some content in the response.

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

getFullRequestURL, getPath, getRemoteAddr, getRequestAttribute, getRequestCookies, getRequestHeader, getRequestMethod, getRequestParameter, getRequestParameters, getScheme, getServerName, getServerPort, getSessionAttribute, getSessionIdentifier, isSecure, setRequestAttribute, setSessionAttribute

Field Detail

responseContent

protected String responseContent

responseStatus

protected int responseStatus

responseLocation

protected String responseLocation

responseContentType

protected String responseContentType

responseEncoding

protected String responseEncoding

responseHeaders

protected final Map<String,String> responseHeaders

responseCookies

protected final Collection<Cookie> responseCookies

Constructor Detail

BaseResponseContext

public BaseResponseContext()

Method Detail

writeResponseContent

public void writeResponseContent(String content)

Description copied from interface: WebContext

Write some content in the response.

Specified by:

writeResponseContent in interface WebContext

Parameters:

content - content to write in response

setResponseStatus

public void setResponseStatus(int code)

Description copied from interface: WebContext

Set the response status.

Specified by:

setResponseStatus in interface WebContext

Parameters:

code - status code to set for the 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

getResponseContent

public String getResponseContent()

getResponseStatus

public int getResponseStatus()

getResponseLocation

public String getResponseLocation()

getResponseHeaders

public Map<String,String> getResponseHeaders()

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

getResponseContentType

public String getResponseContentType()

getResponseEncoding

public String getResponseEncoding()

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