The cmislib.model Module contains all the CMIS domain objects. When working with the repository, the first thing you need to do is grab an instance of cmislib.model.CmisClient, passing it the repository endpoint URL, username, and password.
>>> cmisClient = CmisClient('http://localhost:8080/alfresco/s/cmis', 'admin', 'admin')
From there you can get the default repository, or a specific repository if you know the repository ID.
>>> repo = cmisClient.getDefaultRepository()
Once you have that, you’re off to the races. Use the cmislib.model.Repository class to create new cmislib.model.Folder and cmislib.model.Document objects, perform searches, etc.
Module containing the domain objects used to work with a CMIS provider.
Handles all communication with the CMIS provider.
There does not appear to be anything in the spec that identifies a repository as being the default, so we’ll define it to be the first one in the list.
>>> repo = client.getDefaultRepository()
>>> repo.getRepositoryId()
u'83beb297-a6fa-4ac5-844b-98c871c0eea9'
Returns a dict of high-level info about the repositories available at this service. The dict contains entries for ‘repositoryId’ and ‘repositoryName’.
See CMIS specification document 2.2.2.1 getRepositories
>>> client.getRepositories()
[{'repositoryName': u'Main Repository', 'repositoryId': u'83beb297-a6fa-4ac5-844b-98c871c0eea9'}]
Returns the repository identified by the specified repositoryId.
This has not been implemented yet.
Common ancestor class for other CMIS domain objects such as Document and Folder.
Deletes this CmisObject from the repository.
See CMIS specification document 2.2.4.14 delete
The optional allVersions argument is not yet supported.
This has not yet been implemented.
See CMIS specification document 2.2.4.6 getAllowableActions
This has not yet been implemented.
See CMIS specification document 2.2.3.5 getObjectParents
Returns a dict of the object’s properties. If CMIS returns an empty element for a property, the property will be in the dict wiht a value of None.
See CMIS specification document 2.2.4.8 getProperties
The optional filter argument is not yet implemented.
This is not yet implemented.
See CMIS specification document 2.2.4.13 move
Updates the properties of an object with the properties provided. Only provide the set of properties that need to be updated.
See CMIS specification document 2.2.4.12 updateProperties
The optional changeToken is not yet supported.
An object typically associated with file content.
Checks in this Document which must be a private working copy (PWC).
See CMIS specification document 2.2.7.3 checkIn
Performs a checkout on the Document and returns the Private Working Copy (PWC), which is also an instance of Document
See CMIS specification document 2.2.7.1 checkout
This is not yet implemented.
See CMIS specification document 2.2.7.5 getAllVersions
The optional filter and includeAllowableActions arguments are not yet supported.
Returns the CMIS service response from invoking the ‘enclosure’ link.
See CMIS specification document 2.2.4.10 getContentStream
The optional streamId argument is not yet supported.
This is not yet implemented.
See CMIS specification document 2.2.7.4 getObjectOfLatestVersion
This is not yet implemented.
See CMIS specification document 2.2.7.4 getPropertiesOfLatestVersion
The optional major and filter arguments are not yet supported.
This is not yet implemented.
See CMIS specification document 2.2.8.1 getObjectRelationships
A container object that can hold other CmisObject objects
This is not yet implemented.
See CMIS specification document 2.2.5.1 addObjectToFolder
The optional allVersions argument is not yet supported.
Creates a new Document object in the repository using the properties provided.
Right now this is basically the same as createFolder, but this deals with contentStreams. The common logic should probably be moved to CmisObject.createObject.
Creates a new Folder using the properties provided. Right now I expect a property called ‘cmis:name’ but I don’t complain if it isn’t there (although the CMIS provider will)
See CMIS specification document 2.2.4.3 createFolder
This is not yet implemented.
See CMIS specification document 2.2.4.15 deleteTree
The optional allVersions argument is not yet supported.
Returns a list of CmisObjects for each child of the Folder.
See CMIS specification document 2.2.3.1 getChildren
Gets the descendants of this folder.
See CMIS specification document 2.2.3.2 getDescendants
This is not yet implemented.
See CMIS specification document 2.2.3.4 getFolderParent
The optional filter argument is not yet supported.
This is not yet implemented.
See CMIS specification document 2.2.3.3 getFolderTree
This is not yet implemented.
See CMIS specification document 2.2.5.2 removeObjectFromFolder
Represents the CMIS object type such as ‘cmis:document’ or ‘cmis:folder’. Contains metadata about the type.
Represents a CMIS repository. Will lazily populate itself by calling the repository CMIS service URL.
You must pass in an instance of a CmisClient when creating an instance of this class.
See CMIS specification document 2.1.1 Repository
Creates a new Document object. If the repository supports unfiled objects, you do not have to pass in a parent Folder otherwise it is required.
To create a document with an associated contentFile, pass in a contentFile object.
See CMIS specification document 2.2.4.1 createDocument
Creates a new Folder object in the specified parent.
See CMIS specification document 2.2.4.3 createFolder
This has not yet been implemented.
See CMIS specification document 2.2.4.5 createPolicy
This has not yet been implemented.
See CMIS specification document 2.2.4.4 createRelationship
Returns a dict of repository capabilities.
>>> caps = repo.getCapabilities()
>>> for k,v in caps.items():
... print "%s:%s" % (k,v)
...
PWCUpdatable:True
VersionSpecificFiling:False
Join:None
ContentStreamUpdatability:None
AllVersionsSearchable:False
Renditions:None
Multifiling:True
GetFolderTree:True
GetDescendants:True
ACL:None
PWCSearchable:True
Query:None
Unfiling:False
Changes:None
Returns a collection of CmisObject objects that are currently checked out.
See CMIS specification document 2.2.3.6 getCheckedOutDocs
Returns a Folder object for a specified folderId
>>> someFolder = repo.getFolder('workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348')
>>> someFolder.getObjectId()
u'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'
Returns an object given the specified object ID.
See CMIS specification document 2.2.4.7 getObject
Returns an object given the path to the object.
See CMIS specification document 2.2.4.9 getObjectByPath
Returns this repository’s unique identifier
>>> repo = client.getDefaultRepository()
>>> repo.getRepositoryId()
u'83beb297-a6fa-4ac5-844b-98c871c0eea9'
Returns a dict of repository information.
See CMIS specification document 2.2.2.2 getRepositoryInfo
>>> repo = client.getDefaultRepository()>>> repo.getRepositoryName()
u'Main Repository'
>>> info = repo.getRepositoryInfo()
>>> for k,v in info.items():
... print "%s:%s" % (k,v)
...
cmisSpecificationTitle:Version 1.0 Committee Draft 04
cmisVersionSupported:1.0
repositoryDescription:None
productVersion:3.2.0 (r2 2440)
rootFolderId:workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348
repositoryId:83beb297-a6fa-4ac5-844b-98c871c0eea9
repositoryName:Main Repository
vendorName:Alfresco
productName:Alfresco Repository (Community)
Returns this repository’s name
>>> repo = client.getDefaultRepository()
>>> repo.getRepositoryName()
u'Main Repository'
Returns the root folder of the repository
>>> root = repo.getRootFolder()
>>> root.getObjectId()
u'workspace://SpacesStore/aa1ecedf-9551-49c5-831a-0502bb43f348'
Returns a list of ObjectType objects corresponding to the child types of the type specified by the typeId.
If no typeId is provided, the result will be the same as calling self.getTypeDefinitions
See CMIS specification document 2.2.2.3 getTypeChildren
>>> baseTypes = repo.getTypeChildren()
>>> for baseType in baseTypes:
... print baseType.getTypeId()
...
cmis:folder
cmis:relationship
cmis:document
cmis:policy
Returns an ObjectType object for the specified object type id.
See CMIS specification document 2.2.2.5 getTypeDefinition
>>> folderType = repo.getTypeDefinition('cmis:folder')
Returns a list of ObjectType objects representing the base types in the repository.
>>> baseTypes = repo.getTypeDefinitions()
>>> for baseType in baseTypes:
... print baseType.getTypeId()
...
cmis:folder
cmis:relationship
cmis:document
cmis:policy
Returns a list of ObjectType objects corresponding to the descendant types of the type specified by the typeId.
If no typeId is provided, the repository’s “typesdescendants” URL will be called to determine the list of descendant types.
See CMIS specification document 2.2.2.4 getTypeDescendants
>>> allTypes = repo.getTypeDescendants()
>>> for aType in allTypes:
... print aType.getTypeId()
...
cmis:folder
F:cm:systemfolder
F:act:savedactionfolder
F:app:configurations
F:fm:forums
F:wcm:avmfolder
F:wcm:avmplainfolder
F:wca:webfolder
F:wcm:avmlayeredfolder
F:st:site
F:app:glossary
F:fm:topic
Returns a list of CmisObject objects based on the CMIS Query Language passed in as the statement.
In order for the results to be properly instantiated as objects, make sure you include ‘cmis:objectId’ as one of the fields in your select statement, or just use “SELECT *”.
See CMIS specification document 2.2.6.1 query
Replace in ‘text’ all occurences of any key in the given dictionary by its corresponding value. Returns the new string.
The cmislib.net Module contains the classes used by cmislib.model.CmisClient to communicate with the CMIS repository. The most important of which is cmislib.net.RESTService.
Module that knows how to connect to the AtomPub Binding of a CMIS repo
Generic service for interacting with an HTTP end point. Sets headers such as the USER_AGENT and builds the basic auth handler.