Package com.logicaldoc.webservice.rest.endpoint

Class RestDocumentMetadataService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.webservice.soap.endpoint.SoapDocumentMetadataService

com.logicaldoc.webservice.rest.endpoint.RestDocumentMetadataService

All Implemented Interfaces:

DocumentMetadataService, DocumentMetadataService

Direct Known Subclasses:

RestDocumentMetadataSwagger

@Path("/")
@Consumes("application/json")
@Produces("application/json")
public class RestDocumentMetadataService
extends SoapDocumentMetadataService
implements DocumentMetadataService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RestDocumentMetadataService.SetAttributeOptionsMultipartRequest

Constructor Summary

Constructors

Constructor	Description
RestDocumentMetadataService()

Method Summary

Modifier and Type	Method	Description
void	addAttributeOption(long setId, String attribute, WSAttributeOption option)	Add a new option for the given attribute
void	deleteAttributeSet(long setId)	Deletes an existing attribute set with the given identifier.
void	deleteTemplate(long templateId)	Deletes an existing template with the given identifier
List<String>	getAttributeOptions(long setId, String attribute)	Retrieves the options for the given attribute
List<WSAttributeOption>	getAttributeOptionsByCategory(long setId, String attribute, String category)	Retrieves the options for the given attribute inside a given category
WSAttributeSet	getAttributeSet(String name)	Gets attribute set's metadata
WSAttributeSet	getAttributeSetById(long setId)	Gets attribute set's metadata
WSTemplate	getTemplate(String name)	Gets template's metadata
WSTemplate	getTemplateById(long templateId)	Gets template's metadata
List<WSAttributeSet>	listAttributeSets()	Gets metadata of all existing attribute sets.
List<WSTemplate>	listTemplates()	Gets metadata of all existing templates.
void	setAttributeOptions(long setId, String attribute, List<WSAttributeOption> options)	Saves the options for the given attribute
void	setAttributeOptionsPOST(Long setId, String attribute, List<WSAttributeOption> options)	Saves the options for the given attribute with a POST method.
long	storeAttributeSet(WSAttributeSet attributeSet)	Create/Update an attribute set.
long	storeTemplate(WSTemplate template)	Create/Update a template.

Methods inherited from class com.logicaldoc.webservice.soap.endpoint.SoapDocumentMetadataService

addAttributeOption, deleteAttributeSet, deleteTemplate, getAccessControlList, getAttributeOptions, getAttributeOptionsByCategory, getAttributeSet, getAttributeSetById, getTemplate, getTemplateById, isReadable, isWritable, listAttributeSets, listTemplates, setAccessControlList, setAttributeOptions, storeAttributeSet, storeTemplate

Methods inherited from class com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestDocumentMetadataService

public RestDocumentMetadataService()

Method Details

setAttributeOptions

@PUT
@Path("/setAttributeOptions")
public void setAttributeOptions(@QueryParam("setId")
 long setId,
 @QueryParam("attribute")
 String attribute,
 @QueryParam("options")
 List<WSAttributeOption> options)
                         throws WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Saves the options for the given attribute

Specified by:

setAttributeOptions in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

attribute - The attribute's name

options - The attribute's options

Throws:

WebserviceException - Error in the webservice

PersistenceException - Error in the database

storeAttributeSet

@POST
@Path("/storeAttributeSet")
public long storeAttributeSet(WSAttributeSet attributeSet)
                       throws WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Create/Update an attribute set. You can completely customize the attribute set through a value object containing the attribute set's metadata.

Specified by:

storeAttributeSet in interface DocumentMetadataService

Parameters:

attributeSet - set's value object containing the attribute set's metadata

Returns:

The ID of the new attribute set

Throws:

WebserviceException - Error in the webservice

PersistenceException - Error in the database

storeTemplate

@POST
@Path("/storeTemplate")
public long storeTemplate(WSTemplate template)
                   throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Create/Update a template. You can completely customize the template through a value object.

Specified by:

storeTemplate in interface DocumentMetadataService

Parameters:

template - value object containing the template's metadata

Returns:

The ID of the new template

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeSetById

@GET
@Path("/getAttributeSetById")
public WSAttributeSet getAttributeSetById(@QueryParam("setId")
 long setId)
                                   throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets attribute set's metadata

Specified by:

getAttributeSetById in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

Returns:

the attribute set

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeSet

@GET
@Path("/getAttributeSet")
public WSAttributeSet getAttributeSet(@QueryParam("name")
 String name)
                               throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets attribute set's metadata

Specified by:

getAttributeSet in interface DocumentMetadataService

Parameters:

name - The attribute set's name

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getTemplate

@GET
@Path("/getTemplate")
public WSTemplate getTemplate(@QueryParam("name")
 String name)
                       throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets template's metadata

Specified by:

getTemplate in interface DocumentMetadataService

Parameters:

name - The template's name

Returns:

A value object containing the template's metadata.

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getTemplateById

@GET
@Path("/getTemplateById")
public WSTemplate getTemplateById(@QueryParam("templateId")
 long templateId)
                           throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets template's metadata

Specified by:

getTemplateById in interface DocumentMetadataService

Parameters:

templateId - The template's id

Returns:

A value object containing the template's metadata

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeOptions

@GET
@Path("/getAttributeOptions")
public List<String> getAttributeOptions(@QueryParam("setId")
 long setId,
 @QueryParam("attribute")
 String attribute)
                                 throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Retrieves the options for the given attribute

Specified by:

getAttributeOptions in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

attribute - The attribute's name

Returns:

the list of all the attribute's options

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeOptionsByCategory

@GET
@Path("/getAttributeOptionsByCategory")
public List<WSAttributeOption> getAttributeOptionsByCategory(long setId,
 String attribute,
 String category)
                                                      throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Retrieves the options for the given attribute inside a given category

Specified by:

getAttributeOptionsByCategory in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

attribute - The attribute's name

category - The options category (not mandatory)

Returns:

the list of all the attribute's options

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

listAttributeSets

@GET
@Path("/listAttributeSets")
public List<WSAttributeSet> listAttributeSets()
                                       throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets metadata of all existing attribute sets.

Specified by:

listAttributeSets in interface DocumentMetadataService

Returns:

The list of all attribute sets

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

deleteAttributeSet

@DELETE
@Path("/deleteAttributeSet")
public void deleteAttributeSet(@QueryParam("setId")
 long setId)
                        throws WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Deletes an existing attribute set with the given identifier.

Specified by:

deleteAttributeSet in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

Throws:

WebserviceException - Error in the webservice

PersistenceException - Error in the database

deleteTemplate

@DELETE
@Path("/deleteTemplate")
public void deleteTemplate(@QueryParam("templateId")
 long templateId)
                    throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Deletes an existing template with the given identifier

Specified by:

deleteTemplate in interface DocumentMetadataService

Parameters:

templateId - The template's id

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

WebserviceException - Error in the webservice

PersistenceException - Error in the database

listTemplates

@GET
@Path("/listTemplates")
public List<WSTemplate> listTemplates()
                               throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Gets metadata of all existing templates.

Specified by:

listTemplates in interface DocumentMetadataService

Returns:

The list of all templates

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

setAttributeOptionsPOST

@POST
@Consumes("multipart/form-data")
@Path("/setAttributeOptionsPOST")
public void setAttributeOptionsPOST(Long setId,
 String attribute,
 List<WSAttributeOption> options)
                             throws WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Saves the options for the given attribute with a POST method. This is useful for very large lists of values

Specified by:

setAttributeOptionsPOST in interface DocumentMetadataService

Parameters:

setId - The attribute set's id

attribute - The attribute's name

options - The attribute's options

Throws:

WebserviceException - Error in the webservice

PersistenceException - Error in the database

addAttributeOption

@POST
@Consumes("application/x-www-form-urlencoded")
@Path("/addAttributeOption")
public void addAttributeOption(@FormParam("setId")
 long setId,
 @FormParam("attribute")
 String attribute,
 @FormParam("option")
 WSAttributeOption option)
                        throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: DocumentMetadataService

Add a new option for the given attribute

Specified by:

addAttributeOption in interface DocumentMetadataService

Parameters:

setId - Attribute set ID

attribute - Attribute name

option - Attribute option

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database