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

Class TopicResourceHandler

java.lang.Object

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

com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

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

public class TopicResourceHandler
extends DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Handler for TopicResource

Author:

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

Constructor Summary

Constructors

Constructor and Description
TopicResourceHandler() Set the validator for the resource handler

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	handleCreateInternally(CreateTopicParameter createTopicParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Request to create a topic
javax.ws.rs.core.Response	handleDeleteInternally(DeleteTopicParameter deleteTopicParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Request to delete a topic
javax.ws.rs.core.Response	handleEditInternally(EditTopicParameter editTopicParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Request to edit a topic
javax.ws.rs.core.Response	handleGetInternally(GetTopicParameter getTopicParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Retrieve a single topic from the server
javax.ws.rs.core.Response	handleListInternally(GetCollectionTopicParameter getCollectionTopicParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String sessionId, javax.ws.rs.core.Request request) Get an collection of topics

Methods inherited from class com.communote.plugins.api.rest.v30.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

TopicResourceHandler

public TopicResourceHandler()

Set the validator for the resource handler

Method Detail

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreateTopicParameter createTopicParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String sessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws BlogValidationException,
                                                        NotFoundException,
                                                        AuthorizationException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException,
                                                        NoBlogManagerLeftException,
                                                        ExternalObjectAlreadyAssignedException,
                                                        TooManyExternalObjectsPerTopicException,
                                                        ExternalSystemNotConfiguredException,
                                                        ExternalObjectNotAssignedException

Request to create a topic

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Parameters:

createTopicParameter - - 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:

BlogValidationException - parameter to get blog are not valid

AuthorizationException - user is not authorizied.

NotFoundException - can not found element.

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

NoBlogManagerLeftException - cannot add role because no topic manager exists after create of topic

ExternalObjectAlreadyAssignedException - in case the topic is already assigned

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

ExternalObjectNotAssignedException

handleDeleteInternally

public javax.ws.rs.core.Response handleDeleteInternally(DeleteTopicParameter deleteTopicParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String sessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws BlogNotFoundException,
                                                        NoteManagementAuthorizationException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException,
                                                        BlogAccessException

Request to delete a topic

Overrides:

handleDeleteInternally in class DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Parameters:

deleteTopicParameter - - 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:

BlogNotFoundException - Exception

NoteManagementAuthorizationException - Exception

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

BlogAccessException - in case the current user has no access to the topic

handleEditInternally

public javax.ws.rs.core.Response handleEditInternally(EditTopicParameter editTopicParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String sessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws BlogValidationException,
                                                      AuthorizationException,
                                                      NotFoundException,
                                                      BlogNotFoundException,
                                                      ResponseBuildException,
                                                      ExtensionNotSupportedException,
                                                      NoBlogManagerLeftException,
                                                      ExternalObjectAlreadyAssignedException,
                                                      TooManyExternalObjectsPerTopicException,
                                                      ExternalSystemNotConfiguredException,
                                                      ExternalObjectNotAssignedException

Request to edit a topic

Overrides:

handleEditInternally in class DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Parameters:

editTopicParameter - - 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:

BlogValidationException - topic input parameter are not valid

NotFoundException - topic is not found

AuthorizationException - user is not authorized

BlogNotFoundException - can not found topic

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

NoBlogManagerLeftException - cannot change role because no topic manager exists after update of topic

ExternalObjectAlreadyAssignedException - in case the topic is already assigned

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

ExternalObjectNotAssignedException

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetTopicParameter getTopicParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String sessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws BlogNotFoundException,
                                                     ResponseBuildException,
                                                     ExtensionNotSupportedException,
                                                     BlogAccessException

Retrieve a single topic from the server

Overrides:

handleGetInternally in class DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Parameters:

getTopicParameter - - 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:

BlogNotFoundException - blog was not found

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

BlogAccessException - in case the current user has no access to the topic

handleListInternally

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

Get an collection of topics

Overrides:

handleListInternally in class DefaultResourceHandler<CreateTopicParameter,EditTopicParameter,DeleteTopicParameter,GetTopicParameter,GetCollectionTopicParameter>

Parameters:

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