com.openkm.extension.core

Interface DocumentExtension

All Superinterfaces:

Extension, net.xeoh.plugins.base.Plugin

public interface DocumentExtension
extends Extension

Method Summary

Modifier and Type	Method and Description
void	postCheckin(javax.jcr.Session session, Ref<javax.jcr.Node> docNode, Ref<Version> version) Executed POST document CHECK IN.
void	postCopy(javax.jcr.Session session, Ref<javax.jcr.Node> refSrcNode, Ref<javax.jcr.Node> refNewDocument, Ref<javax.jcr.Node> refDstFolderNode) Executed POST document COPY.
void	postCreate(javax.jcr.Session session, Ref<javax.jcr.Node> parentNode, Ref<javax.jcr.Node> docNode) Executed AFTER document CREATE.
void	postDelete(javax.jcr.Session session, String fileName) Executed POST document DELETE.
void	postMove(javax.jcr.Session session, String oldDocPath, Ref<javax.jcr.Node> srcFldNode, Ref<javax.jcr.Node> dstDocNode) Executed AFTER document MOVE.
void	postPurge(javax.jcr.Session session, String docPath) Executed POST document PURGE.
void	postRename(javax.jcr.Session session, String docPath, String newPath, Ref<javax.jcr.Node> refDocumentNode) Executed POST document RENAME.
void	postRestoreVersion(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed POST document RESTORE VERSION.
void	postSetContent(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed POST document SET CONTENT.
void	preCheckin(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed BEFORE document CHECK IN.
void	preCopy(javax.jcr.Session session, Ref<javax.jcr.Node> refSrcNode, Ref<javax.jcr.Node> refDstFolderNode) Executed BEFORE document COPY.
void	preCreate(javax.jcr.Session session, Ref<javax.jcr.Node> parentNode, Ref<File> content, Ref<Document> doc) Executed BEFORE document CREATE.
void	preDelete(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed BEFORE document DELETE.
void	preMove(javax.jcr.Session session, Ref<javax.jcr.Node> srcDocNode, Ref<javax.jcr.Node> dstFldNode) Executed BEFORE document MOVE.
void	prePurge(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed BEFORE document PURGE.
void	preRename(javax.jcr.Session session, String docPath, String newPath, Ref<javax.jcr.Node> refDocumentNode) Executed BEFORE document RENAME.
void	preRestoreVersion(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed BEFPRE document RESTORE VERSION.
void	preSetContent(javax.jcr.Session session, Ref<javax.jcr.Node> refDocumentNode) Executed BEFORE document SET CONTENT.

Methods inherited from interface com.openkm.extension.core.Extension

getOrder, getUuid

Method Detail

preCreate

void preCreate(javax.jcr.Session session,
               Ref<javax.jcr.Node> parentNode,
               Ref<File> content,
               Ref<Document> doc)
        throws UnsupportedMimeTypeException,
               FileSizeExceededException,
               UserQuotaExceededException,
               VirusDetectedException,
               ItemExistsException,
               PathNotFoundException,
               AccessDeniedException,
               RepositoryException,
               IOException,
               DatabaseException,
               ExtensionException

Executed BEFORE document CREATE.

Throws:

UnsupportedMimeTypeException

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

ItemExistsException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

ExtensionException

postCreate

void postCreate(javax.jcr.Session session,
                Ref<javax.jcr.Node> parentNode,
                Ref<javax.jcr.Node> docNode)
         throws UnsupportedMimeTypeException,
                FileSizeExceededException,
                UserQuotaExceededException,
                VirusDetectedException,
                ItemExistsException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                IOException,
                DatabaseException,
                ExtensionException

Executed AFTER document CREATE.

Throws:

UnsupportedMimeTypeException

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

ItemExistsException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

ExtensionException

preMove

void preMove(javax.jcr.Session session,
             Ref<javax.jcr.Node> srcDocNode,
             Ref<javax.jcr.Node> dstFldNode)
      throws PathNotFoundException,
             ItemExistsException,
             AccessDeniedException,
             RepositoryException,
             DatabaseException,
             ExtensionException

Executed BEFORE document MOVE.

Throws:

PathNotFoundException

ItemExistsException

AccessDeniedException

RepositoryException

DatabaseException

ExtensionException

postMove

void postMove(javax.jcr.Session session,
              String oldDocPath,
              Ref<javax.jcr.Node> srcFldNode,
              Ref<javax.jcr.Node> dstDocNode)
       throws PathNotFoundException,
              ItemExistsException,
              AccessDeniedException,
              RepositoryException,
              DatabaseException,
              ExtensionException

Executed AFTER document MOVE.

Parameters:

oldDocPath - - original docPath

Throws:

PathNotFoundException

ItemExistsException

AccessDeniedException

RepositoryException

DatabaseException

ExtensionException

preDelete

void preDelete(javax.jcr.Session session,
               Ref<javax.jcr.Node> refDocumentNode)
        throws AccessDeniedException,
               RepositoryException,
               PathNotFoundException,
               LockException,
               DatabaseException,
               ExtensionException

Executed BEFORE document DELETE.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

LockException

DatabaseException

ExtensionException

postDelete

void postDelete(javax.jcr.Session session,
                String fileName)
         throws AccessDeniedException,
                RepositoryException,
                PathNotFoundException,
                LockException,
                DatabaseException,
                ExtensionException

Executed POST document DELETE.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

LockException

DatabaseException

ExtensionException

preSetContent

void preSetContent(javax.jcr.Session session,
                   Ref<javax.jcr.Node> refDocumentNode)
            throws FileSizeExceededException,
                   UserQuotaExceededException,
                   VirusDetectedException,
                   VersionException,
                   LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   IOException,
                   DatabaseException,
                   ExtensionException

Executed BEFORE document SET CONTENT.

Throws:

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

VersionException

LockException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

ExtensionException

postSetContent

void postSetContent(javax.jcr.Session session,
                    Ref<javax.jcr.Node> refDocumentNode)
             throws FileSizeExceededException,
                    UserQuotaExceededException,
                    VirusDetectedException,
                    VersionException,
                    LockException,
                    PathNotFoundException,
                    AccessDeniedException,
                    RepositoryException,
                    IOException,
                    DatabaseException,
                    ExtensionException

Executed POST document SET CONTENT.

Throws:

FileSizeExceededException

UserQuotaExceededException

VirusDetectedException

VersionException

LockException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

ExtensionException

preRename

void preRename(javax.jcr.Session session,
               String docPath,
               String newPath,
               Ref<javax.jcr.Node> refDocumentNode)
        throws AccessDeniedException,
               RepositoryException,
               PathNotFoundException,
               ItemExistsException,
               DatabaseException,
               ExtensionException

Executed BEFORE document RENAME.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

ItemExistsException

DatabaseException

ExtensionException

postRename

void postRename(javax.jcr.Session session,
                String docPath,
                String newPath,
                Ref<javax.jcr.Node> refDocumentNode)
         throws AccessDeniedException,
                RepositoryException,
                PathNotFoundException,
                ItemExistsException,
                DatabaseException,
                ExtensionException

Executed POST document RENAME.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

ItemExistsException

DatabaseException

ExtensionException

preCheckin

void preCheckin(javax.jcr.Session session,
                Ref<javax.jcr.Node> refDocumentNode)
         throws AccessDeniedException,
                RepositoryException,
                PathNotFoundException,
                LockException,
                VersionException,
                DatabaseException,
                ExtensionException

Executed BEFORE document CHECK IN.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

LockException

VersionException

DatabaseException

ExtensionException

postCheckin

void postCheckin(javax.jcr.Session session,
                 Ref<javax.jcr.Node> docNode,
                 Ref<Version> version)
          throws AccessDeniedException,
                 RepositoryException,
                 PathNotFoundException,
                 LockException,
                 VersionException,
                 DatabaseException,
                 ExtensionException

Executed POST document CHECK IN.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

LockException

VersionException

DatabaseException

ExtensionException

prePurge

void prePurge(javax.jcr.Session session,
              Ref<javax.jcr.Node> refDocumentNode)
       throws AccessDeniedException,
              RepositoryException,
              PathNotFoundException,
              DatabaseException,
              ExtensionException

Executed BEFORE document PURGE.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

DatabaseException

ExtensionException

postPurge

void postPurge(javax.jcr.Session session,
               String docPath)
        throws AccessDeniedException,
               RepositoryException,
               PathNotFoundException,
               DatabaseException,
               ExtensionException

Executed POST document PURGE.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

DatabaseException

ExtensionException

preCopy

void preCopy(javax.jcr.Session session,
             Ref<javax.jcr.Node> refSrcNode,
             Ref<javax.jcr.Node> refDstFolderNode)
      throws ItemExistsException,
             PathNotFoundException,
             AccessDeniedException,
             RepositoryException,
             IOException,
             DatabaseException,
             UserQuotaExceededException,
             ExtensionException

Executed BEFORE document COPY.

Throws:

ItemExistsException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

UserQuotaExceededException

ExtensionException

postCopy

void postCopy(javax.jcr.Session session,
              Ref<javax.jcr.Node> refSrcNode,
              Ref<javax.jcr.Node> refNewDocument,
              Ref<javax.jcr.Node> refDstFolderNode)
       throws ItemExistsException,
              PathNotFoundException,
              AccessDeniedException,
              RepositoryException,
              IOException,
              DatabaseException,
              UserQuotaExceededException,
              ExtensionException

Executed POST document COPY.

Throws:

ItemExistsException

PathNotFoundException

AccessDeniedException

RepositoryException

IOException

DatabaseException

UserQuotaExceededException

ExtensionException

preRestoreVersion

void preRestoreVersion(javax.jcr.Session session,
                       Ref<javax.jcr.Node> refDocumentNode)
                throws AccessDeniedException,
                       RepositoryException,
                       PathNotFoundException,
                       DatabaseException,
                       ExtensionException

Executed BEFPRE document RESTORE VERSION.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

DatabaseException

ExtensionException

postRestoreVersion

void postRestoreVersion(javax.jcr.Session session,
                        Ref<javax.jcr.Node> refDocumentNode)
                 throws AccessDeniedException,
                        RepositoryException,
                        PathNotFoundException,
                        DatabaseException,
                        ExtensionException

Executed POST document RESTORE VERSION.

Throws:

AccessDeniedException

RepositoryException

PathNotFoundException

DatabaseException

ExtensionException