oracle.cabo.servlet.util
Class JspPageBroker
java.lang.Object
|
+--oracle.cabo.servlet.AbstractPageBroker
|
+--oracle.cabo.servlet.util.JspPageBroker
- All Implemented Interfaces:
- PageBroker
- public class JspPageBroker
- extends AbstractPageBroker
Implementation of PageBroker that forwards all requests to JSPs. This PageBroker does very little for you; for instance, it provides no integration with UIX. Developers that need to integrate JSPs with UIX should use UIXPageBroker and explicitly register JspPageDescriptions.
JspPageBroker uses the following servlet configuration parameters:
oracle.cabo.servlet.JspBaseURL
: The name of the root URL where the JSPs will be stored. Defaults to "/".
- See Also:
JspPageDescription
Method Summary |
java.lang.String |
getBaseJspURL()
Returns the root URL where JSPs will be stored. |
protected java.lang.String |
getJspName(java.lang.String pageName)
A hook for converting a Page object into a JSP name. |
protected PageRenderer |
getPageRenderer(BajaContext context, Page page)
Returns the renderer that should be used for the specified page. |
void |
init(javax.servlet.Servlet servlet, javax.servlet.ServletConfig config)
Initializes the page broker. |
void |
registerPageDescription(java.lang.String pageName, EventHandler eventHandler)
Registers a page description; the renderer will automatically use a JSP. |
void |
setBaseJspURL(java.lang.String jspBaseURL)
Sets the root URL where Jsps will be stored. |
Methods inherited from class oracle.cabo.servlet.AbstractPageBroker |
addUIXRequestListener, decodeMultipartRequest, destroy, doUploadFile, getApplicationConfiguration, getDefaultPage, getErrorPage, getErrorPage, getEventError, getEventHandler, getFileUploadManager, getPageDescription, getPageEvent, getPageFlowEngine, getService, getServlet, handleRequest, isCacheable, isEmbedded, registerGlobalEventHandler, registerPageDescription, registerPageDescription, removeUIXRequestListener, renderError, renderPage, requestEnded, requestStarted, resetGlobalEventHandlers, resetPageDescriptions, setDefaultPage, setEmbedded, setErrorPage, setFileUploadManager, setPageFlowEngine, setResponseHeaders, shouldHandleUploadFile, unregisterGlobalEventHandler, unregisterPageDescription |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JspPageBroker
public JspPageBroker()
- Creates a JspPageBroker.
getBaseJspURL
public java.lang.String getBaseJspURL()
- Returns the root URL where JSPs will be stored. Defaults to "/*.
registerPageDescription
public void registerPageDescription(java.lang.String pageName,
EventHandler eventHandler)
- Registers a page description; the renderer will automatically use a JSP.
-
- Parameters:
pageName
- the name of the page
eventHandler
- an event handler
setBaseJspURL
public void setBaseJspURL(java.lang.String jspBaseURL)
- Sets the root URL where Jsps will be stored. Defaults to "/".
getPageRenderer
protected PageRenderer getPageRenderer(BajaContext context,
Page page)
- Returns the renderer that should be used for the specified page. The default implementation uses the page name to look for a registered event hander.
-
- Overrides:
getPageRenderer
in class AbstractPageBroker
init
public void init(javax.servlet.Servlet servlet,
javax.servlet.ServletConfig config)
throws javax.servlet.ServletException
- Initializes the page broker. Subclasses must call
super.init(servlet, config)
if they override this method.
-
- Overrides:
init
in class AbstractPageBroker
getJspName
protected java.lang.String getJspName(java.lang.String pageName)
- A hook for converting a Page object into a JSP name. The default implementation takes the JSP base URL, adds the page name, and appends ".jsp", ignoring any page properties.