neo.xredsys.content.agreement

Interface AgreementResponse

All Known Implementing Classes:

AgreementResponseImpl

public interface AgreementResponse

A response to an agreement validation, making it possible to abort or continue the response, as the agreement handler sees fit.

An Agreement Response is passed to the AgreementHandler#service, which may exhert a certain amount of control towards the page content. If the handler can't validate its agreement, it should abort the request. To abort a request, the handler must define what should happen to the response; wether it should be redirected, forwaded, or authenticated. This is done by invoking the setRedirect, setLocalRedirect, setForward or setBasicAuthenticationRealm methods. These methods inform the Agreement system that the request should not continue as normal.

In any case, the response may include cookies; and request and session attributes may be made available as well. These may be set both when the request is aborted, and when it is not aborted. To allow a request to go through, it is enough simply to not call any of the redirect, forward or authenticate methods.

Method Summary

Modifier and Type	Method and Description
void	addCookie(String name, String value) Add a cookie to the response stream.
String	getBasicAuthenticationRealm()
String	getCookie(String name) Return a specific cookie.
Set	getCookieNames() Return the names of the cookies which agreements have requested to be set on the response.
int	getError() Return the error code, or 0 for no error code
String	getForward()
String	getHeader(String name) Return a specific header.
Set	getHeaderNames() Return the names of the headers which agreements have requested to be set on the response.
String	getLocalRedirect()
String	getRedirect()
Object	getRequestAttribute(String name) Return a specific request attribute which is to be placed in the request scope
Set	getRequestAttributeNames() return the names of the request attributes which an agreement has requested to be set in the request scope.
Object	getSessionAttribute(String name) Return a specific Session attribute which is to be placed in the Session scope
Set	getSessionAttributeNames() return the names of the Session attributes which an agreement has requested to be set in the Session scope.
int	getStatus() Return the error code, or 0 for no error code
void	setBasicAuthenticationRealm(String realm) Specify that the agreement requires HTTP authentication using the realm realm.
void	setError(int code) Send a specific error on the HTTP response.
void	setForward(String URI) Forward the request to a JSP or servlet, without using HTTP Redirects, but rather, using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse).
void	setHeader(String name, String value) Specify that a header should be set using the given name and value.
void	setLocalRedirect(String URI) Redirect the response to a local (context relative) URI.
void	setRedirect(String URL) Redirect the response using HTTP 302 to a specific URL, as defined in the HTTP RFC.
void	setRequestAttribute(String name, Object object) Specify that an attribute be added to the request scope.
void	setSessionAttribute(String name, Object object) Specify that an attribute be added to the session scope.
void	setStatus(int code) Set a specific status on the HTTP response.

Method Detail

setRedirect

void setRedirect(String URL)

Redirect the response using HTTP 302 to a specific URL, as defined in the HTTP RFC. The URL should either contain an absolute URL (e.g. http://login.myserver.com/login) or a path relative to the local context

getRedirect

String getRedirect()

setLocalRedirect

void setLocalRedirect(String URI)

Redirect the response to a local (context relative) URI. This is typically used to redirect to a servlet in the same web application as the one from which the content is being served.

Parameters:

URI - The context relative path of the servlet, or JSP which will handle the remainder of the request.

getLocalRedirect

String getLocalRedirect()

setStatus

void setStatus(int code)

Set a specific status on the HTTP response.

Parameters:

code - The acutal status code (302, 304, and so on)

getStatus

int getStatus()

Return the error code, or 0 for no error code

Returns:

the error code, or 0 for no specific error code.

setError

void setError(int code)

Send a specific error on the HTTP response. This will abort the response.

Parameters:

code - The acutal error code (404, 403, and so on)

getError

int getError()

Return the error code, or 0 for no error code

Returns:

the error code, or 0 for no specific error code.

setForward

void setForward(String URI)

Forward the request to a JSP or servlet, without using HTTP Redirects, but rather, using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse).

Parameters:

URI -

getForward

String getForward()

setBasicAuthenticationRealm

void setBasicAuthenticationRealm(String realm)

Specify that the agreement requires HTTP authentication using the realm realm.

Parameters:

realm - The name of the realm in which to perform the login

getBasicAuthenticationRealm

String getBasicAuthenticationRealm()

addCookie

void addCookie(String name,
               String value)

Add a cookie to the response stream.

Parameters:

name - The name of the cookie

value - The value of the cookie

getCookieNames

Set getCookieNames()

Return the names of the cookies which agreements have requested to be set on the response.

Returns:

a set of names of the cookies.

getCookie

String getCookie(String name)

Return a specific cookie.

Parameters:

name - the name of the cookie to be retrieved

Returns:

the cookie value, or null if the cookie hasn't been added.

setHeader

void setHeader(String name,
               String value)

Specify that a header should be set using the given name and value.

Parameters:

name - The name of the header

value - The value of the header

getHeaderNames

Set getHeaderNames()

Return the names of the headers which agreements have requested to be set on the response.

Returns:

a set of names of the headers.

getHeader

String getHeader(String name)

Return a specific header.

Parameters:

name - the name of the header to be retrieved

Returns:

the header value, or null if the header hasn't been added.

setRequestAttribute

void setRequestAttribute(String name,
                         Object object)

Specify that an attribute be added to the request scope. The attribute will be available for the remainder of the request.

Parameters:

name - The name of the request attribute

object - The actual request attribute value.

getRequestAttributeNames

Set getRequestAttributeNames()

return the names of the request attributes which an agreement has requested to be set in the request scope.

Returns:

a set of valid attribute names.

getRequestAttribute

Object getRequestAttribute(String name)

Return a specific request attribute which is to be placed in the request scope

Parameters:

name - The name of the request attribute.

Returns:

a value to be placed in request scope.

setSessionAttribute

void setSessionAttribute(String name,
                         Object object)

Specify that an attribute be added to the session scope. The attribute will be available for the remainder of the session.

Parameters:

name - The name of the session attribute

object - The actual session attribute value.

getSessionAttributeNames

Set getSessionAttributeNames()

return the names of the Session attributes which an agreement has requested to be set in the Session scope.

Returns:

a set of valid attribute names.

getSessionAttribute

Object getSessionAttribute(String name)

Return a specific Session attribute which is to be placed in the Session scope

Parameters:

name - The name of the Session attribute.

Returns:

a value to be placed in Session scope.