org.jasig.portlet.cms.mvc.portlet

Class ConfigureContentController

java.lang.Object

org.jasig.portlet.cms.mvc.portlet.ConfigureContentController

@Controller
 @RequestMapping(value="CONFIG")
public class ConfigureContentController
extends Object

ConfigureContentController allows administrative users to set the content to be displayed by the portlet. This controller is responsible for performing any required content validation, removing any unwanted or dangerous tags and attributes from the configured HTML, and persisting it to the configured content store.

Version:

$Revision$

Author:

Jen Bourey, jbourey@unicon.net

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
ConfigureContentController()

Method Summary

Modifier and Type	Method and Description
void	cancelUpdate(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) Cancel any pending portlet configuration edits and exit configuration mode.
ContentForm	getForm(javax.portlet.PortletRequest request) Get the form object for the portlet configuration.
HashMap<String,String>	getLocales(javax.portlet.PortletRequest request) Get the list of supported locales to populate the drop-down list with.
org.springframework.web.servlet.ModelAndView	getPreview(String content)
boolean	isCleanContent(javax.portlet.PortletRequest request) Adds clean content attribute to the model.
void	setContentDao(IContentDao contentDao)
void	setStringCleaningService(IStringCleaningService cleaningService)
String	showContentForm() Show the main configuration view.
void	updateConfiguration(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, ContentForm form) Update the portlet's configuration according to the submitted form object.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

ConfigureContentController

public ConfigureContentController()

Method Detail

setContentDao

@Autowired
public void setContentDao(IContentDao contentDao)

setStringCleaningService

@Autowired
public void setStringCleaningService(IStringCleaningService cleaningService)

showContentForm

@RequestMapping
public String showContentForm()

Show the main configuration view.

Returns:

main configuration view

updateConfiguration

@RequestMapping(params="action=updateConfiguration")
public void updateConfiguration(javax.portlet.ActionRequest request,
                                                                                     javax.portlet.ActionResponse response,
                                                                                     @ModelAttribute(value="form")
                                                                                     ContentForm form)
                                                                              throws javax.portlet.PortletModeException

Update the portlet's configuration according to the submitted form object.

Parameters:

request - ActionRequest

response - ActionResponse

form - configuration form

Throws:

javax.portlet.PortletModeException - exception

cancelUpdate

@RequestMapping(params="action=cancelUpdate")
public void cancelUpdate(javax.portlet.ActionRequest request,
                                                                       javax.portlet.ActionResponse response)
                                                                throws javax.portlet.PortletModeException

Cancel any pending portlet configuration edits and exit configuration mode.

Parameters:

request - ActionRequest

response - ActionResponse

Throws:

javax.portlet.PortletModeException - exception

getPreview

@ResourceMapping(value="preview")
public org.springframework.web.servlet.ModelAndView getPreview(@RequestParam(value="content")
                                                                                                 String content)

getForm

@ModelAttribute(value="form")
public ContentForm getForm(javax.portlet.PortletRequest request)

Get the form object for the portlet configuration. If this portlet has already been configured with content, the current HTML will be pre-populated into the form object. If this is a new portlet, the initial content will be an empty string.

Parameters:

request - PortletRequest

Returns:

form object for the portlet configuration

isCleanContent

@ModelAttribute(value="cleanContent")
public boolean isCleanContent(javax.portlet.PortletRequest request)

Adds clean content attribute to the model.

Parameters:

request - PortletRequest

Returns:

true if the clean content portlet preference is set

getLocales

public HashMap<String,String> getLocales(javax.portlet.PortletRequest request)

Get the list of supported locales to populate the drop-down list with.

Parameters:

request - PortletRequest

Returns:

list of supported locals