com.agapsys.rcf

Class ActionResponse

java.lang.Object

com.agapsys.rcf.ServletExchange

com.agapsys.rcf.ActionResponse

Direct Known Subclasses:

JsonResponse

public class ActionResponse
extends ServletExchange

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionResponse(ActionResponse wrappedResponse)

Method Summary

Modifier and Type	Method and Description
ActionResponse	addCookie(String name, String value, int maxAge) Adds a cookie for request context path.
ActionResponse	addCookie(String name, String value, int maxAge, String path) Adds a cookie.
ActionResponse	addHeader(String name, String value)
ActionRequest	getRequest()
protected ActionResponse	getWrappedResponse()
ActionResponse	removeCookie(String name) Removes a cookie for request context path.
ActionResponse	removeCookie(String name, String path) Removes a cookie.
ActionResponse	sendPermanentRedirect(String location)
ActionResponse	sendTemporaryRedirect(String location)
ActionResponse	setHeader(String name, String value)
ActionResponse	setStatus(int status)

Methods inherited from class com.agapsys.rcf.ServletExchange

getServletRequest, getServletResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionResponse

protected ActionResponse(ActionResponse wrappedResponse)

Method Detail

getWrappedResponse

protected final ActionResponse getWrappedResponse()

addCookie

public final ActionResponse addCookie(String name,
                                      String value,
                                      int maxAge,
                                      String path)

Adds a cookie.

Parameters:

name - cookie name

value - cookie value

maxAge - an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie

path - cookie path (usually HttpServletRequest.getContextPath())

Returns:

this

addCookie

public final ActionResponse addCookie(String name,
                                      String value,
                                      int maxAge)

Adds a cookie for request context path.

Parameters:

name - cookie name

value - cookie value

maxAge - an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie

Returns:

this

removeCookie

public final ActionResponse removeCookie(String name,
                                         String path)

Removes a cookie.

Parameters:

name - name of the cookie to be removed

path - cookie path ((usually HttpServletRequest.getContextPath())

Returns:

this

setHeader

public final ActionResponse setHeader(String name,
                                      String value)

addHeader

public final ActionResponse addHeader(String name,
                                      String value)

removeCookie

public final ActionResponse removeCookie(String name)

Removes a cookie for request context path.

Parameters:

name - name of the cookie to be removed

Returns:

this

sendTemporaryRedirect

public final ActionResponse sendTemporaryRedirect(String location)
                                           throws IOException

Throws:

IOException

sendPermanentRedirect

public final ActionResponse sendPermanentRedirect(String location)
                                           throws IOException

Throws:

IOException

setStatus

public final ActionResponse setStatus(int status)
                               throws IOException

Throws:

IOException

getRequest

public final ActionRequest getRequest()