org.alfresco.repo.cmis.ws.utils

Class PropertyUtil

java.lang.Object

org.alfresco.repo.cmis.ws.utils.PropertyUtil

public class PropertyUtil
extends Object

Class for managing access control to CMIS properties

Author:

Dmitry Lazurkin, Dmitry Velichkevich

Constructor Summary

Constructors

Constructor and Description
PropertyUtil()

Method Summary

Methods

Modifier and Type	Method and Description
XMLGregorianCalendar	convert(Date date) Converts Date object to XMLGregorianCalendar object
CmisProperty	createProperty(String pdid, CMISDataTypeEnum dataType, Serializable value) Creates and initializes appropriate CmisProperty instance by name and data type
<ResultType> ResultType	getCmisPropertyValue(CmisPropertiesType cmisProperties, String property, ResultType defaultValue) Extracts from CmisPropertiesType instance property by its name and returns casted to appropriate type value of the extracted property
CmisPropertiesType	getProperties(Object object, PropertyFilter filter) Get CMIS properties for object
Map<String,Serializable>	getPropertiesMap(CmisPropertiesType cmisProperties) Converts CmisPropertiesType properties representation to rapidly accessible form
<ResultType> ResultType	getProperty(NodeRef objectNodeRef, String propertyName, ResultType defaultValue) Gets property value by its name from Node Reference object
String	getPropertyName(CmisProperty property)
void	setCmisDictionaryService(CMISDictionaryService cmisDictionaryService)
void	setCmisService(CMISServices cmisService)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setProperties(NodeRef nodeRef, CmisPropertiesType properties, PropertyFilter ignoringPropertiesFilter) Sets and checks all properties' fields for specified node

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUtil

public PropertyUtil()

Method Detail

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

setCmisService

public void setCmisService(CMISServices cmisService)

setCmisDictionaryService

public void setCmisDictionaryService(CMISDictionaryService cmisDictionaryService)

getProperty

public <ResultType> ResultType getProperty(NodeRef objectNodeRef,
                                  String propertyName,
                                  ResultType defaultValue)
                       throws CMISInvalidArgumentException

Gets property value by its name from Node Reference object

Parameters:

objectNodeRef - - NodeRef instance that represents Id of the source object

propertyName - - String instance that represents property name

defaultValue - - some value of the appropriate for conversion type. Also null may be accepted by this parameter

Returns:

value instance of the appropriate type if specified object has such property and defaultValue if requested property value or objectNodeRef or propertyName are null or if some exception occurred during property receiving

Throws:

CMISInvalidArgumentException

getCmisPropertyValue

public <ResultType> ResultType getCmisPropertyValue(CmisPropertiesType cmisProperties,
                                           String property,
                                           ResultType defaultValue)
                                throws CmisException

Extracts from CmisPropertiesType instance property by its name and returns casted to appropriate type value of the extracted property

Parameters:

cmisProperties - - CmisPropertiesType properties instance

property - - String instance that represents property name

defaultValue - - some value of the appropriate for conversion type. Also null may be accepted by this parameter

Returns:

value instance of the appropriate type if specified cmisProperties contains specified properties and defaultValue if requested property value or cmisProperties or property are null or if some exception occurred during property searching and receiving

Throws:

CmisException

getPropertiesMap

public Map<String,Serializable> getPropertiesMap(CmisPropertiesType cmisProperties)
                                          throws CmisException

Converts CmisPropertiesType properties representation to rapidly accessible form

Parameters:

cmisProperties - - CmisPropertiesType properties representation

Returns:

Map<String, Serializable> properties representation

Throws:

CmisException

CmisException

setProperties

public void setProperties(NodeRef nodeRef,
                 CmisPropertiesType properties,
                 PropertyFilter ignoringPropertiesFilter)
                   throws CmisException

Sets and checks all properties' fields for specified node

Parameters:

nodeRef - - NodeRef for node for those properties must be setted

properties - - CmisPropertiesType instance that contains all the necessary properties' fields

ignoringPropertiesFilter - - PropertyFilter instance. This filter determines which properties should be ignored and not setted without exception. If this parameter is null all properties will be processed in common flow

Throws:

CmisException

getPropertyName

public String getPropertyName(CmisProperty property)

getProperties

public CmisPropertiesType getProperties(Object object,
                               PropertyFilter filter)
                                 throws CmisException

Get CMIS properties for object

Parameters:

nodeRef - node reference

filter - property filter

Returns:

properties

Throws:

CmisException

createProperty

public CmisProperty createProperty(String pdid,
                          CMISDataTypeEnum dataType,
                          Serializable value)

Creates and initializes appropriate CmisProperty instance by name and data type

Parameters:

pdid - - String value that represents CMIS property name

dataType - - CMISDataTypeEnum value that specifies real type of the property

value - - some instance of appropriate type or some Collection that contains several values of the type

Returns:

appropriate CmisProperty instance

convert

public XMLGregorianCalendar convert(Date date)

Converts Date object to XMLGregorianCalendar object

Parameters:

date - Date object

Returns:

XMLGregorianCalendar object