com.openkm.module.jcr.base

Class BaseDocumentModule

java.lang.Object

com.openkm.module.jcr.base.BaseDocumentModule

public class BaseDocumentModule
extends Object

Constructor Summary

Constructors

Constructor and Description
BaseDocumentModule()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.jcr.Node	copy(javax.jcr.Session session, javax.jcr.Node srcDocumentNode, javax.jcr.Node dstFolderNode) Is invoked from JcrDocumentNode and JcrFolderNode.
static javax.jcr.Node	create(javax.jcr.Session session, javax.jcr.Node parentNode, String name, String title, String mimeType, String[] keywords, InputStream is) Create a new document TODO Parameter title to be used in OpenKM 6
static InputStream	getContent(javax.jcr.Session session, javax.jcr.Node docNode) Retrieve the content InputStream from a given Node.
static InputStream	getContent(javax.jcr.Session session, String docPath, boolean checkout) Retrieve the content input stream from a document path
static LockInfo	getLockInfo(javax.jcr.Session session, String docPath) Retrieve lock info from a document path
static Document	getProperties(javax.jcr.Session session, javax.jcr.Node docNode) Get document properties using a given Session.
static void	purge(javax.jcr.Session session, javax.jcr.Node parentNode, javax.jcr.Node docNode) Remove version history, compute free space and remove obsolete files from PDF and previsualization cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDocumentModule

public BaseDocumentModule()

Method Detail

create

public static javax.jcr.Node create(javax.jcr.Session session,
                    javax.jcr.Node parentNode,
                    String name,
                    String title,
                    String mimeType,
                    String[] keywords,
                    InputStream is)
                             throws javax.jcr.ItemExistsException,
                                    javax.jcr.PathNotFoundException,
                                    javax.jcr.AccessDeniedException,
                                    javax.jcr.RepositoryException,
                                    IOException,
                                    DatabaseException,
                                    UserQuotaExceededException

Create a new document TODO Parameter title to be used in OpenKM 6

Throws:

javax.jcr.ItemExistsException

javax.jcr.PathNotFoundException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

IOException

DatabaseException

UserQuotaExceededException

getProperties

public static Document getProperties(javax.jcr.Session session,
                     javax.jcr.Node docNode)
                              throws javax.jcr.PathNotFoundException,
                                     javax.jcr.RepositoryException

Get document properties using a given Session.

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

getLockInfo

public static LockInfo getLockInfo(javax.jcr.Session session,
                   String docPath)
                            throws javax.jcr.UnsupportedRepositoryOperationException,
                                   javax.jcr.lock.LockException,
                                   javax.jcr.AccessDeniedException,
                                   javax.jcr.RepositoryException

Retrieve lock info from a document path

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

getContent

public static InputStream getContent(javax.jcr.Session session,
                     String docPath,
                     boolean checkout)
                              throws javax.jcr.PathNotFoundException,
                                     javax.jcr.RepositoryException,
                                     IOException

Retrieve the content input stream from a document path

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

IOException

getContent

public static InputStream getContent(javax.jcr.Session session,
                     javax.jcr.Node docNode)
                              throws javax.jcr.PathNotFoundException,
                                     javax.jcr.RepositoryException,
                                     IOException

Retrieve the content InputStream from a given Node.

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

IOException

purge

public static void purge(javax.jcr.Session session,
         javax.jcr.Node parentNode,
         javax.jcr.Node docNode)
                  throws javax.jcr.PathNotFoundException,
                         javax.jcr.RepositoryException

Remove version history, compute free space and remove obsolete files from PDF and previsualization cache.

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

copy

public static javax.jcr.Node copy(javax.jcr.Session session,
                  javax.jcr.Node srcDocumentNode,
                  javax.jcr.Node dstFolderNode)
                           throws javax.jcr.ValueFormatException,
                                  javax.jcr.PathNotFoundException,
                                  javax.jcr.RepositoryException,
                                  IOException,
                                  DatabaseException,
                                  UserQuotaExceededException

Is invoked from JcrDocumentNode and JcrFolderNode.

Throws:

javax.jcr.ValueFormatException

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

IOException

DatabaseException

UserQuotaExceededException