com.liferay.portlet.documentlibrary.store
Interface Store

All Known Implementing Classes:

AdvancedFileSystemStore, BaseStore, CMISStore, DBStore, FileSystemStore, JCRStore, S3Store, SafeFileNameStoreWrapper, StoreProxyBean, StoreProxyImpl, StoreWrapper

public interface Store

The interface for all file store implementations. Most, if not all implementations should extend from the class BaseStore.

See Also:

BaseStore

Field Summary

static String

VERSION_DEFAULT

Method Summary

abstract void	addDirectory(long companyId, long repositoryId, String dirName)
abstract void	addFile(long companyId, long repositoryId, String fileName, byte[] bytes)
abstract void	addFile(long companyId, long repositoryId, String fileName, File file)
abstract void	addFile(long companyId, long repositoryId, String fileName, InputStream is)
abstract void	checkRoot(long companyId)
abstract void	copyFileVersion(long companyId, long repositoryId, String fileName, String fromVersionLabel, String toVersionLabel)
abstract void	deleteDirectory(long companyId, long repositoryId, String dirName)
abstract void	deleteFile(long companyId, long repositoryId, String fileName)
abstract void	deleteFile(long companyId, long repositoryId, String fileName, String versionLabel)
abstract File	getFile(long companyId, long repositoryId, String fileName)
abstract File	getFile(long companyId, long repositoryId, String fileName, String versionLabel)
abstract byte[]	getFileAsBytes(long companyId, long repositoryId, String fileName)
abstract byte[]	getFileAsBytes(long companyId, long repositoryId, String fileName, String versionLabel)
abstract InputStream	getFileAsStream(long companyId, long repositoryId, String fileName)
abstract InputStream	getFileAsStream(long companyId, long repositoryId, String fileName, String versionLabel)
abstract String[]	getFileNames(long companyId, long repositoryId)
abstract String[]	getFileNames(long companyId, long repositoryId, String dirName)
abstract long	getFileSize(long companyId, long repositoryId, String fileName)
abstract boolean	hasDirectory(long companyId, long repositoryId, String dirName)
abstract boolean	hasFile(long companyId, long repositoryId, String fileName)
abstract boolean	hasFile(long companyId, long repositoryId, String fileName, String versionLabel)
abstract void	move(String srcDir, String destDir)
abstract void	updateFile(long companyId, long repositoryId, long newRepositoryId, String fileName)
abstract void	updateFile(long companyId, long repositoryId, String fileName, String newFileName)
abstract void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, byte[] bytes)
abstract void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, File file)
abstract void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, InputStream is)
abstract void	updateFileVersion(long companyId, long repositoryId, String fileName, String fromVersionLabel, String toVersionLabel)

Field Detail

VERSION_DEFAULT

static final String VERSION_DEFAULT

See Also:

Constant Field Values

Method Detail

addDirectory

void addDirectory(long companyId,
                  long repositoryId,
                  String dirName)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             long repositoryId,
             String fileName,
             byte[] bytes)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             long repositoryId,
             String fileName,
             File file)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             long repositoryId,
             String fileName,
             InputStream is)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

checkRoot

void checkRoot(long companyId)
               throws SystemException

Throws:

SystemException

copyFileVersion

void copyFileVersion(long companyId,
                     long repositoryId,
                     String fileName,
                     String fromVersionLabel,
                     String toVersionLabel)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteDirectory

void deleteDirectory(long companyId,
                     long repositoryId,
                     String dirName)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFile

void deleteFile(long companyId,
                long repositoryId,
                String fileName)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteFile

void deleteFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getFile

File getFile(long companyId,
             long repositoryId,
             String fileName)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

getFile

File getFile(long companyId,
             long repositoryId,
             String fileName,
             String versionLabel)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

getFileAsBytes

byte[] getFileAsBytes(long companyId,
                      long repositoryId,
                      String fileName)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getFileAsBytes

byte[] getFileAsBytes(long companyId,
                      long repositoryId,
                      String fileName,
                      String versionLabel)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long repositoryId,
                            String fileName)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long repositoryId,
                            String fileName,
                            String versionLabel)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileNames

String[] getFileNames(long companyId,
                      long repositoryId)
                      throws SystemException

Throws:

SystemException

getFileNames

String[] getFileNames(long companyId,
                      long repositoryId,
                      String dirName)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getFileSize

long getFileSize(long companyId,
                 long repositoryId,
                 String fileName)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

hasDirectory

boolean hasDirectory(long companyId,
                     long repositoryId,
                     String dirName)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                String fileName)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

move

void move(String srcDir,
          String destDir)
          throws SystemException

Throws:

SystemException

updateFile

void updateFile(long companyId,
                long repositoryId,
                long newRepositoryId,
                String fileName)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                long repositoryId,
                String fileName,
                String newFileName)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel,
                byte[] bytes)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel,
                File file)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel,
                InputStream is)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFileVersion

void updateFileVersion(long companyId,
                       long repositoryId,
                       String fileName,
                       String fromVersionLabel,
                       String toVersionLabel)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException