org.wandora.modules.servlet

Class GenericContext.ForwardResult

java.lang.Object

org.wandora.modules.servlet.GenericContext.ForwardResult

Enclosing class:

GenericContext

public static class GenericContext.ForwardResult
extends java.lang.Object

A helper class to contain information about forwarding a request to actions. It has three fields. The forward field simply indicates whether the request should be forwarded on. The responded field indicates whether a response has already been sent to the user. This could be the case, for example, if a login page is sent as a reply and the request should not be forwarded until the user has logged in. Finally, the user field contains the logged in user, or null if not relevant or not logged in.

All three parameters can be passed straight to the constructor in the order forward, responded, user. There is also a two-parameter constructor without the user, which will then be set to null. A normal forward with no other handling would be new ForwardResult(true,false,null) and normal blocking new ForwardResult(false,false,null). If you resolved a user, add it as the last parameter in case the login attempt succeeded.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	forward Indicates if the request should be forwarded on to other actions.
ModulesServlet.HttpMethod	method Overwritten method.
javax.servlet.http.HttpServletRequest	request Overwritten request object.
boolean	responded Indicates if a reply has already been sent to the request.
javax.servlet.http.HttpServletResponse	response Overwritten response object.
User	user The user that's logged in.

Constructor Summary

Constructors

Constructor and Description
ForwardResult()
ForwardResult(boolean forward, boolean responded)
ForwardResult(boolean forward, boolean responded, User user)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

forward

public boolean forward

Indicates if the request should be forwarded on to other actions.

responded

public boolean responded

Indicates if a reply has already been sent to the request. For example, you could decide not to forward the request, and set forwarded=false, and then send a login page to give the user a chance to login. Thus you would set responded=true because you already sen a response. This will prevent an error message from being sent.

user

public User user

The user that's logged in. You should somehow resolve this from the authentication details in the request and then set the field. If authentication is not relevant, or the user failed to login, set to null.

request

public javax.servlet.http.HttpServletRequest request

Overwritten request object. If non-null, should use this as the request object when forwarding the request.

response

public javax.servlet.http.HttpServletResponse response

Overwritten response object. If non-null, should use this as the response object when forwarding the request.

method

public ModulesServlet.HttpMethod method

Overwritten method. If non-null, should use this as the method when forwarding the request.

Constructor Detail

ForwardResult

public ForwardResult()

ForwardResult

public ForwardResult(boolean forward,
                     boolean responded)

ForwardResult

public ForwardResult(boolean forward,
                     boolean responded,
                     User user)