com.liferay.document.library.kernel.store

Class StoreAreaAwareStoreWrapper

java.lang.Object

com.liferay.document.library.kernel.store.StoreAreaAwareStoreWrapper

All Implemented Interfaces:

Store

public class StoreAreaAwareStoreWrapper
extends java.lang.Object
implements Store

Author:

Adolfo Pérez

Field Summary

Fields inherited from interface com.liferay.document.library.kernel.store.Store

VERSION_DEFAULT

Constructor Summary

Constructors

Constructor and Description
StoreAreaAwareStoreWrapper(java.util.function.Supplier<Store> storeSupplier, java.util.function.Supplier<StoreAreaProcessor> storeAreaProcessorSupplier)

Method Summary

Modifier and Type	Method and Description
void	addFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel, java.io.InputStream inputStream) Adds a file based on an InputStream object.
void	deleteDirectory(long companyId, long repositoryId, java.lang.String dirName) Deletes a directory.
void	deleteFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Deletes a file at a particular version.
java.io.InputStream	getFileAsStream(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns the file as an InputStream object.
java.lang.String[]	getFileNames(long companyId, long repositoryId, java.lang.String dirName) Returns all files of the directory.
long	getFileSize(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns the size of the file.
java.lang.String[]	getFileVersions(long companyId, long repositoryId, java.lang.String fileName)
boolean	hasFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String versionLabel) Returns true if the file exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreAreaAwareStoreWrapper

public StoreAreaAwareStoreWrapper(java.util.function.Supplier<Store> storeSupplier,
                                  java.util.function.Supplier<StoreAreaProcessor> storeAreaProcessorSupplier)

Method Detail

addFile

public void addFile(long companyId,
                    long repositoryId,
                    java.lang.String fileName,
                    java.lang.String versionLabel,
                    java.io.InputStream inputStream)
             throws PortalException

Description copied from interface: Store

Adds a file based on an InputStream object.

Specified by:

addFile in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file name

versionLabel - the file's version label

inputStream - the files's data

Throws:

PortalException

deleteDirectory

public void deleteDirectory(long companyId,
                            long repositoryId,
                            java.lang.String dirName)

Description copied from interface: Store

Deletes a directory.

Specified by:

deleteDirectory in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

deleteFile

public void deleteFile(long companyId,
                       long repositoryId,
                       java.lang.String fileName,
                       java.lang.String versionLabel)

Description copied from interface: Store

Deletes a file at a particular version.

Specified by:

deleteFile in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

getFileAsStream

public java.io.InputStream getFileAsStream(long companyId,
                                           long repositoryId,
                                           java.lang.String fileName,
                                           java.lang.String versionLabel)
                                    throws PortalException

Description copied from interface: Store

Returns the file as an InputStream object.

Specified by:

getFileAsStream in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

Returns the InputStream object with the file's name

Throws:

PortalException

getFileNames

public java.lang.String[] getFileNames(long companyId,
                                       long repositoryId,
                                       java.lang.String dirName)

Description copied from interface: Store

Returns all files of the directory.

Specified by:

getFileNames in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

dirName - the directory's name

Returns:

Returns all files of the directory

getFileSize

public long getFileSize(long companyId,
                        long repositoryId,
                        java.lang.String fileName,
                        java.lang.String versionLabel)
                 throws PortalException

Description copied from interface: Store

Returns the size of the file.

Specified by:

getFileSize in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

Returns:

Returns the size of the file

Throws:

PortalException

getFileVersions

public java.lang.String[] getFileVersions(long companyId,
                                          long repositoryId,
                                          java.lang.String fileName)

Specified by:

getFileVersions in interface Store

hasFile

public boolean hasFile(long companyId,
                       long repositoryId,
                       java.lang.String fileName,
                       java.lang.String versionLabel)

Description copied from interface: Store

Returns true if the file exists.

Specified by:

hasFile in interface Store

Parameters:

companyId - the primary key of the company

repositoryId - the primary key of the data repository (optionally CompanyConstants.SYSTEM)

fileName - the file's name

versionLabel - the file's version label

Returns:

true if the file exists; false otherwise