NoteResourceHandler (Communote 3.5 API)

java.lang.Object
- com.communote.plugins.api.rest.resource.AbstractResourceHandler<C,E,D,G,L>
- - com.communote.plugins.api.rest.resource.DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
  - - com.communote.plugins.api.rest.resource.note.NoteResourceHandler

```
public class NoteResourceHandler
extends DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
```
Is the handler class to provide data for a note resource to the resource class. All the list parameter are collected in a parameter map expected the filterHtml. This value is evaluated within this class.

Author:

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

Constructor Summary

Constructors
Constructor and Description

NoteResourceHandler()

Constructors
Constructor and Description
`NoteResourceHandler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`handleCreateInternally(CreateNoteParameter createNoteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request)` Create a single note on the server.
`javax.ws.rs.core.Response`	`handleDeleteInternally(DeleteNoteParameter deleteNoteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request)` Delete a note on the server
`javax.ws.rs.core.Response`	`handleEditInternally(EditNoteParameter editNoteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request)` Changes an existing note on the server
`javax.ws.rs.core.Response`	`handleGetInternally(GetNoteParameter getNoteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request)` Retrieve a single note from the server
`javax.ws.rs.core.Response`	`handleListInternally(GetCollectionNoteParameter getCollectionNoteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request)` Get method for the NoteCollection

Methods inherited from class com.communote.plugins.api.rest.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
- NoteResourceHandler
```
public NoteResourceHandler()
```

Method Detail

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreateNoteParameter createNoteParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String sessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws IllegalRequestParameterException,
                                                        BlogNotFoundException,
                                                        AuthorizationException,
                                                        NoteStoringPreProcessorException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException

Create a single note on the server. This note can either be a reply or a new note

Overrides:: handleCreateInternally in class DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
Parameters:: createNoteParameter - - an object that contains all the parameter that can or have to be used for such a request; requestedMimeType - - is the mime type that indicates which data exchange format to use; uriInfo - - this object is created by the request and contains some request specific data; sessionId - sessionId; request - - javax request
Returns:: an response object containing a http status code and a message
Throws:: NoteStoringPreProcessorException - Exception; IllegalRequestParameterException - if text value is wrong; AuthorizationException - user is not authorized; BlogNotFoundException - blog was not found; ResponseBuildException - exception while building the response; ExtensionNotSupportedException - extension is not supported

handleDeleteInternally

public javax.ws.rs.core.Response handleDeleteInternally(DeleteNoteParameter deleteNoteParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String sessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws AuthorizationException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException

Delete a note on the server

Overrides:: handleDeleteInternally in class DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
Parameters:: deleteNoteParameter - - an object that contains all the parameter that can or have to be used for such a request; requestedMimeType - - is the mime type that indicates which data exchange format to use; uriInfo - - this object is created by the request and contains some request specific data; sessionId - sessionId; request - - javax request
Returns:: an response object containing a http status code and a message
Throws:: AuthorizationException - user is not authorized; ResponseBuildException - exception while building the response; ExtensionNotSupportedException - extension is not supported

handleEditInternally

public javax.ws.rs.core.Response handleEditInternally(EditNoteParameter editNoteParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String sessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws IllegalRequestParameterException,
                                                      NoteNotFoundException,
                                                      AuthorizationException,
                                                      BlogNotFoundException,
                                                      NoteStoringPreProcessorException,
                                                      ResponseBuildException,
                                                      ExtensionNotSupportedException

Changes an existing note on the server

Overrides:: handleEditInternally in class DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
Parameters:: editNoteParameter - - an object that contains all the parameter that can or have to be used for such a request; requestedMimeType - - is the mime type that indicates which data exchange format to use; uriInfo - - this object is created by the request and contains some request specific data; sessionId - sessionId; request - - javax request
Returns:: an response object containing a http status code and a message
Throws:: NoteStoringPreProcessorException - Exception; IllegalRequestParameterException - if text value is wrong; AuthorizationException - user is not authorized; BlogNotFoundException - blog was not found; NoteNotFoundException - note was not found; ResponseBuildException - exception while building the response; ExtensionNotSupportedException - extension is not supported

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetNoteParameter getNoteParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String sessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws AuthorizationException,
                                                     NoteNotFoundException,
                                                     ResponseBuildException,
                                                     ExtensionNotSupportedException

Retrieve a single note from the server

Overrides:: handleGetInternally in class DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
Parameters:: getNoteParameter - - an object that contains all the parameter that can or have to be used for such a request; requestedMimeType - - is the mime type that indicates which data exchange format to use; uriInfo - - this object is created by the request and contains some request specific data; sessionId - sessionId; request - - javax request
Returns:: an response object containing a http status code and a message
Throws:: NoteNotFoundException - Exception; AuthorizationException - Exception; ResponseBuildException - exception while building the response; ExtensionNotSupportedException - extension is not supported

handleListInternally

public javax.ws.rs.core.Response handleListInternally(GetCollectionNoteParameter getCollectionNoteParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String sessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws ResponseBuildException,
                                                      ExtensionNotSupportedException

Get method for the NoteCollection

Overrides:: handleListInternally in class DefaultResourceHandler<CreateNoteParameter,EditNoteParameter,DeleteNoteParameter,GetNoteParameter,GetCollectionNoteParameter>
Parameters:: getCollectionNoteParameter - - an object that contains all the parameter that can or have to be used for such a request; requestedMimeType - The requested mimetype.; uriInfo - All request information.; sessionId - the current session Id.; request - - javax request
Returns:: Collection of Notes for the given parameters.
Throws:: ResponseBuildException - exception while building the response; ExtensionNotSupportedException - extension is not supported

Class NoteResourceHandler

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail