com.liferay.documentlibrary.util
Class BaseHook

java.lang.Object
  extended by com.liferay.documentlibrary.util.BaseHook
All Implemented Interfaces:
Hook
Direct Known Subclasses:
FileSystemHook, JCRHook, S3Hook

public abstract class BaseHook
extends java.lang.Object
implements Hook

View Source

Author:
Brian Wing Shun Chan

Field Summary
 
Fields inherited from interface com.liferay.documentlibrary.util.Hook
DEFAULT_VERSION
 
Constructor Summary
BaseHook()
           
 
Method Summary
abstract  void addDirectory(long companyId, long repositoryId, java.lang.String dirName)
           
 void addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, byte[] bytes)
           
 void addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, java.io.File file)
           
abstract  void addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, java.io.InputStream is)
           
abstract  void checkRoot(long companyId)
           
abstract  void deleteDirectory(long companyId, java.lang.String portletId, long repositoryId, java.lang.String dirName)
           
abstract  void deleteFile(long companyId, java.lang.String portletId, long repositoryId, java.lang.String fileName)
           
abstract  void deleteFile(long companyId, java.lang.String portletId, long repositoryId, java.lang.String fileName, double versionNumber)
           
 byte[] getFile(long companyId, long repositoryId, java.lang.String fileName)
           
 byte[] getFile(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
           
 java.io.InputStream getFileAsStream(long companyId, long repositoryId, java.lang.String fileName)
           
abstract  java.io.InputStream getFileAsStream(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
           
abstract  java.lang.String[] getFileNames(long companyId, long repositoryId, java.lang.String dirName)
           
abstract  long getFileSize(long companyId, long repositoryId, java.lang.String fileName)
           
abstract  boolean hasFile(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
           
abstract  void move(java.lang.String srcDir, java.lang.String destDir)
           
abstract  void reIndex(java.lang.String[] ids)
           
abstract  void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, long newRepositoryId, java.lang.String fileName, long fileEntryId)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, byte[] bytes)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, java.io.File file)
           
abstract  void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, java.io.InputStream is)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseHook

public BaseHook()
Method Detail

addDirectory

public abstract void addDirectory(long companyId,
                                  long repositoryId,
                                  java.lang.String dirName)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException
Specified by:
addDirectory in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFile

public void addFile(long companyId,
                    java.lang.String portletId,
                    long groupId,
                    long repositoryId,
                    java.lang.String fileName,
                    long fileEntryId,
                    java.lang.String properties,
                    java.util.Date modifiedDate,
                    java.lang.String[] tagsCategories,
                    java.lang.String[] tagsEntries,
                    byte[] bytes)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Specified by:
addFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFile

public void addFile(long companyId,
                    java.lang.String portletId,
                    long groupId,
                    long repositoryId,
                    java.lang.String fileName,
                    long fileEntryId,
                    java.lang.String properties,
                    java.util.Date modifiedDate,
                    java.lang.String[] tagsCategories,
                    java.lang.String[] tagsEntries,
                    java.io.File file)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Specified by:
addFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFile

public abstract void addFile(long companyId,
                             java.lang.String portletId,
                             long groupId,
                             long repositoryId,
                             java.lang.String fileName,
                             long fileEntryId,
                             java.lang.String properties,
                             java.util.Date modifiedDate,
                             java.lang.String[] tagsCategories,
                             java.lang.String[] tagsEntries,
                             java.io.InputStream is)
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException
Specified by:
addFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

checkRoot

public abstract void checkRoot(long companyId)
                        throws com.liferay.portal.SystemException
Specified by:
checkRoot in interface Hook
Throws:
com.liferay.portal.SystemException

deleteDirectory

public abstract void deleteDirectory(long companyId,
                                     java.lang.String portletId,
                                     long repositoryId,
                                     java.lang.String dirName)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Specified by:
deleteDirectory in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteFile

public abstract void deleteFile(long companyId,
                                java.lang.String portletId,
                                long repositoryId,
                                java.lang.String fileName)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Specified by:
deleteFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteFile

public abstract void deleteFile(long companyId,
                                java.lang.String portletId,
                                long repositoryId,
                                java.lang.String fileName,
                                double versionNumber)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Specified by:
deleteFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFile

public byte[] getFile(long companyId,
                      long repositoryId,
                      java.lang.String fileName)
               throws com.liferay.portal.PortalException,
                      com.liferay.portal.SystemException
Specified by:
getFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFile

public byte[] getFile(long companyId,
                      long repositoryId,
                      java.lang.String fileName,
                      double versionNumber)
               throws com.liferay.portal.PortalException,
                      com.liferay.portal.SystemException
Specified by:
getFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileAsStream

public java.io.InputStream getFileAsStream(long companyId,
                                           long repositoryId,
                                           java.lang.String fileName)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Specified by:
getFileAsStream in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileAsStream

public abstract java.io.InputStream getFileAsStream(long companyId,
                                                    long repositoryId,
                                                    java.lang.String fileName,
                                                    double versionNumber)
                                             throws com.liferay.portal.PortalException,
                                                    com.liferay.portal.SystemException
Specified by:
getFileAsStream in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileNames

public abstract java.lang.String[] getFileNames(long companyId,
                                                long repositoryId,
                                                java.lang.String dirName)
                                         throws com.liferay.portal.PortalException,
                                                com.liferay.portal.SystemException
Specified by:
getFileNames in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileSize

public abstract long getFileSize(long companyId,
                                 long repositoryId,
                                 java.lang.String fileName)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Specified by:
getFileSize in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

hasFile

public abstract boolean hasFile(long companyId,
                                long repositoryId,
                                java.lang.String fileName,
                                double versionNumber)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Specified by:
hasFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

move

public abstract void move(java.lang.String srcDir,
                          java.lang.String destDir)
                   throws com.liferay.portal.SystemException
Specified by:
move in interface Hook
Throws:
com.liferay.portal.SystemException

reIndex

public abstract void reIndex(java.lang.String[] ids)
                      throws com.liferay.portal.kernel.search.SearchException
Specified by:
reIndex in interface Hook
Throws:
com.liferay.portal.kernel.search.SearchException

updateFile

public void updateFile(long companyId,
                       java.lang.String portletId,
                       long groupId,
                       long repositoryId,
                       java.lang.String fileName,
                       double versionNumber,
                       java.lang.String sourceFileName,
                       long fileEntryId,
                       java.lang.String properties,
                       java.util.Date modifiedDate,
                       java.lang.String[] tagsCategories,
                       java.lang.String[] tagsEntries,
                       byte[] bytes)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException
Specified by:
updateFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

public void updateFile(long companyId,
                       java.lang.String portletId,
                       long groupId,
                       long repositoryId,
                       java.lang.String fileName,
                       double versionNumber,
                       java.lang.String sourceFileName,
                       long fileEntryId,
                       java.lang.String properties,
                       java.util.Date modifiedDate,
                       java.lang.String[] tagsCategories,
                       java.lang.String[] tagsEntries,
                       java.io.File file)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException
Specified by:
updateFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

public abstract void updateFile(long companyId,
                                java.lang.String portletId,
                                long groupId,
                                long repositoryId,
                                java.lang.String fileName,
                                double versionNumber,
                                java.lang.String sourceFileName,
                                long fileEntryId,
                                java.lang.String properties,
                                java.util.Date modifiedDate,
                                java.lang.String[] tagsCategories,
                                java.lang.String[] tagsEntries,
                                java.io.InputStream is)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Specified by:
updateFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

public abstract void updateFile(long companyId,
                                java.lang.String portletId,
                                long groupId,
                                long repositoryId,
                                long newRepositoryId,
                                java.lang.String fileName,
                                long fileEntryId)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Specified by:
updateFile in interface Hook
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException