com.communote.plugins.api.rest.v24.resource

Class DefaultResourceHandler<C,E,D,G,L>

java.lang.Object

com.communote.plugins.api.rest.v24.resource.AbstractResourceHandler<C,E,D,G,L>

com.communote.plugins.api.rest.v24.resource.DefaultResourceHandler<C,E,D,G,L>

Type Parameters:

C - create resource parameter

E - edit resource parameter

D - delete resource parameter

G - get resource parameter

L - list resource parameter

Direct Known Subclasses:

AttachmentResourceHandler, ExternalObjectResourceHandler, FavoriteResourceHandler, FollowResourceHandler, FollowResourceHandler, ImageResourceHandler, LikeResourceHandler, NoteResourceHandler, PreviewResourceHandler, PropertyResourceHandler, PropertyResourceHandler, PropertyResourceHandler, RightResourceHandler, RoleBulkExternalResourceHandler, RoleExternalResourceHandler, RoleResourceHandler, TagResourceHandler, TagStoreTagListResourceHandler, TagStoreTagResourceHandler, TagSuggestionListResourceHandler, TimelineNoteResourceHandler, TimelineTagResourceHandler, TimelineTopicResourceHandler, TimelineUserResourceHandler, TopicResourceHandler, UserPreferenceResourceHandler, UserResourceHandler

public abstract class DefaultResourceHandler<C,E,D,G,L>
extends AbstractResourceHandler<C,E,D,G,L>

Default implementation of AbstractResourceHandler. If a concrete handler inherits from this class, only the relevant methods should be overridden, and default validator is supplied.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DefaultResourceHandler() Default constructor, setting a DefaultValidator
DefaultResourceHandler(Validator<C,E,D,G,L> validator) Constructor for using a specific validator

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	handleCreateInternally(C createParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource creation
protected javax.ws.rs.core.Response	handleDeleteInternally(D deleteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource removal
protected javax.ws.rs.core.Response	handleEditInternally(E editParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request)
protected javax.ws.rs.core.Response	handleGetInternally(G getParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource querying
protected javax.ws.rs.core.Response	handleListInternally(L listParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource querying

Methods inherited from class com.communote.plugins.api.rest.v24.resource.AbstractResourceHandler

handleCreate, handleDelete, handleEdit, handleGet, handleList, setValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceHandler

public DefaultResourceHandler()

Default constructor, setting a DefaultValidator

DefaultResourceHandler

public DefaultResourceHandler(Validator<C,E,D,G,L> validator)

Constructor for using a specific validator

Parameters:

validator - the validator to use

Method Detail

handleCreateInternally

protected javax.ws.rs.core.Response handleCreateInternally(C createParameter,
                                                           String requestedMimeType,
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String requestSessionId,
                                                           javax.ws.rs.core.Request request)
                                                    throws Exception

hook method, which should be implemented by subclasses, in order to perform actual resource creation

Specified by:

handleCreateInternally in class AbstractResourceHandler<C,E,D,G,L>

Parameters:

createParameter - create parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleDeleteInternally

protected javax.ws.rs.core.Response handleDeleteInternally(D deleteParameter,
                                                           String requestedMimeType,
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String requestSessionId,
                                                           javax.ws.rs.core.Request request)
                                                    throws Exception

hook method, which should be implemented by subclasses, in order to perform actual resource removal

Specified by:

handleDeleteInternally in class AbstractResourceHandler<C,E,D,G,L>

Parameters:

deleteParameter - delete parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleEditInternally

protected javax.ws.rs.core.Response handleEditInternally(E editParameter,
                                                         String requestedMimeType,
                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                         String requestSessionId,
                                                         javax.ws.rs.core.Request request)
                                                  throws Exception

Specified by:

handleEditInternally in class AbstractResourceHandler<C,E,D,G,L>

Parameters:

editParameter - edit parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleGetInternally

protected javax.ws.rs.core.Response handleGetInternally(G getParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws Exception

hook method, which should be implemented by subclasses, in order to perform actual resource querying

Specified by:

handleGetInternally in class AbstractResourceHandler<C,E,D,G,L>

Parameters:

getParameter - get parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleListInternally

protected javax.ws.rs.core.Response handleListInternally(L listParameter,
                                                         String requestedMimeType,
                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                         String requestSessionId,
                                                         javax.ws.rs.core.Request request)
                                                  throws Exception

hook method, which should be implemented by subclasses, in order to perform actual resource querying

Specified by:

handleListInternally in class AbstractResourceHandler<C,E,D,G,L>

Parameters:

listParameter - get list parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong