Package com.logicaldoc.webservice.soap.client

Class SoapDocumentMetadataClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<DocumentMetadataService>

com.logicaldoc.webservice.soap.client.SoapDocumentMetadataClient

All Implemented Interfaces:

DocumentMetadataService

public class SoapDocumentMetadataClient
extends SoapClient<DocumentMetadataService>
implements DocumentMetadataService

Document Metadata Web Service client.

Since:

6.1

Author:

Matteo Caruso - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapDocumentMetadataClient(String endpoint)
SoapDocumentMetadataClient(String endpoint, int timeout)

Method Summary

Modifier and Type	Method	Description
void	addAttributeOption(String sid, long setId, String attribute, WSAttributeOption wsoption)	Add a new option for the given attribute
void	deleteAttributeSet(String sid, long setId)	Deletes an existing attribute set with the given identifier.
void	deleteTemplate(String sid, long templateId)	Deletes an existing template with the given identifier
String[]	getAttributeOptions(String sid, long setId, String attribute)	Retrieves the options for the given attribute
WSAttributeOption[]	getAttributeOptionsByCategory(String sid, long setId, String attribute, String category)	Retrieves the options for the given attribute inside a given category
WSAttributeSet	getAttributeSet(String sid, String name)	Gets attribute set's metadata
WSAttributeSet	getAttributeSetById(String sid, long setId)	Gets attribute set's metadata
WSRight[]	getGrantedGroups(String sid, long groupId)	Retrieves the list of granted groups for the given template
WSRight[]	getGrantedUsers(String sid, long groupId)	Retrieves the list of granted users for the given template.
WSTemplate	getTemplate(String sid, String name)	Gets template's metadata
WSTemplate	getTemplateById(String sid, long templateId)	Gets template's metadata
void	grantGroupToTemplate(String sid, long templateId, long groupId, int permissions)	Grants group permission to the template.
void	grantUserToTemplate(String sid, long templateId, long userId, int permissions)	Grants user permission to the template.
boolean	isTemplateReadable(String sid, long templateId)	Tests if a template is readable.
boolean	isTemplateWritable(String sid, long templateId)	Tests if a template is writable
WSAttributeSet[]	listAttributeSets(String sid)	Gets metadata of all existing attribute sets.
WSTemplate[]	listTemplates(String sid)	Gets metadata of all existing templates.
void	setAttributeOptions(String sid, long setId, String attribute, WSAttributeOption[] options)	Saves the options for the given attribute
long	storeAttributeSet(String sid, WSAttributeSet attributeSet)	Create/Update an attribute set.
long	storeTemplate(String sid, WSTemplate template)	Create/Update a template.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapDocumentMetadataClient

public SoapDocumentMetadataClient(String endpoint)
                           throws IOException

Throws:

IOException

SoapDocumentMetadataClient

public SoapDocumentMetadataClient(String endpoint,
                                  int timeout)
                           throws IOException

Throws:

IOException

Method Detail

listTemplates

public WSTemplate[] listTemplates(String sid)
                           throws AuthenticationException,
                                  WebserviceException,
                                  PersistenceException

Description copied from interface: DocumentMetadataService

Gets metadata of all existing templates.

Specified by:

listTemplates in interface DocumentMetadataService

Parameters:

sid - Session identifier

Returns:

The list of all templates

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

storeTemplate

public long storeTemplate(String sid,
                          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:

sid - Session identifier (need to be administrator)

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

deleteTemplate

public void deleteTemplate(String sid,
                           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:

sid - Session identifier (need to be administrator)

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

getTemplate

public WSTemplate getTemplate(String sid,
                              String name)
                       throws AuthenticationException,
                              WebserviceException,
                              PersistenceException

Description copied from interface: DocumentMetadataService

Gets template's metadata

Specified by:

getTemplate in interface DocumentMetadataService

Parameters:

sid - Session identifier

name - The template's name

Returns:

A value object containing the template's metadata.

Throws:

AuthenticationException - Invalid sessionon

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getTemplateById

public WSTemplate getTemplateById(String sid,
                                  long templateId)
                           throws AuthenticationException,
                                  WebserviceException,
                                  PersistenceException

Description copied from interface: DocumentMetadataService

Gets template's metadata

Specified by:

getTemplateById in interface DocumentMetadataService

Parameters:

sid - Session identifier

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

setAttributeOptions

public void setAttributeOptions(String sid,
                                long setId,
                                String attribute,
                                WSAttributeOption[] options)
                         throws WebserviceException,
                                PersistenceException

Description copied from interface: DocumentMetadataService

Saves the options for the given attribute

Specified by:

setAttributeOptions in interface DocumentMetadataService

Parameters:

sid - Session identifier

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

getAttributeOptions

public String[] getAttributeOptions(String sid,
                                    long setId,
                                    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:

sid - Session identifier

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

public WSAttributeOption[] getAttributeOptionsByCategory(String sid,
                                                         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:

sid - Session identifier

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

public WSAttributeSet[] listAttributeSets(String sid)
                                   throws AuthenticationException,
                                          WebserviceException,
                                          PersistenceException

Description copied from interface: DocumentMetadataService

Gets metadata of all existing attribute sets.

Specified by:

listAttributeSets in interface DocumentMetadataService

Parameters:

sid - Session identifier

Returns:

The list of all attribute sets

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeSet

public WSAttributeSet getAttributeSet(String sid,
                                      String name)
                               throws AuthenticationException,
                                      WebserviceException,
                                      PersistenceException

Description copied from interface: DocumentMetadataService

Gets attribute set's metadata

Specified by:

getAttributeSet in interface DocumentMetadataService

Parameters:

sid - Session identifier

name - The attribute set's name

Returns:

A value object containing the attribute set's metadata

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getAttributeSetById

public WSAttributeSet getAttributeSetById(String sid,
                                          long setId)
                                   throws AuthenticationException,
                                          WebserviceException,
                                          PersistenceException

Description copied from interface: DocumentMetadataService

Gets attribute set's metadata

Specified by:

getAttributeSetById in interface DocumentMetadataService

Parameters:

sid - Session identifier

setId - The attribute set's id

Returns:

A value object containing the attribute set's metadata

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

storeAttributeSet

public long storeAttributeSet(String sid,
                              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:

sid - Session identifier (need to be administrator)

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

deleteAttributeSet

public void deleteAttributeSet(String sid,
                               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:

sid - Session identifier (need to be administrator)

setId - The attribute set's id

Throws:

WebserviceException - Error in the webservice

PersistenceException - Error in the database

isTemplateReadable

public boolean isTemplateReadable(String sid,
                                  long templateId)
                           throws AuthenticationException,
                                  WebserviceException,
                                  PersistenceException

Description copied from interface: DocumentMetadataService

Tests if a template is readable.

Specified by:

isTemplateReadable in interface DocumentMetadataService

Parameters:

sid - Session identifier

templateId - The template id

Returns:

True if the identifier denotes a readable template, otherwise false.

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

isTemplateWritable

public boolean isTemplateWritable(String sid,
                                  long templateId)
                           throws AuthenticationException,
                                  WebserviceException,
                                  PersistenceException

Description copied from interface: DocumentMetadataService

Tests if a template is writable

Specified by:

isTemplateWritable in interface DocumentMetadataService

Parameters:

sid - Session identifier

templateId - The template id

Returns:

True if the identifier denotes a writable template, otherwise false

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

grantUserToTemplate

public void grantUserToTemplate(String sid,
                                long templateId,
                                long userId,
                                int permissions)
                         throws AuthenticationException,
                                PermissionException,
                                PersistenceException,
                                WebserviceException

Description copied from interface: DocumentMetadataService

Grants user permission to the template.

Specified by:

grantUserToTemplate in interface DocumentMetadataService

Parameters:

sid - Session identifier

templateId - Template id

userId - User Id

permissions - the permission integer representation. If '0', the user will be not granted to access the template.

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

grantGroupToTemplate

public void grantGroupToTemplate(String sid,
                                 long templateId,
                                 long groupId,
                                 int permissions)
                          throws AuthenticationException,
                                 PermissionException,
                                 WebserviceException,
                                 PersistenceException

Description copied from interface: DocumentMetadataService

Grants group permission to the template.

Specified by:

grantGroupToTemplate in interface DocumentMetadataService

Parameters:

sid - Session identifier

templateId - Template id

groupId - Group Id

permissions - the permission integer representation. If '0', the group will be not granted to access the template.

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getGrantedUsers

public WSRight[] getGrantedUsers(String sid,
                                 long groupId)
                          throws AuthenticationException,
                                 PermissionException,
                                 WebserviceException,
                                 PersistenceException

Description copied from interface: DocumentMetadataService

Retrieves the list of granted users for the given template.

Specified by:

getGrantedUsers in interface DocumentMetadataService

Parameters:

sid - Session identifier

groupId - Template id

Returns:

'error' if error occurred, the right objects collection.

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

WebserviceException - Error in the webservice

PersistenceException - Error in the database

getGrantedGroups

public WSRight[] getGrantedGroups(String sid,
                                  long groupId)
                           throws AuthenticationException,
                                  PermissionException,
                                  WebserviceException,
                                  PersistenceException

Description copied from interface: DocumentMetadataService

Retrieves the list of granted groups for the given template

Specified by:

getGrantedGroups in interface DocumentMetadataService

Parameters:

sid - Session identifier

groupId - Template id

Returns:

'error' if error occurred, the right objects collection

Throws:

AuthenticationException - Invalid session

PermissionException - The permission has not been granted

WebserviceException - Error in the webservice

PersistenceException - Error in the database

addAttributeOption

public void addAttributeOption(String sid,
                               long setId,
                               String attribute,
                               WSAttributeOption wsoption)
                        throws AuthenticationException,
                               WebserviceException,
                               PersistenceException

Description copied from interface: DocumentMetadataService

Add a new option for the given attribute

Specified by:

addAttributeOption in interface DocumentMetadataService

Parameters:

sid - Session identifier

setId - Attribute set ID

attribute - Attribute name

wsoption - Attribute option

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database