org.mojavemvc.aop

Class RequestContext

java.lang.Object

org.mojavemvc.aop.RequestContext

public class RequestContext
extends Object

Supplied as an optional parameter to @BeforeAction and @AfterAction methods.

An instance of this class can be made available to intercepting action methods, simply by writing the method signature with it as a parameter. It contains a reference to the servlet request and response objects, as well as to the Java parameters sent in the request, and to the String names of the action and controller being invoked in this request.

For example, the following method demonstrates its usage:

 @BeforeAction
 public void doSomethingBefore(RequestContext ctx) {
     // do something
 }
 

Developers should note that while all the fields are declared final, the class is not completely immutable, as it exports state through the request, response, and paramters objects. When an accessor is called for one of these fields, a reference to the actual object, not to a copy, is returned.

Author:

Luis Antunes

Constructor Summary

Constructors

Constructor and Description
RequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object[] parameters, String action, String controller)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction() Gets the action invoked for this request, or an empty String if the default action was invoked.
String	getController() Gets the controller invoked for this request, or an empty String if the default controller was invoked.
Object[]	getParameters() Gets the parameters associated with the request, as their Java types as defined in the Action signature.
javax.servlet.http.HttpServletRequest	getRequest() Gets the HttpServletRequest associated with the request.
javax.servlet.http.HttpServletResponse	getResponse() Gets the HttpServletResponse associated with the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContext

public RequestContext(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              Object[] parameters,
              String action,
              String controller)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Gets the HttpServletRequest associated with the request.

Returns:

the HttpServletRequest associated with the request

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Gets the HttpServletResponse associated with the request.

Returns:

the HttpServletResponse associated with the request

getParameters

public Object[] getParameters()

Gets the parameters associated with the request, as their Java types as defined in the Action signature.

Returns:

the parameters associated with the request

getAction

public String getAction()

Gets the action invoked for this request, or an empty String if the default action was invoked.

Returns:

the action parameter, or an empty String if the default action was invoked

getController

public String getController()

Gets the controller invoked for this request, or an empty String if the default controller was invoked.

Returns:

the controller parameter, or an empty String if the default controller was invoked