magoffin.matt.ma2.web
Class AbstractCommandController

java.lang.Object
  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.context.support.WebApplicationObjectSupport
          extended by org.springframework.web.servlet.support.WebContentGenerator
              extended by org.springframework.web.servlet.mvc.AbstractController
                  extended by org.springframework.web.servlet.mvc.BaseCommandController
                      extended by org.springframework.web.servlet.mvc.AbstractCommandController
                          extended by magoffin.matt.ma2.web.AbstractCommandController
All Implemented Interfaces:
org.springframework.context.ApplicationContextAware, org.springframework.web.servlet.mvc.Controller
Direct Known Subclasses:
AddToAlbumController, AlbumFeedController, BrowseAlbumsController, DeleteAlbumController, DeleteCollectionController, DeleteMediaController, DeleteThemeController, DownloadThemeController, DynamicThemeResourceController, HelpController, HomeController, JobInfoController, MediaItemInfoController, MediaItemRatingController, MediaItemsController, MediaServerController, NewAlbumController, NewCollectionController, RegisterConfirmController, ReindexController, RemoveFromAlbumController, SaveMediaItemInfoController, SearchMediaItemsController, SetAlbumParentController, SetAlbumPosterController, ShadowServerController, ShareAlbumController, ThemeResourceController, ThemesController, UserIndexController, UserResourceController, UsersController, ViewAlbumController

public abstract class AbstractCommandController
extends org.springframework.web.servlet.mvc.AbstractCommandController

Abstract base class for command controllers.

The configurable properties of this class are:

cancelView
The name of the view to go to if the form is canceled.
domainObjectFactory
The DomainObjectFactory implementation to use for creating instances of our domain objects.
messagesSource
A MessagesSource instance.
successView
The name of the view to go to if the form is completed successfully.
systemBiz
An implementation of SystemBiz to use.
webHelper
A WebHelper instance.

Version:
$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $
Author:
Matt Magoffin (spamsqr@msqr.us)

Field Summary
static java.lang.String HTTP_USER_AGENT_HEADER
          The HTTP User-Agent header.
 
Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController
DEFAULT_COMMAND_NAME
 
Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator
HEADER_CACHE_CONTROL, HEADER_EXPIRES, HEADER_PRAGMA, METHOD_GET, METHOD_HEAD, METHOD_POST
 
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
 
Constructor Summary
AbstractCommandController()
          Default constructor.
 
Method Summary
 DomainObjectFactory getDomainObjectFactory()
           
 java.lang.String getErrorView()
           
 magoffin.matt.xweb.util.MessagesSource getMessagesSource()
           
 java.lang.String getSuccessView()
           
 SystemBiz getSystemBiz()
           
 WebHelper getWebHelper()
           
protected  void initApplicationContext()
           
protected  void registerCalendarEditor(org.springframework.web.bind.ServletRequestDataBinder binder, BizContext context, magoffin.matt.util.ThreadSafeDateFormat format, java.util.TimeZone zone)
          Register a CalendarEditor property editor for Calendar bean properties.
 void setDomainObjectFactory(DomainObjectFactory domainObjectFactory)
           
 void setErrorView(java.lang.String errorView)
           
 void setMessagesSource(magoffin.matt.xweb.util.MessagesSource messagesSource)
           
 void setSuccessView(java.lang.String successView)
           
 void setSystemBiz(SystemBiz systemBiz)
           
 void setWebHelper(WebHelper webHelper)
           
 
Methods inherited from class org.springframework.web.servlet.mvc.AbstractCommandController
handle, handleRequestInternal
 
Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController
bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommand, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, suppressBinding, suppressValidation
 
Methods inherited from class org.springframework.web.servlet.mvc.AbstractController
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession
 
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader
 
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, isContextRequired
 
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTTP_USER_AGENT_HEADER

public static final java.lang.String HTTP_USER_AGENT_HEADER
The HTTP User-Agent header.

See Also:
Constant Field Values
Constructor Detail

AbstractCommandController

public AbstractCommandController()
Default constructor.

Method Detail

initApplicationContext

protected void initApplicationContext()
Overrides:
initApplicationContext in class org.springframework.web.servlet.mvc.BaseCommandController

registerCalendarEditor

protected void registerCalendarEditor(org.springframework.web.bind.ServletRequestDataBinder binder,
                                      BizContext context,
                                      magoffin.matt.util.ThreadSafeDateFormat format,
                                      java.util.TimeZone zone)
Register a CalendarEditor property editor for Calendar bean properties.

Parameters:
binder - the binder
context - the current context, or null to not use User's time zone
format - the date format to use
zone - the time zone to use, or null for default

getDomainObjectFactory

public DomainObjectFactory getDomainObjectFactory()
Returns:
Returns the domainObjectFactory.

setDomainObjectFactory

public void setDomainObjectFactory(DomainObjectFactory domainObjectFactory)
Parameters:
domainObjectFactory - The domainObjectFactory to set.

getErrorView

public java.lang.String getErrorView()
Returns:
Returns the errorView.

setErrorView

public void setErrorView(java.lang.String errorView)
Parameters:
errorView - The errorView to set.

getMessagesSource

public magoffin.matt.xweb.util.MessagesSource getMessagesSource()
Returns:
Returns the messagesSource.

setMessagesSource

public void setMessagesSource(magoffin.matt.xweb.util.MessagesSource messagesSource)
Parameters:
messagesSource - The messagesSource to set.

getSuccessView

public java.lang.String getSuccessView()
Returns:
Returns the successView.

setSuccessView

public void setSuccessView(java.lang.String successView)
Parameters:
successView - The successView to set.

getWebHelper

public WebHelper getWebHelper()
Returns:
Returns the webHelper.

setWebHelper

public void setWebHelper(WebHelper webHelper)
Parameters:
webHelper - The webHelper to set.

getSystemBiz

public SystemBiz getSystemBiz()
Returns:
Returns the systemBiz.

setSystemBiz

public void setSystemBiz(SystemBiz systemBiz)
Parameters:
systemBiz - The systemBiz to set.