org.apache.chemistry.opencmis.server.impl.dummy

Class DummyService

java.lang.Object

org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisService

org.apache.chemistry.opencmis.server.impl.dummy.DummyService

All Implemented Interfaces:

CmisService, ObjectInfoHandler, AclService, DiscoveryService, MultiFilingService, NavigationService, ObjectService, PolicyService, RelationshipService, RepositoryService, VersioningService

public class DummyService
extends AbstractCmisService

Simplest Repository Service implementation.

Constructor Summary

Constructors

Constructor and Description
DummyService(String id, String name)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectInFolderList	getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Gets the list of child objects contained in the specified folder.
ObjectData	getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension) Gets the specified information for the object specified by id.
List<ObjectParentData>	getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, ExtensionsData extension) Gets the parent folder(s) for the specified non-folder, fileable object.
RepositoryInfo	getRepositoryInfo(String repositoryId, ExtensionsData extension) Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.
List<RepositoryInfo>	getRepositoryInfos(ExtensionsData extension) Returns a list of CMIS repository information available from this CMIS service endpoint.
TypeDefinitionList	getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Returns the list of object types defined for the repository that are children of the specified type.
TypeDefinition	getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension) Gets the definition of the specified object type.

Methods inherited from class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisService

addObjectInfo, addObjectToFolder, appendContentStream, applyAcl, applyAcl, applyPolicy, bulkUpdateProperties, cancelCheckOut, checkIn, checkOut, clearObjectInfos, close, create, createDocument, createDocumentFromSource, createFolder, createItem, createPolicy, createRelationship, createType, deleteContentStream, deleteObject, deleteObjectOrCancelCheckOut, deleteTree, deleteType, getAcl, getAllowableActions, getAllVersions, getAppliedPolicies, getBooleanProperty, getCheckedOutDocs, getContentChanges, getContentStream, getDateTimeProperty, getDescendants, getFolderParent, getFolderTree, getIdProperty, getIntegerProperty, getObjectByPath, getObjectInfo, getObjectInfoIntern, getObjectOfLatestVersion, getObjectRelationships, getProperties, getPropertiesOfLatestVersion, getRenditions, getStringProperty, getTypeDescendants, moveObject, query, removeObjectFromFolder, removePolicy, setContentStream, updateProperties, updateType

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyService

public DummyService(String id,
            String name)

Method Detail

getRepositoryInfo

public RepositoryInfo getRepositoryInfo(String repositoryId,
                               ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required. Convenience implementation is present.

Specified by:

getRepositoryInfo in interface RepositoryService

Overrides:

getRepositoryInfo in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

getRepositoryInfos

public List<RepositoryInfo> getRepositoryInfos(ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns a list of CMIS repository information available from this CMIS service endpoint. In contrast to the CMIS specification this method returns repository infos not only repository ids.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getRepositoryInfos in interface RepositoryService

Specified by:

getRepositoryInfos in class AbstractCmisService

getChildren

public ObjectInFolderList getChildren(String repositoryId,
                             String folderId,
                             String filter,
                             String orderBy,
                             Boolean includeAllowableActions,
                             IncludeRelationships includeRelationships,
                             String renditionFilter,
                             Boolean includePathSegment,
                             BigInteger maxItems,
                             BigInteger skipCount,
                             ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of child objects contained in the specified folder.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the folder and all returned children.

Specified by:

getChildren in interface NavigationService

Specified by:

getChildren in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

orderBy - (optional) a comma-separated list of query names that define the order of the result set. Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC" (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

getObject

public ObjectData getObject(String repositoryId,
                   String objectId,
                   String filter,
                   Boolean includeAllowableActions,
                   IncludeRelationships includeRelationships,
                   String renditionFilter,
                   Boolean includePolicyIds,
                   Boolean includeAcl,
                   ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the specified information for the object specified by id.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the returned object.

Specified by:

getObject in interface ObjectService

Specified by:

getObject in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the allowable actions for the object (default is false)

includeRelationships - (optional) indicates what relationships in which the object participates must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePolicyIds - (optional) if true, then the repository must return the policy ids for the object (default is false)

includeAcl - (optional) if true, then the repository must return the ACL for the object (default is false)

getObjectParents

public List<ObjectParentData> getObjectParents(String repositoryId,
                                      String objectId,
                                      String filter,
                                      Boolean includeAllowableActions,
                                      IncludeRelationships includeRelationships,
                                      String renditionFilter,
                                      Boolean includeRelativePathSegment,
                                      ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the parent folder(s) for the specified non-folder, fileable object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the object and all returned parents.

Specified by:

getObjectParents in interface NavigationService

Specified by:

getObjectParents in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includeRelativePathSegment - (optional) if true, returns a relative path segment for each parent object for use in constructing that object's path (default is false)

getTypeChildren

public TypeDefinitionList getTypeChildren(String repositoryId,
                                 String typeId,
                                 Boolean includePropertyDefinitions,
                                 BigInteger maxItems,
                                 BigInteger skipCount,
                                 ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns the list of object types defined for the repository that are children of the specified type.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getTypeChildren in interface RepositoryService

Specified by:

getTypeChildren in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

typeId - (optional) the typeId of an object type specified in the repository (if not specified the repository MUST return all base object types)

includePropertyDefinitions - (optional) if true the repository MUST return the property definitions for each object type returned (default is false)

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

getTypeDefinition

public TypeDefinition getTypeDefinition(String repositoryId,
                               String typeId,
                               ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the definition of the specified object type.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getTypeDefinition in interface RepositoryService

Specified by:

getTypeDefinition in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

typeId - typeId of an object type specified in the repository