com.communote.plugins.api.rest.resource.user.property

Class PropertyResourceHandler

java.lang.Object

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

com.communote.plugins.api.rest.resource.DefaultResourceHandler<CreatePropertyParameter,DefaultParameter,DefaultParameter,GetPropertyParameter,GetCollectionPropertyParameter>

com.communote.plugins.api.rest.resource.user.property.PropertyResourceHandler

public class PropertyResourceHandler
extends DefaultResourceHandler<CreatePropertyParameter,DefaultParameter,DefaultParameter,GetPropertyParameter,GetCollectionPropertyParameter>

Author:

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

Constructor Summary

Constructors

Constructor and Description
PropertyResourceHandler()

Method Summary

Modifier and Type	Method and Description
PropertyManagement	getPropertyManagement() Getter for the PropertyManagement
javax.ws.rs.core.Response	handleCreateInternally(CreatePropertyParameter createPropertyParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to set user property
javax.ws.rs.core.Response	handleGetInternally(GetPropertyParameter getPropertyParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to get user property
javax.ws.rs.core.Response	handleListInternally(GetCollectionPropertyParameter getCollectionPropertyParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Request to list user properties

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

handleDeleteInternally, handleEditInternally

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

PropertyResourceHandler

public PropertyResourceHandler()

Method Detail

getPropertyManagement

public PropertyManagement getPropertyManagement()

Getter for the PropertyManagement

Returns:

the PropertyManagement

handleCreateInternally

public javax.ws.rs.core.Response handleCreateInternally(CreatePropertyParameter createPropertyParameter,
                                                        String requestedMimeType,
                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                        String requestSessionId,
                                                        javax.ws.rs.core.Request request)
                                                 throws NumberFormatException,
                                                        NotFoundException,
                                                        AuthorizationException,
                                                        ResponseBuildException,
                                                        ExtensionNotSupportedException

Request to set user property

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreatePropertyParameter,DefaultParameter,DefaultParameter,GetPropertyParameter,GetCollectionPropertyParameter>

Parameters:

createPropertyParameter - - 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 - can note found property

NumberFormatException - wrong format of property

AuthorizationException - Thrown, when the user is not allowed to access.

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetPropertyParameter getPropertyParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String requestSessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws NumberFormatException,
                                                     NotFoundException,
                                                     AuthorizationException,
                                                     ResponseBuildException,
                                                     ExtensionNotSupportedException

Request to get user property

Overrides:

handleGetInternally in class DefaultResourceHandler<CreatePropertyParameter,DefaultParameter,DefaultParameter,GetPropertyParameter,GetCollectionPropertyParameter>

Parameters:

getPropertyParameter - - 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 - can note found property

NumberFormatException - wrong format of property

AuthorizationException - user is not authorized for get property

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

handleListInternally

public javax.ws.rs.core.Response handleListInternally(GetCollectionPropertyParameter getCollectionPropertyParameter,
                                                      String requestedMimeType,
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String requestSessionId,
                                                      javax.ws.rs.core.Request request)
                                               throws NumberFormatException,
                                                      NotFoundException,
                                                      AuthorizationException,
                                                      ResponseBuildException,
                                                      ExtensionNotSupportedException

Request to list user properties

Overrides:

handleListInternally in class DefaultResourceHandler<CreatePropertyParameter,DefaultParameter,DefaultParameter,GetPropertyParameter,GetCollectionPropertyParameter>

Parameters:

getCollectionPropertyParameter - - 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 - can note found property

NumberFormatException - wrong format of property

AuthorizationException - user is not authorized for get property

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported