org.apache.chemistry.opencmis.client.runtime

Class DocumentImpl

java.lang.Object

org.apache.chemistry.opencmis.client.runtime.AbstractCmisObject

org.apache.chemistry.opencmis.client.runtime.AbstractFilableCmisObject

org.apache.chemistry.opencmis.client.runtime.DocumentImpl

All Implemented Interfaces:

Serializable, CmisObject, CmisObjectProperties, Document, DocumentProperties, FileableCmisObject, ObjectId

public class DocumentImpl
extends AbstractFilableCmisObject
implements Document

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentImpl(SessionImpl session, ObjectType objectType, ObjectData objectData, OperationContext context) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Document	appendContentStream(ContentStream contentStream, boolean isLastChunk) Appends a content stream to the content stream of the document and refreshes this object afterwards.
ObjectId	appendContentStream(ContentStream contentStream, boolean isLastChunk, boolean refresh) Appends a content stream to the content stream of the document.
void	cancelCheckOut() If this is a PWC (private working copy) the check out will be reversed.
ObjectId	checkIn(boolean major, Map<String,?> properties, ContentStream contentStream, String checkinComment) If this is a PWC (private working copy) it performs a check in.
ObjectId	checkIn(boolean major, Map<String,?> properties, ContentStream contentStream, String checkinComment, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) If this is a PWC (private working copy) it performs a check in.
ObjectId	checkOut() Checks out the document and returns the object ID of the PWC (private working copy).
Document	copy(ObjectId targetFolderId) Creates a copy of this document, including content.
Document	copy(ObjectId targetFolderId, Map<String,?> properties, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces, OperationContext context) Creates a copy of this document, including content.
protected ObjectId	copyViaClient(ObjectId targetFolderId, Map<String,?> properties, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Copies the document manually.
void	deleteAllVersions() Deletes this document and all its versions.
Document	deleteContentStream() Removes the current content stream from the document and refreshes this object afterwards.
ObjectId	deleteContentStream(boolean refresh) Removes the current content stream from the document.
List<Document>	getAllVersions() Fetches all versions of this document.
List<Document>	getAllVersions(OperationContext context) Fetches all versions of this document using the given OperationContext.
String	getCheckinComment() Returns the checkin comment (CMIS property cmis:checkinComment).
ContentStream	getContentStream() Retrieves the content stream of this document.
ContentStream	getContentStream(BigInteger offset, BigInteger length) Retrieves the content stream of this document.
ContentStream	getContentStream(String streamId) Retrieves the content stream that is associated with the given stream ID.
ContentStream	getContentStream(String streamId, BigInteger offset, BigInteger length) Retrieves the content stream that is associated with the given stream ID.
String	getContentStreamFileName() Returns the content stream filename or null if the document has no content (CMIS property cmis:contentStreamFileName).
List<ContentStreamHash>	getContentStreamHashes() Returns the content hashes or null if the document has no content (CMIS property cmis:contentStreamHash).
String	getContentStreamId() Returns the content stream ID or null if the document has no content (CMIS property cmis:contentStreamId).
long	getContentStreamLength() Returns the content stream length or -1 if the document has no content (CMIS property cmis:contentStreamLength).
String	getContentStreamMimeType() Returns the content stream MIME type or null if the document has no content (CMIS property cmis:contentStreamMimeType).
String	getContentUrl() Returns the content URL of the document if the binding supports content URLs.
String	getContentUrl(String streamId) Returns the content URL of the document or a rendition if the binding supports content URLs.
Document	getObjectOfLatestVersion(boolean major) Fetches the latest major or minor version of this document.
Document	getObjectOfLatestVersion(boolean major, OperationContext context) Fetches the latest major or minor version of this document using the given OperationContext.
String	getVersionLabel() Returns the version label (CMIS property cmis:versionLabel).
String	getVersionSeriesCheckedOutBy() Returns the user who checked out this version series (CMIS property cmis:versionSeriesCheckedOutBy).
String	getVersionSeriesCheckedOutId() Returns the PWC ID of this version series (CMIS property cmis:versionSeriesCheckedOutId).
String	getVersionSeriesId() Returns the version series ID (CMIS property cmis:versionSeriesId ).
Boolean	isImmutable() Returns true if this document is immutable (CMIS property cmis:isImmutable).
Boolean	isLatestMajorVersion() Returns true if this document is the latest major version (CMIS property cmis:isLatestMajorVersion).
Boolean	isLatestVersion() Returns true if this document is the latest version (CMIS property cmis:isLatestVersion).
Boolean	isMajorVersion() Returns true if this document is a major version (CMIS property cmis:isMajorVersion).
Boolean	isPrivateWorkingCopy() Returns true if this document is the PWC (CMIS property cmis:isPrivateWorkingCopy).
Boolean	isVersionSeriesCheckedOut() Returns true if this version series is checked out (CMIS property cmis:isVersionSeriesCheckedOut).
Document	setContentStream(ContentStream contentStream, boolean overwrite) Sets a new content stream for the document and refreshes this object afterwards.
ObjectId	setContentStream(ContentStream contentStream, boolean overwrite, boolean refresh) Sets a new content stream for the document.

Methods inherited from class org.apache.chemistry.opencmis.client.runtime.AbstractFilableCmisObject

addToFolder, getParents, getParents, getPaths, move, move, removeFromFolder

Methods inherited from class org.apache.chemistry.opencmis.client.runtime.AbstractCmisObject

addAcl, applyAcl, applyPolicy, delete, delete, findObjectType, getAcl, getAcl, getAdapter, getAllowableActions, getBaseType, getBaseTypeId, getBinding, getChangeToken, getCreatedBy, getCreationContext, getCreationDate, getDescription, getExtensions, getId, getLastModificationDate, getLastModifiedBy, getName, getObjectFactory, getObjectId, getObjectType, getPermissionsForPrincipal, getPermissonsForPrincipal, getPolicies, getProperties, getProperty, getPropertyQueryName, getPropertyValue, getRefreshTimestamp, getRelationships, getRenditions, getRepositoryId, getSecondaryTypes, getSession, getType, hasAllowableAction, initialize, readLock, readUnlock, refresh, refreshIfOld, removeAcl, removePolicy, rename, rename, setAcl, toString, updateProperties, updateProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.chemistry.opencmis.client.api.FileableCmisObject

addToFolder, getParents, getParents, getPaths, move, move, removeFromFolder

Methods inherited from interface org.apache.chemistry.opencmis.client.api.CmisObject

addAcl, applyAcl, applyPolicy, delete, delete, getAcl, getAdapter, getAllowableActions, getExtensions, getPermissionsForPrincipal, getPermissonsForPrincipal, getPolicies, getRefreshTimestamp, getRelationships, getRenditions, hasAllowableAction, refresh, refreshIfOld, removeAcl, removePolicy, rename, rename, setAcl, updateProperties, updateProperties

Methods inherited from interface org.apache.chemistry.opencmis.client.api.ObjectId

getId

Methods inherited from interface org.apache.chemistry.opencmis.client.api.CmisObjectProperties

findObjectType, getBaseType, getBaseTypeId, getChangeToken, getCreatedBy, getCreationDate, getDescription, getLastModificationDate, getLastModifiedBy, getName, getProperties, getProperty, getPropertyValue, getSecondaryTypes, getType

Constructor Detail

DocumentImpl

public DocumentImpl(SessionImpl session,
            ObjectType objectType,
            ObjectData objectData,
            OperationContext context)

Constructor.

Method Detail

getCheckinComment

public String getCheckinComment()

Description copied from interface: DocumentProperties

Returns the checkin comment (CMIS property cmis:checkinComment).

Specified by:

getCheckinComment in interface DocumentProperties

Returns:

the checkin comment of this version or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getVersionLabel

public String getVersionLabel()

Description copied from interface: DocumentProperties

Returns the version label (CMIS property cmis:versionLabel).

Specified by:

getVersionLabel in interface DocumentProperties

Returns:

the version label of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getVersionSeriesId

public String getVersionSeriesId()

Description copied from interface: DocumentProperties

Returns the version series ID (CMIS property cmis:versionSeriesId ).

Specified by:

getVersionSeriesId in interface DocumentProperties

Returns:

the version series ID of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getVersionSeriesCheckedOutId

public String getVersionSeriesCheckedOutId()

Description copied from interface: DocumentProperties

Returns the PWC ID of this version series (CMIS property cmis:versionSeriesCheckedOutId).

Some repositories provided this value only to the user who checked out the version series.

Specified by:

getVersionSeriesCheckedOutId in interface DocumentProperties

Returns:

the PWC ID of this version series or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getVersionSeriesCheckedOutBy

public String getVersionSeriesCheckedOutBy()

Description copied from interface: DocumentProperties

Returns the user who checked out this version series (CMIS property cmis:versionSeriesCheckedOutBy).

Specified by:

getVersionSeriesCheckedOutBy in interface DocumentProperties

Returns:

the user who checked out this version series or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isImmutable

public Boolean isImmutable()

Description copied from interface: DocumentProperties

Returns true if this document is immutable (CMIS property cmis:isImmutable).

Specified by:

isImmutable in interface DocumentProperties

Returns:

the immutable flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isLatestMajorVersion

public Boolean isLatestMajorVersion()

Description copied from interface: DocumentProperties

Returns true if this document is the latest major version (CMIS property cmis:isLatestMajorVersion).

Specified by:

isLatestMajorVersion in interface DocumentProperties

Returns:

the latest major version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isLatestVersion

public Boolean isLatestVersion()

Description copied from interface: DocumentProperties

Returns true if this document is the latest version (CMIS property cmis:isLatestVersion).

Specified by:

isLatestVersion in interface DocumentProperties

Returns:

the latest version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isMajorVersion

public Boolean isMajorVersion()

Description copied from interface: DocumentProperties

Returns true if this document is a major version (CMIS property cmis:isMajorVersion).

Specified by:

isMajorVersion in interface DocumentProperties

Returns:

the major version flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isPrivateWorkingCopy

public Boolean isPrivateWorkingCopy()

Description copied from interface: DocumentProperties

Returns true if this document is the PWC (CMIS property cmis:isPrivateWorkingCopy).

Specified by:

isPrivateWorkingCopy in interface DocumentProperties

Returns:

the PWC flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

isVersionSeriesCheckedOut

public Boolean isVersionSeriesCheckedOut()

Description copied from interface: DocumentProperties

Returns true if this version series is checked out (CMIS property cmis:isVersionSeriesCheckedOut).

Specified by:

isVersionSeriesCheckedOut in interface DocumentProperties

Returns:

the version series checked out flag of the document or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getContentStreamLength

public long getContentStreamLength()

Description copied from interface: DocumentProperties

Returns the content stream length or -1 if the document has no content (CMIS property cmis:contentStreamLength).

Specified by:

getContentStreamLength in interface DocumentProperties

Returns:

the content stream length of this document or -1 if the property hasn't been requested, hasn't been provided by the repository, or the document has no content

getContentStreamMimeType

public String getContentStreamMimeType()

Description copied from interface: DocumentProperties

Returns the content stream MIME type or null if the document has no content (CMIS property cmis:contentStreamMimeType).

Specified by:

getContentStreamMimeType in interface DocumentProperties

Returns:

the content stream MIME type of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content

getContentStreamFileName

public String getContentStreamFileName()

Description copied from interface: DocumentProperties

Returns the content stream filename or null if the document has no content (CMIS property cmis:contentStreamFileName).

Specified by:

getContentStreamFileName in interface DocumentProperties

Returns:

the content stream filename of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content

getContentStreamId

public String getContentStreamId()

Description copied from interface: DocumentProperties

Returns the content stream ID or null if the document has no content (CMIS property cmis:contentStreamId).

Specified by:

getContentStreamId in interface DocumentProperties

Returns:

the content stream ID of this document or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content

getContentStreamHashes

public List<ContentStreamHash> getContentStreamHashes()

Description copied from interface: DocumentProperties

Returns the content hashes or null if the document has no content (CMIS property cmis:contentStreamHash).

Specified by:

getContentStreamHashes in interface DocumentProperties

Returns:

the list of content hashes or null if the property hasn't been requested, hasn't been provided by the repository, or the document has no content

copy

public Document copy(ObjectId targetFolderId,
            Map<String,?> properties,
            VersioningState versioningState,
            List<Policy> policies,
            List<Ace> addAces,
            List<Ace> removeAces,
            OperationContext context)

Description copied from interface: Document

Creates a copy of this document, including content.

Specified by:

copy in interface Document

Parameters:

targetFolderId - the ID of the target folder, null to create an unfiled document

Returns:

the new document object or null if the parameter context was set to null

copy

public Document copy(ObjectId targetFolderId)

Description copied from interface: Document

Creates a copy of this document, including content.

Specified by:

copy in interface Document

Parameters:

targetFolderId - the ID of the target folder, null to create an unfiled document

Returns:

the new document object

copyViaClient

protected ObjectId copyViaClient(ObjectId targetFolderId,
                     Map<String,?> properties,
                     VersioningState versioningState,
                     List<Policy> policies,
                     List<Ace> addAces,
                     List<Ace> removeAces)

Copies the document manually. The content is streamed from the repository and back.

deleteAllVersions

public void deleteAllVersions()

Description copied from interface: Document

Deletes this document and all its versions.

Specified by:

deleteAllVersions in interface Document

checkOut

public ObjectId checkOut()

Description copied from interface: Document

Checks out the document and returns the object ID of the PWC (private working copy).

Specified by:

checkOut in interface Document

Returns:

PWC object ID

cancelCheckOut

public void cancelCheckOut()

Description copied from interface: Document

If this is a PWC (private working copy) the check out will be reversed. If this is not a PWC it an exception will be thrown.

Specified by:

cancelCheckOut in interface Document

checkIn

public ObjectId checkIn(boolean major,
               Map<String,?> properties,
               ContentStream contentStream,
               String checkinComment,
               List<Policy> policies,
               List<Ace> addAces,
               List<Ace> removeAces)

Description copied from interface: Document

If this is a PWC (private working copy) it performs a check in. If this is not a PWC it an exception will be thrown. The stream in contentStream is consumed but not closed by this method.

Specified by:

checkIn in interface Document

Returns:

new document ID

getAllVersions

public List<Document> getAllVersions()

Description copied from interface: Document

Fetches all versions of this document.

The behavior of this method is undefined if the document is not versionable and can be different for each repository.

Specified by:

getAllVersions in interface Document

Returns:

all versions of the version series, sorted by cmis:creationDate descending and preceded by the PWC, if one exists, not null

getAllVersions

public List<Document> getAllVersions(OperationContext context)

Description copied from interface: Document

Fetches all versions of this document using the given OperationContext.

The behavior of this method is undefined if the document is not versionable and can be different for each repository.

Specified by:

getAllVersions in interface Document

Returns:

all versions of the version series, sorted by cmis:creationDate descending and preceded by the PWC, if one exists, not null

getObjectOfLatestVersion

public Document getObjectOfLatestVersion(boolean major)

Description copied from interface: Document

Fetches the latest major or minor version of this document.

Specified by:

getObjectOfLatestVersion in interface Document

Parameters:

major - if true the latest major version will be returned, otherwise the very last version will be returned

Returns:

the latest document object

getObjectOfLatestVersion

public Document getObjectOfLatestVersion(boolean major,
                                OperationContext context)

Description copied from interface: Document

Fetches the latest major or minor version of this document using the given OperationContext.

Specified by:

getObjectOfLatestVersion in interface Document

Parameters:

major - if true the latest major version will be returned, otherwise the very last version will be returned

Returns:

the latest document object

getContentStream

public ContentStream getContentStream()

Description copied from interface: Document

Retrieves the content stream of this document.

Specified by:

getContentStream in interface Document

Returns:

the content stream, or null if the document has no content

getContentStream

public ContentStream getContentStream(BigInteger offset,
                             BigInteger length)

Description copied from interface: Document

Retrieves the content stream of this document.

Specified by:

getContentStream in interface Document

Parameters:

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream, or null if the document has no content

getContentStream

public ContentStream getContentStream(String streamId)

Description copied from interface: Document

Retrieves the content stream that is associated with the given stream ID. This is usually a rendition of the document.

Specified by:

getContentStream in interface Document

Parameters:

streamId - the stream ID

Returns:

the content stream, or null if no content is associated with this stream ID

getContentStream

public ContentStream getContentStream(String streamId,
                             BigInteger offset,
                             BigInteger length)

Description copied from interface: Document

Retrieves the content stream that is associated with the given stream ID. This is usually a rendition of the document.

Specified by:

getContentStream in interface Document

Parameters:

streamId - the stream ID

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream, or null if no content is associated with this stream ID

getContentUrl

public String getContentUrl()

Description copied from interface: Document

Returns the content URL of the document if the binding supports content URLs. Depending on the repository and the binding, the server might not return the content but an error message. Authentication data is not attached. That is, a user may have to re-authenticate to get the content.

Specified by:

getContentUrl in interface Document

Returns:

the content URL of the document or null if the binding does not support content URLs

getContentUrl

public String getContentUrl(String streamId)

Description copied from interface: Document

Returns the content URL of the document or a rendition if the binding supports content URLs. Depending on the repository and the binding, the server might not return the content but an error message. Authentication data is not attached. That is, a user may have to re-authenticate to get the content.

Specified by:

getContentUrl in interface Document

Parameters:

streamId - the ID of the rendition or null for the document

Returns:

the content URL of the document or rendition or null if the binding does not support content URLs

setContentStream

public Document setContentStream(ContentStream contentStream,
                        boolean overwrite)

Description copied from interface: Document

Sets a new content stream for the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Specified by:

setContentStream in interface Document

Parameters:

contentStream - the content stream

overwrite - if this parameter is set to false and the document already has content, the repository throws a CmisContentAlreadyExistsException

Returns:

the updated document, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

setContentStream

public ObjectId setContentStream(ContentStream contentStream,
                        boolean overwrite,
                        boolean refresh)

Description copied from interface: Document

Sets a new content stream for the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Specified by:

setContentStream in interface Document

Parameters:

contentStream - the content stream

overwrite - if this parameter is set to false and the document already has content, the repository throws a CmisContentAlreadyExistsException

refresh - if this parameter is set to true, this object will be refreshed after the new content has been set

Returns:

the updated object ID, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

appendContentStream

public Document appendContentStream(ContentStream contentStream,
                           boolean isLastChunk)

Description copied from interface: Document

Appends a content stream to the content stream of the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Specified by:

appendContentStream in interface Document

Parameters:

contentStream - the content stream

isLastChunk - indicates if this stream is the last chunk of the content

Returns:

the updated document, or null if the repository did not return an object ID

See Also:

ObjectFactory.createContentStream(String, long, String, java.io.InputStream)

appendContentStream

public ObjectId appendContentStream(ContentStream contentStream,
                           boolean isLastChunk,
                           boolean refresh)

Description copied from interface: Document

Appends a content stream to the content stream of the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

The stream in contentStream is consumed but not closed by this method.

Specified by:

appendContentStream in interface Document

Parameters:

contentStream - the content stream

isLastChunk - indicates if this stream is the last chunk of the content

refresh - if this parameter is set to true, this object will be refreshed after the content stream has been appended

Returns:

the updated object ID, or null if the repository did not return an object ID

deleteContentStream

public Document deleteContentStream()

Description copied from interface: Document

Removes the current content stream from the document and refreshes this object afterwards. If the repository created a new version, this new document is returned. Otherwise the current document is returned.

Specified by:

deleteContentStream in interface Document

Returns:

the updated document, or null if the repository did not return an object ID

deleteContentStream

public ObjectId deleteContentStream(boolean refresh)

Description copied from interface: Document

Removes the current content stream from the document. If the repository created a new version, the object ID of this new version is returned. Otherwise the object ID of the current document is returned.

Specified by:

deleteContentStream in interface Document

Parameters:

refresh - if this parameter is set to true, this object will be refreshed after the content stream has been deleted

Returns:

the updated document, or null if the repository did not return an object ID

checkIn

public ObjectId checkIn(boolean major,
               Map<String,?> properties,
               ContentStream contentStream,
               String checkinComment)

Description copied from interface: Document

If this is a PWC (private working copy) it performs a check in. If this is not a PWC it an exception will be thrown. The stream in contentStream is consumed but not closed by this method.

Specified by:

checkIn in interface Document

Returns:

new document ID