org.alfresco.repo.cmis.ws

Class DMDiscoveryServicePort

java.lang.Object

org.alfresco.repo.cmis.ws.DMAbstractServicePort

org.alfresco.repo.cmis.ws.DMDiscoveryServicePort

All Implemented Interfaces:

DiscoveryServicePort

public class DMDiscoveryServicePort
extends DMAbstractServicePort
implements DiscoveryServicePort

Port for Discovery service.

Author:

Dmitry Lazurkin, Dmitry Velichkevich

Field Summary

Fields inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

authorityService, cmisAclService, cmisChangeLogService, cmisObjectFactory, cmisQueryService, cmisRenditionService, cmisService, descriptorService, fileFolderService, INCLUDE_RELATIONSHIPS_ENUM_MAPPING, nodeService, permissionService, propertiesUtil, searchService

Constructor Summary

Constructors

Constructor and Description
DMDiscoveryServicePort()

Method Summary

Methods

Modifier and Type	Method and Description
void	getContentChanges(String repositoryId, Holder<String> changeLogToken, Boolean includeProperties, String filter, Boolean includePolicyIds, Boolean includeACL, BigInteger maxItems, CmisExtensionType extension, Holder<CmisObjectListType> objects) Gets a list of content changes.
QueryResponse	query(Query parameters) Queries the repository for queryable object based on properties or an optional full-text string.

Methods inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

appendWithAce, appendWithRelationships, applyAclCarefully, applyPolicies, checkRepositoryId, convertAclReportToCmisAclType, createCmisObject, createCmisObject, createCmisObjectList, createCursor, createPropertyFilter, createPropertyFilter, determineObjectAllowableActions, getRenditions, isObjectInFolder, setAuthorityService, setCmisAclService, setCmisChangeLogService, setCmisQueryService, setCmisRenditionService, setCmisService, setDescriptorService, setFileFolderService, setNodeService, setPermissionService, setPropertiesUtil, setSearchService

Methods inherited from class java.lang.Object

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

Constructor Detail

DMDiscoveryServicePort

public DMDiscoveryServicePort()

Method Detail

query

public QueryResponse query(Query parameters)
                    throws CmisException

Queries the repository for queryable object based on properties or an optional full-text string. Relationship objects are not queryable. Content-streams are not returned as part of query ALF-9566 : hasMoreItems was changed to be confirmed with a section (2.2.1.1 Paging) of the specification.

Specified by:

query in interface DiscoveryServicePort

Parameters:

parameters - query parameters

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME)

getContentChanges

public void getContentChanges(String repositoryId,
                     Holder<String> changeLogToken,
                     Boolean includeProperties,
                     String filter,
                     Boolean includePolicyIds,
                     Boolean includeACL,
                     BigInteger maxItems,
                     CmisExtensionType extension,
                     Holder<CmisObjectListType> objects)
                       throws CmisException

Gets a list of content changes. Targeted for search crawlers or other applications that need to efficiently understand what has changed in the repository. Note: The content stream is NOT returned for any change event.

Specified by:

getContentChanges in interface DiscoveryServicePort

Parameters:

repositoryId - String value that determines Id of the necessary Repository

changeLogToken - generic Holder class instance with String type parameter that determines last Change Log Token

includeProperties - Boolean instance value that specifies whether all allowed by filter properties should be returned for Change Type equal to 'UPDATED' or Object Id property only

filter - String value for filtering properties for Change Entry with Change Type equal to 'UPDATED'

includePolicyIds - Boolean instance value that determines whether Policy Ids must be returned

includeACL - Boolean instance value that determines whether ACLs must be returned

maxItems - BigInteger instance value that determines required amount of Change Log Entries

extension - CmisException instance of unknown assignment

objects - generic Holder instance with CmisObjectListType type parameter for storing results of service execution

Throws:

CmisException - with next allowable EnumServiceException enum attribute of exception type values: CONSTRAINT, FILTER_NOT_VALID, INVALID_ARGUMENT, NOT_SUPPORTED, OBJECT_NOT_FOUND, PERMISSION_DENIED, RUNTIME