org.alfresco.repo.cmis.ws

Class DMAbstractServicePort

java.lang.Object

org.alfresco.repo.cmis.ws.DMAbstractServicePort

Direct Known Subclasses:

DMAclServicePort, DMDiscoveryServicePort, DMMultiFilingServicePort, DMNavigationServicePort, DMObjectServicePort, DMPolicyServicePort, DMRelationshipServicePort, DMRepositoryServicePort, DMVersioningServicePort

public class DMAbstractServicePort
extends Object

Base class for all CMIS web services

Author:

Michael Shavnev, Dmitry Lazurkin, Dmitry Velichkevich, Stanislav Sokolovsky

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorityService	authorityService
protected CMISAccessControlService	cmisAclService
protected CMISChangeLogService	cmisChangeLogService
protected ObjectFactory	cmisObjectFactory
protected CMISQueryService	cmisQueryService
protected CMISRenditionService	cmisRenditionService
protected CMISServices	cmisService
protected DescriptorService	descriptorService
protected FileFolderService	fileFolderService
protected static Map<EnumIncludeRelationships,CMISRelationshipDirectionEnum>	INCLUDE_RELATIONSHIPS_ENUM_MAPPING
protected NodeService	nodeService
protected PermissionService	permissionService
protected PropertyUtil	propertiesUtil
protected SearchService	searchService

Constructor Summary

Constructors

Constructor and Description
DMAbstractServicePort()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendWithAce(NodeRef identifierInstance, CmisObjectType object)
protected void	appendWithRelationships(NodeRef object, PropertyFilter filter, CMISRelationshipDirectionEnum includeRelationships, boolean includeAllowableActions, String renditionFilter, CmisObjectType result)
protected CmisACLType	applyAclCarefully(NodeRef object, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, EnumACLPropagation aclPropagation, List<String> policies)
protected void	applyPolicies(String objectId, List<String> policies)
protected void	checkRepositoryId(String repositoryId) Checks specified in CMIS request parameters repository Id.
protected CmisACLType	convertAclReportToCmisAclType(CMISAccessControlReport aclReport)
protected CmisObjectType	createCmisObject(Object object, PropertyFilter filter, CMISRelationshipDirectionEnum includeRelationships, boolean includeAllowableActions, String renditionFilter) This method creates and configures CMIS object against appropriate Alfresco object (NodeRef or AssociationRef).
protected CmisObjectType	createCmisObject(Object object, PropertyFilter filter, EnumIncludeRelationships includeRelationships, Boolean includeAllowableActions, String renditionFilter) This method creates and configures CMIS object against appropriate Alfresco object (NodeRef or AssociationRef).
protected void	createCmisObjectList(PropertyFilter filter, CMISRelationshipDirectionEnum includeRelationships, boolean includeAllowableActions, String renditionFilter, List<NodeRef> sourceList, List<CmisObjectType> resultList) This method converts Alfresco's NodeRef's to CMIS objects those will be stored in resultList-parameter.
protected Cursor	createCursor(int totalRows, BigInteger skipCount, BigInteger maxItems)
protected PropertyFilter	createPropertyFilter(JAXBElement<String> element)
protected PropertyFilter	createPropertyFilter(String filter)
protected CmisAllowableActionsType	determineObjectAllowableActions(Object objectIdentifier)
protected List<CmisRenditionType>	getRenditions(Object object, String renditionFilter)
protected boolean	isObjectInFolder(NodeRef object, NodeRef folder) Returns true if folder contains object
void	setAuthorityService(AuthorityService authorityService)
void	setCmisAclService(CMISAccessControlService cmisAclService)
void	setCmisChangeLogService(CMISChangeLogService cmisChangeLogService)
void	setCmisQueryService(CMISQueryService cmisQueryService)
void	setCmisRenditionService(CMISRenditionService cmisRenditionService)
void	setCmisService(CMISServices cmisService)
void	setDescriptorService(DescriptorService descriptorService)
void	setFileFolderService(FileFolderService fileFolderService)
void	setNodeService(NodeService nodeService)
void	setPermissionService(PermissionService permissionService)
void	setPropertiesUtil(PropertyUtil propertiesUtil)
void	setSearchService(SearchService searchService)

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDE_RELATIONSHIPS_ENUM_MAPPING

protected static final Map<EnumIncludeRelationships,CMISRelationshipDirectionEnum> INCLUDE_RELATIONSHIPS_ENUM_MAPPING

cmisObjectFactory

protected ObjectFactory cmisObjectFactory

cmisQueryService

protected CMISQueryService cmisQueryService

cmisService

protected CMISServices cmisService

cmisChangeLogService

protected CMISChangeLogService cmisChangeLogService

cmisRenditionService

protected CMISRenditionService cmisRenditionService

cmisAclService

protected CMISAccessControlService cmisAclService

descriptorService

protected DescriptorService descriptorService

nodeService

protected NodeService nodeService

fileFolderService

protected FileFolderService fileFolderService

searchService

protected SearchService searchService

propertiesUtil

protected PropertyUtil propertiesUtil

permissionService

protected PermissionService permissionService

authorityService

protected AuthorityService authorityService

Constructor Detail

DMAbstractServicePort

public DMAbstractServicePort()

Method Detail

setCmisService

public void setCmisService(CMISServices cmisService)

setCmisQueryService

public void setCmisQueryService(CMISQueryService cmisQueryService)

setCmisChangeLogService

public void setCmisChangeLogService(CMISChangeLogService cmisChangeLogService)

setCmisAclService

public void setCmisAclService(CMISAccessControlService cmisAclService)

setCmisRenditionService

public void setCmisRenditionService(CMISRenditionService cmisRenditionService)

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

setNodeService

public void setNodeService(NodeService nodeService)

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

setPropertiesUtil

public void setPropertiesUtil(PropertyUtil propertiesUtil)

setSearchService

public void setSearchService(SearchService searchService)

setPermissionService

public void setPermissionService(PermissionService permissionService)

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

createPropertyFilter

protected PropertyFilter createPropertyFilter(String filter)
                                       throws CmisException

Throws:

CmisException

createPropertyFilter

protected PropertyFilter createPropertyFilter(JAXBElement<String> element)
                                       throws CmisException

Throws:

CmisException

createCursor

protected Cursor createCursor(int totalRows,
                  BigInteger skipCount,
                  BigInteger maxItems)

isObjectInFolder

protected boolean isObjectInFolder(NodeRef object,
                       NodeRef folder)

Returns true if folder contains object

Parameters:

object - object NodeRef

folder - folder NodeRef

Returns:

returns true if folder contains object

createCmisObjectList

protected void createCmisObjectList(PropertyFilter filter,
                        CMISRelationshipDirectionEnum includeRelationships,
                        boolean includeAllowableActions,
                        String renditionFilter,
                        List<NodeRef> sourceList,
                        List<CmisObjectType> resultList)
                             throws CmisException

This method converts Alfresco's NodeRef's to CMIS objects those will be stored in resultList-parameter. Properties for returning filtering also performs

Parameters:

filter - properties filter value for filtering objects returning properties

includeRelationships - what relationships to include

sourceList - the list that contains all returning Node References

resultList - the list of CmisObjectType values for end response result collecting

Throws:

CmisException

createCmisObject

protected CmisObjectType createCmisObject(Object object,
                              PropertyFilter filter,
                              EnumIncludeRelationships includeRelationships,
                              Boolean includeAllowableActions,
                              String renditionFilter)
                                   throws CmisException

This method creates and configures CMIS object against appropriate Alfresco object (NodeRef or AssociationRef).

Parameters:

object - the Alfresco object

filter - accepted properties filter

includeRelationships - what relationships to include

includeAllowableActions - should we include allowable actions?

renditionFilter - the rendition filter

Returns:

the converted CMIS object

Throws:

CmisException - on error

createCmisObject

protected CmisObjectType createCmisObject(Object object,
                              PropertyFilter filter,
                              CMISRelationshipDirectionEnum includeRelationships,
                              boolean includeAllowableActions,
                              String renditionFilter)
                                   throws CmisException

This method creates and configures CMIS object against appropriate Alfresco object (NodeRef or AssociationRef).

Parameters:

object - the Alfresco object

filter - accepted properties filter

includeRelationships - what relationships to include

includeAllowableActions - should we include allowable actions?

renditionFilter - the rendition filter

Returns:

the converted CMIS object

Throws:

CmisException - on error

appendWithRelationships

protected void appendWithRelationships(NodeRef object,
                           PropertyFilter filter,
                           CMISRelationshipDirectionEnum includeRelationships,
                           boolean includeAllowableActions,
                           String renditionFilter,
                           CmisObjectType result)
                                throws CmisException

Throws:

CmisException

checkRepositoryId

protected void checkRepositoryId(String repositoryId)
                          throws CmisException

Checks specified in CMIS request parameters repository Id.

Parameters:

repositoryId - repository id

Throws:

CmisException - repository diesn't exist

getRenditions

protected List<CmisRenditionType> getRenditions(Object object,
                                    String renditionFilter)
                                         throws CmisException

Throws:

CmisException

appendWithAce

protected void appendWithAce(NodeRef identifierInstance,
                 CmisObjectType object)

applyPolicies

protected void applyPolicies(String objectId,
                 List<String> policies)
                      throws CmisException

Throws:

CmisException

applyAclCarefully

protected CmisACLType applyAclCarefully(NodeRef object,
                            CmisAccessControlListType addACEs,
                            CmisAccessControlListType removeACEs,
                            EnumACLPropagation aclPropagation,
                            List<String> policies)
                                 throws CmisException

Throws:

CmisException

convertAclReportToCmisAclType

protected CmisACLType convertAclReportToCmisAclType(CMISAccessControlReport aclReport)

determineObjectAllowableActions

protected CmisAllowableActionsType determineObjectAllowableActions(Object objectIdentifier)
                                                            throws CmisException

Throws:

CmisException