com.communote.plugins.api.rest.resource

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

java.lang.Object

com.communote.plugins.api.rest.resource.AbstractResourceHandler<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:

DefaultResourceHandler

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

A handler of a a REST API resource. The handler performs invocation to the supplied validator on each handling method. In the case no exceptions occurred the internal handling method (which should be implemented by subclasses) is invoked. A validator MUST be set (through setValidator method) during the concrete resource handler construction

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractResourceHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	handleCreate(C createParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) handles creation process
protected abstract 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
javax.ws.rs.core.Response	handleDelete(D deleteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) handles deleting process
protected abstract 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
javax.ws.rs.core.Response	handleEdit(E editParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request)
protected abstract javax.ws.rs.core.Response	handleEditInternally(E editParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request)
javax.ws.rs.core.Response	handleGet(G getParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) handles resource querying
protected abstract 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
javax.ws.rs.core.Response	handleList(L listParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) handles querying of the resource list
protected abstract 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
void	setValidator(Validator<C,E,D,G,L> validator)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceHandler

public AbstractResourceHandler()

Method Detail

handleCreate

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

handles creation process

Parameters:

createParameter - create parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleCreateInternally

protected abstract 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

Parameters:

createParameter - create parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleDelete

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

handles deleting process

Parameters:

deleteParameter - delete parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleDeleteInternally

protected abstract 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

Parameters:

deleteParameter - delete parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleEdit

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

Parameters:

editParameter - edit parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleEditInternally

protected abstract 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

Parameters:

editParameter - edit parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleGet

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

handles resource querying

Parameters:

getParameter - get parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleGetInternally

protected abstract 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

Parameters:

getParameter - get parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleList

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

handles querying of the resource list

Parameters:

listParameter - get list parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleListInternally

protected abstract 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

Parameters:

listParameter - get list parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

setValidator

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

Parameters:

validator - validator to be set