com.communote.plugins.core.views

Class ViewController

java.lang.Object

com.communote.plugins.core.views.ViewController

All Implemented Interfaces:

PluginViewController, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

AdministrationViewController, BookmarkletController, EmbedController, EmbedMessengerController, WidgetViewController

public abstract class ViewController
extends Object
implements org.springframework.web.servlet.mvc.Controller, PluginViewController

Wrapper for controllers. Subclasses must override one of the do HTTP_METHOD methods or the handleRequest for something to happen.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from interface com.communote.plugins.core.views.PluginViewController

DEFAULT_MAIN_TEMPLATE, DEFAULT_MAIN_TEMPLATE_ADMINISTRATION

Constructor Summary

Constructors

Constructor and Description
ViewController(org.osgi.framework.BundleContext bundleContext) Constructor.
ViewController(String symbolicName) Constructor.

Method Summary

Modifier and Type	Method and Description
void	doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles DELETE requests.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles GET requests.
void	doHead(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles HEAD requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles POST requests.
void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles PUT requests.
void	doUnknown(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles UNKNOWN requests.
abstract String	getContentTemplate()
String	getMainTemplate() The key for the main template.
String	getSymbolicName()
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Map<String,? extends Object>	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes the request and returns a map with additional content.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewController

public ViewController(org.osgi.framework.BundleContext bundleContext)

Constructor.

Parameters:

bundleContext - The bundles context.

ViewController

public ViewController(String symbolicName)

Constructor.

Parameters:

symbolicName - The symbolic name of the bundle the controller is in.

Method Detail

doDelete

public void doDelete(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     Map<String,Object> model)
              throws ViewControllerException

Handles DELETE requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  Map<String,Object> model)
           throws ViewControllerException

Handles GET requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

doHead

public void doHead(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Map<String,Object> model)
            throws ViewControllerException

Handles HEAD requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Map<String,Object> model)
            throws ViewControllerException

Handles POST requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

doPut

public void doPut(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  Map<String,Object> model)
           throws ViewControllerException

Handles PUT requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

doUnknown

public void doUnknown(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      Map<String,Object> model)
               throws ViewControllerException

Handles UNKNOWN requests.

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

getContentTemplate

public abstract String getContentTemplate()

Specified by:

getContentTemplate in interface PluginViewController

Returns:

Path to Velocity template for the content.

getMainTemplate

public String getMainTemplate()

Description copied from interface: PluginViewController

The key for the main template.

Specified by:

getMainTemplate in interface PluginViewController

Returns:

PluginViewController.DEFAULT_MAIN_TEMPLATE

getSymbolicName

public String getSymbolicName()

Specified by:

getSymbolicName in interface PluginViewController

Returns:

the symbolicName

handleRequest

public org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                           throws Exception

Specified by:

handleRequest in interface org.springframework.web.servlet.mvc.Controller

Throws:

Exception

processRequest

public Map<String,? extends Object> processRequest(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
                                            throws ViewControllerException

Processes the request and returns a map with additional content.

Parameters:

request - The request.

response - The response.

Returns:

Map with additional content.

Throws:

ViewControllerException - Exception.