com.veriplace.web.servlet
Class ServletStatusViewRenderer

java.lang.Object
  com.veriplace.web.views.AbstractStatusViewRenderer
      com.veriplace.web.servlet.ServletStatusViewRenderer

All Implemented Interfaces:

StatusViewRenderer

public class ServletStatusViewRenderer
extends AbstractStatusViewRenderer

Subclass of AbstractStatusViewRenderer for use with servlet applications. Given a view name, this class renders the view by passing the name to the RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse) method of the current request dispatcher. It also prepends and appends an optional prefix and suffix to the view name; see setViewPrefix(String) and setViewSuffix(String).

Field Summary

Fields inherited from class com.veriplace.web.views.AbstractStatusViewRenderer

callbackAttributeName, DEFAULT_ERROR_KEY, ERROR_KEY_PREFIX, stateAttributeName, WAITING_KEY

Constructor Summary

ServletStatusViewRenderer()

Method Summary

java.lang.String	getViewPrefix() See setViewPrefix(String).
java.lang.String	getViewSuffix() See setViewSuffix(String).
boolean	renderViewInternal(HttpServletRequest request, HttpServletResponse response, VeriplaceState state, java.lang.String viewName) Override this method to implement displaying a page based on a view name.
void	setViewPrefix(java.lang.String viewPrefix) Sets the prefix to prepend to every view name before passing it to the request dispatcher.
void	setViewSuffix(java.lang.String viewSuffix) Sets the suffix to append to every view name before passing it to the request dispatcher.

Methods inherited from class com.veriplace.web.views.AbstractStatusViewRenderer

canRenderWaitingView, getCallbackAttributeName, getDefaultErrorViewName, getErrorViewName, getStateAttributeName, getViewMap, getWaitingViewName, matchExceptionClass, renderErrorView, renderWaitingView, setCallbackAttributeName, setDefaultErrorViewName, setErrorViewName, setStateAttributeName, setViewMap, setWaitingViewName

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletStatusViewRenderer

public ServletStatusViewRenderer()

Method Detail

getViewPrefix

public java.lang.String getViewPrefix()

See setViewPrefix(String).

setViewPrefix

public void setViewPrefix(java.lang.String viewPrefix)

Sets the prefix to prepend to every view name before passing it to the request dispatcher. The default is "/WEB-INF/jsp/".

getViewSuffix

public java.lang.String getViewSuffix()

See setViewSuffix(String).

setViewSuffix

public void setViewSuffix(java.lang.String viewSuffix)

Sets the suffix to append to every view name before passing it to the request dispatcher. The default is ".jsp".

renderViewInternal

public boolean renderViewInternal(HttpServletRequest request,
                                  HttpServletResponse response,
                                  VeriplaceState state,
                                  java.lang.String viewName)
                           throws StatusViewException,
                                  ServletException

Description copied from class: AbstractStatusViewRenderer

Override this method to implement displaying a page based on a view name. Standard implementations of this for generic servlets and Spring are provided by ServletStatusViewRenderer and SpringStatusViewRenderer.

Specified by:

renderViewInternal in class AbstractStatusViewRenderer

Parameters:

request - the current HttpServletRequest

response - the current HttpServletResponse

state - the current VeriplaceState

viewName - name of the view to display

Throws:

StatusViewException - for any error that prevents the page from being displayed

ServletException