com.liferay.document.library.kernel.store

Interface Store

All Known Implementing Classes:

BaseStore

public interface Store

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

Author:

Brian Wing Shun Chan, Edward Han

See Also:

BaseStore

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_DEFAULT

Method Summary

Modifier and Type	Method and Description
void	addDirectory(long companyId, long repositoryId, String dirName)
void	addFile(long companyId, long repositoryId, String fileName, byte[] bytes)
void	addFile(long companyId, long repositoryId, String fileName, File file)
void	addFile(long companyId, long repositoryId, String fileName, InputStream is)
void	checkRoot(long companyId)
void	copyFileVersion(long companyId, long repositoryId, String fileName, String fromVersionLabel, String toVersionLabel)
void	deleteDirectory(long companyId, long repositoryId, String dirName)
void	deleteFile(long companyId, long repositoryId, String fileName)
void	deleteFile(long companyId, long repositoryId, String fileName, String versionLabel)
File	getFile(long companyId, long repositoryId, String fileName)
File	getFile(long companyId, long repositoryId, String fileName, String versionLabel)
byte[]	getFileAsBytes(long companyId, long repositoryId, String fileName)
byte[]	getFileAsBytes(long companyId, long repositoryId, String fileName, String versionLabel)
InputStream	getFileAsStream(long companyId, long repositoryId, String fileName)
InputStream	getFileAsStream(long companyId, long repositoryId, String fileName, String versionLabel)
String[]	getFileNames(long companyId, long repositoryId)
String[]	getFileNames(long companyId, long repositoryId, String dirName)
long	getFileSize(long companyId, long repositoryId, String fileName)
boolean	hasDirectory(long companyId, long repositoryId, String dirName)
boolean	hasFile(long companyId, long repositoryId, String fileName)
boolean	hasFile(long companyId, long repositoryId, String fileName, String versionLabel)
void	move(String srcDir, String destDir)
void	updateFile(long companyId, long repositoryId, long newRepositoryId, String fileName)
void	updateFile(long companyId, long repositoryId, String fileName, String newFileName)
void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, byte[] bytes)
void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, File file)
void	updateFile(long companyId, long repositoryId, String fileName, String versionLabel, InputStream is)
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)

addFile

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

Throws:

PortalException

addFile

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

Throws:

PortalException

addFile

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

Throws:

PortalException

checkRoot

void checkRoot(long companyId)

copyFileVersion

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

Throws:

PortalException

deleteDirectory

void deleteDirectory(long companyId,
                     long repositoryId,
                     String dirName)

deleteFile

void deleteFile(long companyId,
                long repositoryId,
                String fileName)

deleteFile

void deleteFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel)

getFile

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

Throws:

PortalException

getFile

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

Throws:

PortalException

getFileAsBytes

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

Throws:

PortalException

getFileAsBytes

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

Throws:

PortalException

getFileAsStream

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

Throws:

PortalException

getFileAsStream

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

Throws:

PortalException

getFileNames

String[] getFileNames(long companyId,
                      long repositoryId)

getFileNames

String[] getFileNames(long companyId,
                      long repositoryId,
                      String dirName)

getFileSize

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

Throws:

PortalException

hasDirectory

boolean hasDirectory(long companyId,
                     long repositoryId,
                     String dirName)

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                String fileName)

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                String fileName,
                String versionLabel)

move

void move(String srcDir,
          String destDir)

updateFile

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

Throws:

PortalException

updateFile

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

Throws:

PortalException

updateFile

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

Throws:

PortalException

updateFile

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

Throws:

PortalException

updateFile

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

Throws:

PortalException

updateFileVersion

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

Throws:

PortalException