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

Class ExternalObjectResourceHandler

java.lang.Object

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

com.communote.plugins.api.rest.v24.resource.DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

com.communote.plugins.api.rest.v24.resource.topic.externalobject.ExternalObjectResourceHandler

public class ExternalObjectResourceHandler
extends DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Author:

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

Constructor Summary

Constructors

Constructor and Description
ExternalObjectResourceHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	handleCreateInternally(CreateExternalObjectParameter createExternalObjectParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to assign external object for topic.
javax.ws.rs.core.Response	handleDeleteInternally(DeleteExternalObjectParameter deleteExternalObjectParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Delete the ExternalObjectResource.
javax.ws.rs.core.Response	handleEditInternally(EditExternalObjectParameter editExternalObjectParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Edit an ExternalObjectResource
javax.ws.rs.core.Response	handleGetInternally(GetExternalObjectParameter getExternalObjectParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Get the internal representation of external object as ExternalObjectResource.
javax.ws.rs.core.Response	handleListInternally(GetCollectionExternalObjectParameter getCollectionExternalObjectParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Get an list of external objects

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

ExternalObjectResourceHandler

public ExternalObjectResourceHandler()

Method Detail

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreateExternalObjectParameter createExternalObjectParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws BlogNotFoundException,
                                                        NotFoundException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException,
                                                        AuthorizationException,
                                                        ExternalObjectAlreadyAssignedException,
                                                        TooManyExternalObjectsPerTopicException,
                                                        ExternalSystemNotConfiguredException

Request to assign external object for topic.

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Parameters:

createExternalObjectParameter - - 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

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

null

Throws:

NotFoundException - topic was not found

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

AuthorizationException - user has no manager access for topic

BlogNotFoundException - can not found topic

ExternalObjectAlreadyAssignedException - in case the topic is already assigned

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

handleDeleteInternally

public javax.ws.rs.core.Response handleDeleteInternally(DeleteExternalObjectParameter deleteExternalObjectParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws BlogNotFoundException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException,
                                                        NotFoundException,
                                                        AuthorizationException

Delete the ExternalObjectResource.

Overrides:

handleDeleteInternally in class DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Parameters:

deleteExternalObjectParameter - - 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

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

ExternalObject

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

NotFoundException - can not found external object

AuthorizationException - user has no manager access for topic

BlogNotFoundException - can not found topic

handleEditInternally

public javax.ws.rs.core.Response handleEditInternally(EditExternalObjectParameter editExternalObjectParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String requestSessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws BlogNotFoundException,
                                                      NotFoundException,
                                                      ExternalObjectAlreadyAssignedException,
                                                      BlogAccessException,
                                                      ResponseBuildException,
                                                      ExtensionNotSupportedException

Edit an ExternalObjectResource

Overrides:

handleEditInternally in class DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Parameters:

editExternalObjectParameter - - 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

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

ExternalObject

Throws:

BlogNotFoundException - in case the topic does not exist

NotFoundException - in case the external object does not exist

ExternalObjectAlreadyAssignedException - in case the external object is assigned to another topic

BlogAccessException - in case the user is not manager of the topic

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetExternalObjectParameter getExternalObjectParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String requestSessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws ResponseBuildException,
                                                     ExtensionNotSupportedException,
                                                     NotFoundException,
                                                     BlogAccessException

Get the internal representation of external object as ExternalObjectResource.

Overrides:

handleGetInternally in class DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Parameters:

getExternalObjectParameter - - 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

requestSessionId - - The sessionId for the session

request - - javax request

Returns:

ExternalObject

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

NotFoundException - can not found external object

BlogAccessException - in case the current user has no read access to the blog

handleListInternally

public javax.ws.rs.core.Response handleListInternally(GetCollectionExternalObjectParameter getCollectionExternalObjectParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String sessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws IllegalRequestParameterException,
                                                      ResponseBuildException,
                                                      ExtensionNotSupportedException,
                                                      BlogNotFoundException,
                                                      BlogAccessException

Get an list of external objects

Overrides:

handleListInternally in class DefaultResourceHandler<CreateExternalObjectParameter,EditExternalObjectParameter,DeleteExternalObjectParameter,GetExternalObjectParameter,GetCollectionExternalObjectParameter>

Parameters:

getCollectionExternalObjectParameter - - 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 - - The sessionId for the session

request - - javax request

Returns:

an response object containing a http status code and a message

Throws:

IllegalRequestParameterException - request parameter is not valid

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

BlogNotFoundException - topic was not found

BlogAccessException - in case the current user has no read access to the blog