com.communote.server.widgets

Class AbstractWidget

java.lang.Object

com.communote.server.widgets.AbstractWidget

All Implemented Interfaces:

Widget

Direct Known Subclasses:

AboutBlogWidget, AboutUserProfileWidget, AbstractMultipleResultWidget, AnnotatedSingleResultWidget, ClientPermissionsWidget, ContentTypeWidget, CreateNoteWidget, DeleteTopicWidget, EditTopicStructureWidget, EmptyWidget, FormWidget, GroupSettingsWidget, IpRangeWidget, LoggingWidget, MainPageHorizontalNavigationWidget, MessagesWidget, MultiViewTabWidget, SetAnonymousAccessWidget, TagManagementWidget, UserGroupAddMemberWidget, UserGroupDialogWidget, UserManagementUserOverviewWidget, UserProfileWidget

public abstract class AbstractWidget
extends Object
implements Widget

abstract implementation of the widget interface

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	METADATA_KEY_NO_CONTENT Key to be used in the response metadata to denote that a widget has no content.

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
AbstractWidget() The initParameters() method is invoked implicitly.

Method Summary

Modifier and Type	Method and Description
protected String	determineOutputType() Determine the output type based on the request
Object	getAttribute(String key) return widget attribute
boolean	getBooleanParameter(String key, boolean fallback) Get a parameter for a key and parse it to a boolean value
String	getGroupName() Get the group name to build the url based on it.
int	getIntParameter(String key) Get a parameter for a key and parse it to a int value
int	getIntParameter(String key, int fallback) Get a parameter for a key and parse it to a int value
Long[]	getLongArrayParameter(String parameterName) Get the value of the given parameter.
long	getLongParameter(String key) Get a parameter for a key and parse it to a long value
long	getLongParameter(String key, long fallback) Get a parameter for a key and parse it to a long value
String	getParameter(String key) return widget parameter
String	getParameter(String key, String fallback) return widget parameter
String	getParameterEscaped(String key) Return a parameter with all characters that are not in [A-Za-z0-9_.-] escaped with underscore.
String	getParameterEscaped(String key, String fallback) Like getParameterEscaped(String) but returns the provided fallback if the parameter is not set.
Map<String,String>	getParameters() Get the parameter list
protected javax.servlet.http.HttpServletRequest	getRequest() get the request for getting some more information
protected javax.servlet.http.HttpServletResponse	getResponse() The response object the widget is working on.
String	getResponseMetadata() Return a JSON object containing arbitrary metadata the server-side widget component wants to transmit to the client-side component as part of the current response.
String[]	getStringArrayParameter(String parameterName) Get the value of the given parameter.
String	getViewIdentifier() Get the view identifier which defines the view for rendering the widgets content
String	getWidgetId() Get the id of the current widget
protected abstract void	initParameters() abstract method hook that initializes the widget's parameters
boolean	isSuccess() Is true by default.
void	setAttribute(String key, Object value)
void	setGroupName(String path) Set the group name to build the url based on it.
void	setParameter(String key, String value) set widget parameter
void	setRequest(javax.servlet.http.HttpServletRequest request) set the http servlet request for this widget
void	setResponse(javax.servlet.http.HttpServletResponse response) set the http servlet response for this widget
protected void	setResponseMetadata(String key, Object value) Add, remove or replace an entry in the response metadata that should be returned when getResponseMetadata() is called.
protected void	setSuccess(boolean success) Set whether the widget request was successful.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.widgets.Widget

getTile, handleRequest

Field Detail

METADATA_KEY_NO_CONTENT

protected static final String METADATA_KEY_NO_CONTENT

Key to be used in the response metadata to denote that a widget has no content.

See Also:

Constant Field Values

Constructor Detail

AbstractWidget

public AbstractWidget()

The initParameters() method is invoked implicitly.

Method Detail

determineOutputType

protected String determineOutputType()

Determine the output type based on the request

Returns:

the output type (e.g. dhtml)

getAttribute

public Object getAttribute(String key)

return widget attribute

Specified by:

getAttribute in interface Widget

Parameters:

key - the parameter key

Returns:

the attribute value

getBooleanParameter

public boolean getBooleanParameter(String key,
                                   boolean fallback)

Get a parameter for a key and parse it to a boolean value

Parameters:

key - the key

fallback - the fall back to use in case of an NumberFormatException

Returns:

the parsed value

getGroupName

public String getGroupName()

Get the group name to build the url based on it.

Specified by:

getGroupName in interface Widget

Returns:

relative path in which package this controller can be found

getIntParameter

public int getIntParameter(String key)

Get a parameter for a key and parse it to a int value

Parameters:

key - the key

Returns:

the parsed value

getIntParameter

public int getIntParameter(String key,
                           int fallback)

Get a parameter for a key and parse it to a int value

Parameters:

key - the key

fallback - the fall back to use in case of an NumberFormatException

Returns:

the parsed value

getLongArrayParameter

public Long[] getLongArrayParameter(String parameterName)

Get the value of the given parameter. If it is not null split it by COMMA. Return the array. (null if the value of the parameter is null)

Parameters:

parameterName - the name of the parameter

Returns:

an array with the parameters splitted by comma, or null if the was parameter not set or did not contain any parseable long

getLongParameter

public long getLongParameter(String key)

Get a parameter for a key and parse it to a long value

Parameters:

key - the key

Returns:

the parsed value

getLongParameter

public long getLongParameter(String key,
                             long fallback)

Get a parameter for a key and parse it to a long value

Parameters:

key - the key

fallback - the fallback to use in case of an NumberFormatException

Returns:

the parsed value

getParameter

public String getParameter(String key)

return widget parameter

Specified by:

getParameter in interface Widget

Parameters:

key - the parameter key

Returns:

the parameter value

getParameter

public String getParameter(String key,
                           String fallback)

return widget parameter

Parameters:

key - the parameter key

fallback - the fallback if the parameter key doesn't exist

Returns:

the parameter value

getParameterEscaped

public String getParameterEscaped(String key)

Return a parameter with all characters that are not in [A-Za-z0-9_.-] escaped with underscore. Helps to avoid XSS when the parameter, which might have been manipulated, needs to be written out to the HTML so that it can be processed in Javascript code. The return value should be stored in a local variable when needed more than once.

Parameters:

key - the name of the parameter

Returns:

the escaped parameter value or null if not set

getParameterEscaped

public String getParameterEscaped(String key,
                                  String fallback)

Like getParameterEscaped(String) but returns the provided fallback if the parameter is not set. The fallback is processed by the escape function.

Parameters:

key - the name of the parameter to get

fallback - the fallback value if the parameter is not set

Returns:

the parameter value or the fallback

getParameters

public Map<String,String> getParameters()

Get the parameter list

Specified by:

getParameters in interface Widget

Returns:

Parameter map

getRequest

protected javax.servlet.http.HttpServletRequest getRequest()

get the request for getting some more information

Returns:

the requet for this widget

getResponse

protected javax.servlet.http.HttpServletResponse getResponse()

The response object the widget is working on. Can for instance be used to set some header values.

Returns:

the response object

getResponseMetadata

public String getResponseMetadata()

Description copied from interface: Widget

Return a JSON object containing arbitrary metadata the server-side widget component wants to transmit to the client-side component as part of the current response.

Specified by:

getResponseMetadata in interface Widget

Returns:

a string serialized JSON object or null if no metadata needs to be transmitted

getStringArrayParameter

public String[] getStringArrayParameter(String parameterName)

Get the value of the given parameter. If it is not null split it by BLANK. Return the array. (null if the value of the parameter is null)

Parameters:

parameterName - name of the parameter key

Returns:

an array with the parameters splitted by blank

getViewIdentifier

public String getViewIdentifier()

Get the view identifier which defines the view for rendering the widgets content

Specified by:

getViewIdentifier in interface Widget

Returns:

The tile to show

getWidgetId

public String getWidgetId()

Get the id of the current widget

Specified by:

getWidgetId in interface Widget

Returns:

the widget id

initParameters

protected abstract void initParameters()

abstract method hook that initializes the widget's parameters

isSuccess

public boolean isSuccess()

Is true by default.

Specified by:

isSuccess in interface Widget

Returns:

if the widget request was successful

setAttribute

public void setAttribute(String key,
                         Object value)

setGroupName

public void setGroupName(String path)

Set the group name to build the url based on it.

Specified by:

setGroupName in interface Widget

Parameters:

path - relative path in which package this controller can be found

setParameter

public void setParameter(String key,
                         String value)

set widget parameter

Specified by:

setParameter in interface Widget

Parameters:

key - the parameter key

value - the parameter value

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

set the http servlet request for this widget

Specified by:

setRequest in interface Widget

Parameters:

request - the request

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

set the http servlet response for this widget

Specified by:

setResponse in interface Widget

Parameters:

response - the response

setResponseMetadata

protected void setResponseMetadata(String key,
                                   Object value)

Add, remove or replace an entry in the response metadata that should be returned when getResponseMetadata() is called.

Parameters:

key - the key of the entry to modify

value - the value of the metadata entry, if null the entry with the provided key will be removed

setSuccess

protected void setSuccess(boolean success)

Set whether the widget request was successful.

Parameters:

success - true if the request succeeded