com.communote.plugins.api.rest.v30.resource

Class ResourceHandlerHelper

java.lang.Object

com.communote.plugins.api.rest.v30.resource.ResourceHandlerHelper

public class ResourceHandlerHelper
extends Object

The abstract ResourceHandler supplies general methods for REST-API used by the concrete resource handlers.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_ATTACHMENTS_SESSION_ID Name for the attachments attribute within the session .

Constructor Summary

Constructors

Constructor and Description
ResourceHandlerHelper()

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	generateMetaDataForPaging(Integer pageOffset, Integer pageMaxCount, int numberOfElements) Get meta data for paging
static Locale	getCurrentUserLocale(javax.ws.rs.core.Request request) Get the locale of the current user
static QueryParametersParameterNameProvider	getNameProvider(javax.ws.rs.core.Request request) Returns the name provider to use.
protected <T> String	getText(javax.ws.rs.core.Request request, String messageKey, Object... arguments) Get text of message key with consideration of locale and replace arguments
static Set<Long>	getUploadedAttachmentsFromSession(javax.ws.rs.core.Request request, String attribute) Returns a set with attachment IDs uploaded in the current session.
static ResourceHandlerHelper	instance()
static void	removeUploadedAttachmentsFromSession(javax.ws.rs.core.Request request, String attribute) Removes the attachment IDs set from the current session.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ATTACHMENTS_SESSION_ID

public static final String PARAM_ATTACHMENTS_SESSION_ID

Name for the attachments attribute within the session .

See Also:

Constant Field Values

Constructor Detail

ResourceHandlerHelper

public ResourceHandlerHelper()

Method Detail

generateMetaDataForPaging

public static Map<String,Object> generateMetaDataForPaging(Integer pageOffset,
                                                           Integer pageMaxCount,
                                                           int numberOfElements)

Get meta data for paging

Parameters:

pageOffset - offset of page

pageMaxCount - max cound of elements in page

numberOfElements - number of found elements

Returns:

map of metaData components for paging

getCurrentUserLocale

public static Locale getCurrentUserLocale(javax.ws.rs.core.Request request)

Get the locale of the current user

Parameters:

request - Request

Returns:

Locale

getNameProvider

public static QueryParametersParameterNameProvider getNameProvider(javax.ws.rs.core.Request request)

Returns the name provider to use.

Parameters:

request - The request

Returns:

The QueryParametersParameterNameProvider for this request, default is FilterRestApiParameterNameProvider.

getUploadedAttachmentsFromSession

public static Set<Long> getUploadedAttachmentsFromSession(javax.ws.rs.core.Request request,
                                                          String attribute)

Returns a set with attachment IDs uploaded in the current session. The list stored in the session is identified by the value of the request parameter PARAM_ATTACHMENTS_SESSION_ID. If the parameter is not provided null is returned. If the list is not yet in the session it will be put there.

Parameters:

request - Request

attribute - The attribute to use. If null, the attribute will be extracted from the request using PARAM_ATTACHMENTS_SESSION_ID

Returns:

the set with attachment IDs or null if the identifier is not one of the request parameters

instance

public static ResourceHandlerHelper instance()

Returns:

instance of the ResourceHandlerHalper

removeUploadedAttachmentsFromSession

public static void removeUploadedAttachmentsFromSession(javax.ws.rs.core.Request request,
                                                        String attribute)

Removes the attachment IDs set from the current session.

Parameters:

request - Request

attribute - The attribute to use. If null, the attribute will be extracted from the request using PARAM_ATTACHMENTS_SESSION_ID

getText

protected <T> String getText(javax.ws.rs.core.Request request,
                             String messageKey,
                             Object... arguments)

Get text of message key with consideration of locale and replace arguments

Type Parameters:

T - type of resource

Parameters:

request - Request

messageKey - key of message

arguments - elements witch should replace in message text

Returns:

text of messageKey