com.communote.plugins.embed

Class EmbedController

java.lang.Object

com.communote.plugins.core.views.ViewController

com.communote.plugins.embed.EmbedController

All Implemented Interfaces:

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

public class EmbedController
extends ViewController
implements org.springframework.web.servlet.mvc.Controller

Controller to embed Communote elsewhere

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_FIELD_CONTEXT_ID
static String	MODEL_FIELD_ED_PREDEFINED_PROPERTIES
static String	MODEL_FIELD_UNRESETABLE_FILTER_PARAMETERS
static String	PROPERTY_EMBED_ADDITIONAL_CSS_URL
protected static String	URL

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

DEFAULT_MAIN_TEMPLATE, DEFAULT_MAIN_TEMPLATE_ADMINISTRATION

Constructor Summary

Constructors

Constructor and Description
EmbedController(org.osgi.framework.BundleContext bundleContext)

Method Summary

Modifier and Type	Method and Description
static void	addEdPredefinedNoteProperty(org.springframework.web.servlet.ModelAndView mav, String keyGroup, String key, String value) Add a note property to to the properties which should be passed to the editor.
static Object	createNotePropertyFilter(String keyGroup, String key, String value, PropertyFilter.MatchMode matchMode, boolean negate)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles GET requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> model) Handles POST requests.
String	getContentTemplate()
String	getMainTemplate() The key for the main template.
QueryParametersParameterNameProvider	getNameProvider()
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.
void	registerProcessor(EmbedControllerRequestPostProcessor processor) Add a processor to be invoked before rendering the view
void	start()
void	stop()
void	unregisterProcessor(EmbedControllerRequestPostProcessor processor) Remove a previously added processor

Methods inherited from class com.communote.plugins.core.views.ViewController

doDelete, doHead, doPut, doUnknown, getSymbolicName

Methods inherited from class java.lang.Object

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

Field Detail

URL

protected static final String URL

See Also:

Constant Field Values

MODEL_FIELD_UNRESETABLE_FILTER_PARAMETERS

public static final String MODEL_FIELD_UNRESETABLE_FILTER_PARAMETERS

See Also:

Constant Field Values

MODEL_FIELD_CONTEXT_ID

public static final String MODEL_FIELD_CONTEXT_ID

See Also:

Constant Field Values

MODEL_FIELD_ED_PREDEFINED_PROPERTIES

public static final String MODEL_FIELD_ED_PREDEFINED_PROPERTIES

See Also:

Constant Field Values

PROPERTY_EMBED_ADDITIONAL_CSS_URL

public static final String PROPERTY_EMBED_ADDITIONAL_CSS_URL

See Also:

Constant Field Values

Constructor Detail

EmbedController

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

Parameters:

bundleContext - The current bundle context.

Method Detail

addEdPredefinedNoteProperty

public static void addEdPredefinedNoteProperty(org.springframework.web.servlet.ModelAndView mav,
                                               String keyGroup,
                                               String key,
                                               String value)

Add a note property to to the properties which should be passed to the editor.

Parameters:

mav - the model and view

keyGroup - the group of the property

key - the key of the property

value - the value

createNotePropertyFilter

public static Object createNotePropertyFilter(String keyGroup,
                                              String key,
                                              String value,
                                              PropertyFilter.MatchMode matchMode,
                                              boolean negate)

doGet

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

Description copied from class: ViewController

Handles GET requests.

Overrides:

doGet in class ViewController

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

Description copied from class: ViewController

Handles POST requests.

Overrides:

doPost in class ViewController

Parameters:

request - The request.

response - The response.

model - The model.

Throws:

ViewControllerException - Exception.

getContentTemplate

public String getContentTemplate()

Specified by:

getContentTemplate in interface PluginViewController

Specified by:

getContentTemplate in class ViewController

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

Overrides:

getMainTemplate in class ViewController

Returns:

PluginViewController.DEFAULT_MAIN_TEMPLATE

getNameProvider

public QueryParametersParameterNameProvider getNameProvider()

handleRequest

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

Description copied from class: ViewController

Specified by:

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

Overrides:

handleRequest in class ViewController

Throws:

Exception

processRequest

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

Description copied from class: ViewController

Processes the request and returns a map with additional content.

Overrides:

processRequest in class ViewController

Parameters:

request - The request.

response - The response.

Returns:

Map with additional content.

Throws:

ViewControllerException - Exception.

registerProcessor

public void registerProcessor(EmbedControllerRequestPostProcessor processor)

Add a processor to be invoked before rendering the view

Parameters:

processor - the processor to add

start

public void start()

stop

public void stop()

unregisterProcessor

public void unregisterProcessor(EmbedControllerRequestPostProcessor processor)

Remove a previously added processor

Parameters:

processor - the processor to remove