com.openkm.api

Class OKMDocument

java.lang.Object

com.openkm.api.OKMDocument

All Implemented Interfaces:

DocumentModule

public class OKMDocument
extends Object
implements DocumentModule

Author:

pavila

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckout(String token, String docPath) Cancel a previous checked out state in a document.
Version	checkin(String token, String docPath, InputStream is, String comment) Check in the document to create a new version.
void	checkout(String token, String docPath) Checkout the document to edit it.
void	copy(String token, String docPath, String destPath) Copy a document to another location in the repository.
Document	create(String token, Document doc, InputStream is) Creates a new document in the repository.
Document	createSimple(String token, String docPath, InputStream is)
void	delete(String token, String docPath) Deletes a document from the repository.
void	forceCancelCheckout(String token, String docPath) Force to cancel a previous checked out state in a document.
void	forceUnlock(String token, String docPath) For document unlock, so will be editable for other users.
List<Document>	getChildren(String token, String fldPath) Retrieve a list of children documents from an existing folder.
List<Document>	getChilds(String token, String fldPath) Deprecated.
InputStream	getContent(String token, String docPath, boolean checkout) Obtain document content from the repository.
InputStream	getContentByVersion(String token, String docPath, String versionId) Obtain document content from the repository.
static OKMDocument	getInstance()
LockInfo	getLockInfo(String token, String docPath) Returns a lock information.
String	getPath(String token, String uuid) Get the document path from a UUID
Document	getProperties(String token, String docPath) Obtain document properties from the repository.
List<Version>	getVersionHistory(String token, String docPath) Get the document version history.
long	getVersionHistorySize(String token, String docPath) Get the version size of a Document.
boolean	isCheckedOut(String token, String docPath) Test if a node has been already checked out.
boolean	isLocked(String token, String docPath) Tell if a document is locked.
boolean	isValid(String token, String docPath) Test if a document path is valid.
LockInfo	lock(String token, String docPath) Lock a document, so only is editable by the locker.
void	move(String token, String docPath, String destPath) Move a document to another location in the repository.
void	purge(String token, String docPath) Deletes definitively a document from the repository.
void	purgeVersionHistory(String token, String docPath) Purge a Document version history, so delete all previous versions but last one.
Document	rename(String token, String docPath, String newName) Rename a document in the repository.
void	restoreVersion(String token, String docPath, String versionId) Revert the document to an specific previous version.
void	setProperties(String token, Document doc) Set document properties in the repository.
void	unlock(String token, String docPath) Unlock a document, so will be editable for other users.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMDocument getInstance()

create

public Document create(String token,
              Document doc,
              InputStream is)
                throws UnsupportedMimeTypeException,
                       FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       ItemExistsException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException,
                       AutomationException

Description copied from interface: DocumentModule

Creates a new document in the repository.

Specified by:

create in interface DocumentModule

doc - A document object with the new document properties.

Returns:

A document object with the properties of the new created document.

Throws:

UnsupportedMimeTypeException - If the uploaded file has an unsupported MIME type.

FileSizeExceededException - If the document content is biggest than the maximum accepted.

ItemExistsException - If there is already a document in the repository with the same name.

PathNotFoundException - If the parent folder doesn't exist.

AccessDeniedException - If there is any security problem: you can't modify the parent document folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException - An error when inserting document data into the repository.

UserQuotaExceededException

VirusDetectedException

DatabaseException

ExtensionException

AutomationException

createSimple

public Document createSimple(String token,
                    String docPath,
                    InputStream is)
                      throws UnsupportedMimeTypeException,
                             FileSizeExceededException,
                             UserQuotaExceededException,
                             VirusDetectedException,
                             ItemExistsException,
                             PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             IOException,
                             DatabaseException,
                             ExtensionException,
                             AutomationException

Throws:

UnsupportedMimeTypeException

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

ItemExistsException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

ExtensionException

AutomationException

delete

public void delete(String token,
          String docPath)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException,
                   ExtensionException

Description copied from interface: DocumentModule

Deletes a document from the repository. It is a logical delete, so really is moved to the user trash and can be restored.

Specified by:

delete in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - Can't delete a locked document.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

ExtensionException

getProperties

public Document getProperties(String token,
                     String docPath)
                       throws RepositoryException,
                              PathNotFoundException,
                              DatabaseException

Description copied from interface: DocumentModule

Obtain document properties from the repository.

Specified by:

getProperties in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

The document properties.

Throws:

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no document in this repository path. you can't modify the document because of lack of permissions.

DatabaseException

getContent

public InputStream getContent(String token,
                     String docPath,
                     boolean checkout)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              IOException,
                              DatabaseException

Description copied from interface: DocumentModule

Obtain document content from the repository.

Specified by:

getContent in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

The content of the document file.

Throws:

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify this document because of lack of permissions. Related to extended security.

RepositoryException - If there is any general repository problem.

IOException - An error when retrieving document data from the repository.

DatabaseException

getContentByVersion

public InputStream getContentByVersion(String token,
                              String docPath,
                              String versionId)
                                throws RepositoryException,
                                       PathNotFoundException,
                                       IOException,
                                       DatabaseException

Description copied from interface: DocumentModule

Obtain document content from the repository.

Specified by:

getContentByVersion in interface DocumentModule

docPath - The path that identifies an unique document.

versionId - The id of the version to get the content from.

Returns:

The content of the document file.

Throws:

RepositoryException - If there is any general repository problem.

PathNotFoundException - If there is no folder in the repository with this path.

IOException - An error when retrieving document data from the repository.

DatabaseException

getChilds

@Deprecated
public List<Document> getChilds(String token,
                                  String fldPath)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Deprecated.

Description copied from interface: DocumentModule

Retrieve a list of child documents from an existing folder.

Specified by:

getChilds in interface DocumentModule

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child documents.

Throws:

PathNotFoundException - If there is no folder in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

getChildren

public List<Document> getChildren(String token,
                         String fldPath)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException

Description copied from interface: DocumentModule

Retrieve a list of children documents from an existing folder.

Specified by:

getChildren in interface DocumentModule

fldPath - The path that identifies an unique folder.

Returns:

A Collection with the child documents.

Throws:

PathNotFoundException - If there is no folder in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

rename

public Document rename(String token,
              String docPath,
              String newName)
                throws PathNotFoundException,
                       ItemExistsException,
                       AccessDeniedException,
                       LockException,
                       RepositoryException,
                       DatabaseException,
                       ExtensionException

Description copied from interface: DocumentModule

Rename a document in the repository.

Specified by:

rename in interface DocumentModule

docPath - The path that identifies an unique document.

newName - The new folder name.

Returns:

An document object with the new document properties.

Throws:

PathNotFoundException - If there is no document in this repository path.

ItemExistsException - If there is already a document in the repository with the same name in the same path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

setProperties

public void setProperties(String token,
                 Document doc)
                   throws LockException,
                          VersionException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException

Description copied from interface: DocumentModule

Set document properties in the repository.

Specified by:

setProperties in interface DocumentModule

doc - An document object with the properties

Throws:

LockException - A locked document can't be modified.

VersionException - A document checked in can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

checkout

public void checkout(String token,
            String docPath)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Description copied from interface: DocumentModule

Checkout the document to edit it. The document can't be edited by another user until it is checked in o the checkout is canceled.

Specified by:

checkout in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

cancelCheckout

public void cancelCheckout(String token,
                  String docPath)
                    throws LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException

Description copied from interface: DocumentModule

Cancel a previous checked out state in a document.

Specified by:

cancelCheckout in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

forceCancelCheckout

public void forceCancelCheckout(String token,
                       String docPath)
                         throws LockException,
                                PathNotFoundException,
                                AccessDeniedException,
                                RepositoryException,
                                DatabaseException,
                                PrincipalAdapterException

Description copied from interface: DocumentModule

Force to cancel a previous checked out state in a document.

Specified by:

forceCancelCheckout in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - A locked document can't be modified.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

PrincipalAdapterException

isCheckedOut

public boolean isCheckedOut(String token,
                   String docPath)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: DocumentModule

Test if a node has been already checked out.

Specified by:

isCheckedOut in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

True if the document is in checked out state, or false if not.

Throws:

PathNotFoundException - If there is no document in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

checkin

public Version checkin(String token,
              String docPath,
              InputStream is,
              String comment)
                throws FileSizeExceededException,
                       UserQuotaExceededException,
                       VirusDetectedException,
                       LockException,
                       VersionException,
                       PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       IOException,
                       DatabaseException,
                       ExtensionException

Description copied from interface: DocumentModule

Check in the document to create a new version.

Specified by:

checkin in interface DocumentModule

docPath - The path that identifies an unique document.

comment - A comment for this checkin.

Returns:

A version object with the properties of the new generated version.

Throws:

LockException - A locked document can't be modified.

VersionException - If the nodes was not previously checked out.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

IOException

DatabaseException

ExtensionException

getVersionHistory

public List<Version> getVersionHistory(String token,
                              String docPath)
                                throws PathNotFoundException,
                                       RepositoryException,
                                       DatabaseException

Description copied from interface: DocumentModule

Get the document version history.

Specified by:

getVersionHistory in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

A Collection of Versions with every document version.

Throws:

PathNotFoundException - If there is no document in this repository path.

RepositoryException - If there is any general repository problem.

DatabaseException

lock

public LockInfo lock(String token,
            String docPath)
              throws LockException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException

Description copied from interface: DocumentModule

Lock a document, so only is editable by the locker.

Specified by:

lock in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is already locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

unlock

public void unlock(String token,
          String docPath)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Description copied from interface: DocumentModule

Unlock a document, so will be editable for other users.

Specified by:

unlock in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is not locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

forceUnlock

public void forceUnlock(String token,
               String docPath)
                 throws LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PrincipalAdapterException

Description copied from interface: DocumentModule

For document unlock, so will be editable for other users. This action need to be perfomed by and administrator.

Specified by:

forceUnlock in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

LockException - If the node is not locked.

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

PrincipalAdapterException

isLocked

public boolean isLocked(String token,
               String docPath)
                 throws PathNotFoundException,
                        RepositoryException,
                        DatabaseException

Description copied from interface: DocumentModule

Tell if a document is locked.

Specified by:

isLocked in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

True if the document is locked, and False otherwise.

Throws:

PathNotFoundException - If there is no document in the repository with this path.

RepositoryException - If there is any repository problem.

DatabaseException

getLockInfo

public LockInfo getLockInfo(String token,
                   String docPath)
                     throws LockException,
                            PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: DocumentModule

Returns a lock information.

Specified by:

getLockInfo in interface DocumentModule

docPath - The path that identifies an unique document.

Returns:

The lock info.

Throws:

LockException - If the node is not locked.

PathNotFoundException - If there is no document in the repository with this path.

RepositoryException - If there is any repository problem.

DatabaseException

purge

public void purge(String token,
         String docPath)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  ExtensionException

Description copied from interface: DocumentModule

Deletes definitively a document from the repository. It is a physical delete, so the document can't be restored.

Specified by:

purge in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

PathNotFoundException - If there is no document in the repository with this path.

AccessDeniedException - If there is any security problem: you can't access this document because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

move

public void move(String token,
        String docPath,
        String destPath)
          throws PathNotFoundException,
                 ItemExistsException,
                 AccessDeniedException,
                 LockException,
                 RepositoryException,
                 DatabaseException,
                 ExtensionException,
                 AutomationException

Description copied from interface: DocumentModule

Move a document to another location in the repository.

Specified by:

move in interface DocumentModule

docPath - The path that identifies an unique document.

destPath - The destination folder path.

Throws:

PathNotFoundException - If the dstPath does not exists

ItemExistsException - If there is already a document in the destination folder with the same name.

AccessDeniedException - If there is any security problem: you can't modify the document's parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

AutomationException

copy

public void copy(String token,
        String docPath,
        String destPath)
          throws ItemExistsException,
                 PathNotFoundException,
                 AccessDeniedException,
                 RepositoryException,
                 IOException,
                 DatabaseException,
                 UserQuotaExceededException,
                 ExtensionException,
                 AutomationException

Description copied from interface: DocumentModule

Copy a document to another location in the repository.

Specified by:

copy in interface DocumentModule

docPath - The path that identifies an unique document.

destPath - The destination folder path.

Throws:

ItemExistsException - If there is already a document in the destination folder with the same name.

PathNotFoundException - If the dstPath does not exists

AccessDeniedException - If there is any security problem: you can't modify the document's parent folder or the destination folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

IOException

DatabaseException

UserQuotaExceededException

ExtensionException

AutomationException

restoreVersion

public void restoreVersion(String token,
                  String docPath,
                  String versionId)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           LockException,
                           RepositoryException,
                           DatabaseException,
                           ExtensionException

Description copied from interface: DocumentModule

Revert the document to an specific previous version.

Specified by:

restoreVersion in interface DocumentModule

docPath - The path that identifies an unique document.

versionId - The version id to revert to.

Throws:

PathNotFoundException - If there is no document in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the document because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

ExtensionException

purgeVersionHistory

public void purgeVersionHistory(String token,
                       String docPath)
                         throws PathNotFoundException,
                                AccessDeniedException,
                                LockException,
                                RepositoryException,
                                DatabaseException

Description copied from interface: DocumentModule

Purge a Document version history, so delete all previous versions but last one. Used to free Document version size.

Specified by:

purgeVersionHistory in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

PathNotFoundException - If there is no folder in the repository with this path.

AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.

RepositoryException - If there is any general repository problem.

LockException

DatabaseException

getVersionHistorySize

public long getVersionHistorySize(String token,
                         String docPath)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException

Description copied from interface: DocumentModule

Get the version size of a Document.

Specified by:

getVersionHistorySize in interface DocumentModule

docPath - The path that identifies an unique document.

Throws:

PathNotFoundException - If there is no folder in the repository with this path.

RepositoryException - If there is any general repository problem.

DatabaseException

isValid

public boolean isValid(String token,
              String docPath)
                throws PathNotFoundException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: DocumentModule

Test if a document path is valid.

Specified by:

isValid in interface DocumentModule

docPath - The path that identifies an unique document or its UUID.

Returns:

True if is a valid document path, otherwise false.

Throws:

PathNotFoundException - If the node does not exists.

RepositoryException - If there is any general repository problem.

DatabaseException

getPath

public String getPath(String token,
             String uuid)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: DocumentModule

Get the document path from a UUID

Specified by:

getPath in interface DocumentModule

uuid - The unique document id.

Returns:

The document path

Throws:

AccessDeniedException - If there is any security problem: you can't access this node because of lack of permissions.

RepositoryException - If there is any problem.

DatabaseException