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

Class RoleResourceHandler

java.lang.Object

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

com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler<CreateRoleParameter,DefaultParameter,DefaultParameter,GetRoleParameter,GetCollectionRoleParameter>

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

public class RoleResourceHandler
extends DefaultResourceHandler<CreateRoleParameter,DefaultParameter,DefaultParameter,GetRoleParameter,GetCollectionRoleParameter>

Author:

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

Constructor Summary

Constructors

Constructor and Description
RoleResourceHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	handleCreateInternally(CreateRoleParameter createRoleParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Create the role of internal user for blog
javax.ws.rs.core.Response	handleGetInternally(GetRoleParameter getRoleParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Get blog role
protected javax.ws.rs.core.Response	handleListInternally(GetCollectionRoleParameter 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.v30.resource.DefaultResourceHandler

handleDeleteInternally, handleEditInternally

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

RoleResourceHandler

public RoleResourceHandler()

Method Detail

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreateRoleParameter createRoleParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws BlogNotFoundException,
                                                        CommunoteEntityNotFoundException,
                                                        NoBlogManagerLeftException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException,
                                                        AuthorizationException

Create the role of internal user for blog

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreateRoleParameter,DefaultParameter,DefaultParameter,GetRoleParameter,GetCollectionRoleParameter>

Parameters:

createRoleParameter - - 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 - sessionId

request - - javax request

Returns:

an response object containing a http status code and a message

Throws:

BlogNotFoundException - blog not found

BlogAccessException - can not access blog

CommunoteEntityNotFoundException - can not found entity (user/group)

NoBlogManagerLeftException - no active user with managment rights

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

AuthorizationException - in case the the current user tries to become manager of a topic but is not the client manager

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetRoleParameter getRoleParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String requestSessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws ResponseBuildException,
                                                     ExtensionNotSupportedException

Get blog role

Overrides:

handleGetInternally in class DefaultResourceHandler<CreateRoleParameter,DefaultParameter,DefaultParameter,GetRoleParameter,GetCollectionRoleParameter>

Parameters:

getRoleParameter - - 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 - sessionId

request - - javax request

Returns:

null because it is not implemented

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleListInternally

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

Description copied from class: DefaultResourceHandler

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

Overrides:

handleListInternally in class DefaultResourceHandler<CreateRoleParameter,DefaultParameter,DefaultParameter,GetRoleParameter,GetCollectionRoleParameter>

Parameters:

listParameter - get list parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong