com.waveset.ui
Class PageRouter

java.lang.Object
  extended bycom.waveset.util.AbstractXmlObject
      extended bycom.waveset.ui.PageRouter
All Implemented Interfaces:
javax.naming.Referenceable, XmlObject

public class PageRouter
extends AbstractXmlObject

This is a simple utility class to store the current "woring page" that then wants to call other pages and have them return to this page when done. This can evolve into a stack-based page routing system, where the current page's requested values get pushed onto a stack and then when a return page is needed it is popped. I am not sure how to handle the user using links directly and ending up with pushed pages that are never popped. Needs more thought, but I am putting the hooks in for when that insight hits...


Field Summary
static java.lang.String code_id
           
static java.lang.String ELEMENT
           
static java.lang.String ERROR_RETURN_URL_WRAPPER
           
static java.lang.String RETURN_URL_WRAPPER
           
static java.lang.String ROUTE_ADMIN_EDIT
           
static java.lang.String ROUTE_CALL_TIMER
           
static java.lang.String ROUTE_EVENT_DETAILS
           
static java.lang.String ROUTE_LOAD_TASK_EXTENDED_RESULTS
           
static java.lang.String ROUTE_MBEAN_INFO
           
static java.lang.String ROUTE_RESOURCE_EDIT
           
static java.lang.String ROUTE_ROLE_EDIT
           
static java.lang.String ROUTE_SHOW_TRACE
           
static java.lang.String ROUTE_TASK_LAUNCH
           
static java.lang.String ROUTE_USER_EDIT
           
static java.lang.String ROUTE_USER_FIND
           
 
Fields inherited from class com.waveset.util.AbstractXmlObject
_trace
 
Constructor Summary
PageRouter(javax.servlet.http.HttpSession session, java.lang.String currentURL, java.lang.String routeName)
          Basic constructor used when retrieving a route.
PageRouter(javax.servlet.jsp.PageContext pc, java.lang.String currentURL, java.lang.String routeName)
           
PageRouter(javax.servlet.jsp.PageContext pc, java.lang.String currentURL, java.lang.String routeName, java.lang.String returnURL, java.lang.String errorReturnURL)
          Basic constructor when setting up a route
 
Method Summary
 java.lang.String getElementName()
          Return our XML element name, required by XmlObject.
 java.lang.String getErrorReturnURL(java.lang.String defaultURL)
           
 java.lang.String getReturnURL(java.lang.String defaultURL)
           
protected  void parseXml(java.lang.String xml)
          A concrete subclass can implement the required constructor that takes a single String (containing XML) simply by invoking this method.
 java.lang.String popErrorReturnURL(java.lang.String defaultURL)
           
 java.lang.String popReturnURL(java.lang.String defaultURL)
          Return the URL and clear the session storage
 void setErrorReturnURL(java.lang.String inURL)
           
 void setReturnURL(java.lang.String inURL)
          set the passed-in URL as the page to return to when requested.
 void toXml(java.lang.StringBuffer b, int indent)
          Serialize the object to an XML buffer.
 
Methods inherited from class com.waveset.util.AbstractXmlObject
addXmlHeader, cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml, toXml, toXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

ROUTE_USER_EDIT

public static final java.lang.String ROUTE_USER_EDIT
See Also:
Constant Field Values

ROUTE_USER_FIND

public static final java.lang.String ROUTE_USER_FIND
See Also:
Constant Field Values

ROUTE_ADMIN_EDIT

public static final java.lang.String ROUTE_ADMIN_EDIT
See Also:
Constant Field Values

ROUTE_ROLE_EDIT

public static final java.lang.String ROUTE_ROLE_EDIT
See Also:
Constant Field Values

ROUTE_EVENT_DETAILS

public static final java.lang.String ROUTE_EVENT_DETAILS
See Also:
Constant Field Values

ROUTE_TASK_LAUNCH

public static final java.lang.String ROUTE_TASK_LAUNCH
See Also:
Constant Field Values

ROUTE_SHOW_TRACE

public static final java.lang.String ROUTE_SHOW_TRACE
See Also:
Constant Field Values

ROUTE_CALL_TIMER

public static final java.lang.String ROUTE_CALL_TIMER
See Also:
Constant Field Values

ROUTE_RESOURCE_EDIT

public static final java.lang.String ROUTE_RESOURCE_EDIT
See Also:
Constant Field Values

ROUTE_LOAD_TASK_EXTENDED_RESULTS

public static final java.lang.String ROUTE_LOAD_TASK_EXTENDED_RESULTS
See Also:
Constant Field Values

ROUTE_MBEAN_INFO

public static final java.lang.String ROUTE_MBEAN_INFO
See Also:
Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT
See Also:
Constant Field Values

RETURN_URL_WRAPPER

public static final java.lang.String RETURN_URL_WRAPPER
See Also:
Constant Field Values

ERROR_RETURN_URL_WRAPPER

public static final java.lang.String ERROR_RETURN_URL_WRAPPER
See Also:
Constant Field Values
Constructor Detail

PageRouter

public PageRouter(javax.servlet.http.HttpSession session,
                  java.lang.String currentURL,
                  java.lang.String routeName)
           throws WavesetException
Basic constructor used when retrieving a route.


PageRouter

public PageRouter(javax.servlet.jsp.PageContext pc,
                  java.lang.String currentURL,
                  java.lang.String routeName)
           throws WavesetException

PageRouter

public PageRouter(javax.servlet.jsp.PageContext pc,
                  java.lang.String currentURL,
                  java.lang.String routeName,
                  java.lang.String returnURL,
                  java.lang.String errorReturnURL)
Basic constructor when setting up a route

Parameters:
currentURL - is the page that constructs this object (could be pulled from the PageContext but this allows cheating and PageForward to work
routeName - the work area that this is being stored for (user management is the only current one)
returnURL - the place to come back to
errorReturnURL - the place to come back to if an error happens
Method Detail

getElementName

public java.lang.String getElementName()
Return our XML element name, required by XmlObject.

Specified by:
getElementName in interface XmlObject
Specified by:
getElementName in class AbstractXmlObject

setReturnURL

public void setReturnURL(java.lang.String inURL)
set the passed-in URL as the page to return to when requested.


setErrorReturnURL

public void setErrorReturnURL(java.lang.String inURL)

getReturnURL

public java.lang.String getReturnURL(java.lang.String defaultURL)

getErrorReturnURL

public java.lang.String getErrorReturnURL(java.lang.String defaultURL)

popReturnURL

public java.lang.String popReturnURL(java.lang.String defaultURL)
Return the URL and clear the session storage


popErrorReturnURL

public java.lang.String popErrorReturnURL(java.lang.String defaultURL)

toXml

public void toXml(java.lang.StringBuffer b,
                  int indent)
Serialize the object to an XML buffer.

Specified by:
toXml in interface XmlObject
Specified by:
toXml in class AbstractXmlObject

parseXml

protected void parseXml(java.lang.String xml)
                 throws WavesetException
A concrete subclass can implement the required constructor that takes a single String (containing XML) simply by invoking this method.

Throws:
WavesetException