Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.store
Class CMISStore

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.store.BaseStore
      extended by com.liferay.portlet.documentlibrary.store.CMISStore
All Implemented Interfaces:
Store

public class CMISStore
extends BaseStore


Field Summary
 
Fields inherited from interface com.liferay.portlet.documentlibrary.store.Store
VERSION_DEFAULT
 
Constructor Summary
CMISStore()
           
 
Method Summary
 void addDirectory(long companyId, long repositoryId, String dirName)
          Adds a directory.
 void addFile(long companyId, long repositoryId, String fileName, InputStream is)
          Adds a file based on an InputStream object.
 void checkRoot(long companyId)
          Ensures company's root directory exists.
 void copyFileVersion(long companyId, long repositoryId, String fileName, String fromVersionLabel, String toVersionLabel)
          Creates a new copy of the file version.
protected  org.apache.chemistry.opencmis.client.api.Document createDocument(org.apache.chemistry.opencmis.client.api.Folder versioningFolder, String title, InputStream is)
           
protected  org.apache.chemistry.opencmis.client.api.Folder createFolder(org.apache.chemistry.opencmis.client.api.ObjectId parentFolderId, String name)
           
 void deleteDirectory(long companyId, long repositoryId, String dirName)
          Deletes a directory.
 void deleteFile(long companyId, long repositoryId, String fileName)
          Deletes a file.
 void deleteFile(long companyId, long repositoryId, String fileName, String versionLabel)
          Deletes a file at a particular version.
protected  org.apache.chemistry.opencmis.client.api.Folder getCompanyFolder(long companyId)
           
protected  org.apache.chemistry.opencmis.client.api.Document getDocument(org.apache.chemistry.opencmis.client.api.Folder parentFolder, String name)
           
 InputStream getFileAsStream(long companyId, long repositoryId, String fileName, String versionLabel)
          Returns the file as an InputStream object.
 String[] getFileNames(long companyId, long repositoryId)
           
 String[] getFileNames(long companyId, long repositoryId, String dirName)
          Returns all files of the directory.
 long getFileSize(long companyId, long repositoryId, String fileName)
          Returns the size of the file.
protected  org.apache.chemistry.opencmis.client.api.Folder getFolder(org.apache.chemistry.opencmis.client.api.Folder parentFolder, String name)
           
protected  List<org.apache.chemistry.opencmis.client.api.Folder> getFolders(org.apache.chemistry.opencmis.client.api.Folder folder)
           
 String getHeadVersionLabel(long companyId, long repositoryId, String dirName)
           
protected  org.apache.chemistry.opencmis.client.api.Folder getRepositoryFolder(long companyId, long repositoryId)
           
protected  org.apache.chemistry.opencmis.client.api.Document getVersionedDocument(long companyId, long repositoryId, String fileName, String versionLabel)
           
protected  org.apache.chemistry.opencmis.client.api.Folder getVersioningFolder(long companyId, long repositoryId, String fileName, boolean create)
           
 boolean hasDirectory(long companyId, long repositoryId, String dirName)
          Returns true if the directory exists.
 boolean hasFile(long companyId, long repositoryId, String fileName, String versionLabel)
          Returns true if the file exists.
 void move(String srcDir, String destDir)
          Moves an existing directory.
 void updateFile(long companyId, long repositoryId, long newRepositoryId, String fileName)
          Moves a file to a new data repository.
 void updateFile(long companyId, long repositoryId, String fileName, String newFileName)
           
 void updateFile(long companyId, long repositoryId, String fileName, String versionLabel, InputStream is)
          Updates a file based on an InputStream object.
 void updateFileVersion(long companyId, long repositoryId, String fileName, String fromVersionLabel, String toVersionLabel)
          Update's a file version label.
 
Methods inherited from class com.liferay.portlet.documentlibrary.store.BaseStore
addFile, addFile, getFile, getFile, getFileAsBytes, getFileAsBytes, getFileAsStream, hasFile, updateFile, updateFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMISStore

public CMISStore()
Method Detail

addDirectory

public void addDirectory(long companyId,
                         long repositoryId,
                         String dirName)
Description copied from class: BaseStore
Adds a directory.

Specified by:
addDirectory in interface Store
Specified by:
addDirectory in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository (optionally CompanyConstants#SYSTEM)
dirName - the directory's name

addFile

public void addFile(long companyId,
                    long repositoryId,
                    String fileName,
                    InputStream is)
             throws PortalException
Description copied from class: BaseStore
Adds a file based on an InputStream object.

Specified by:
addFile in interface Store
Specified by:
addFile in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository (optionally CompanyConstants#SYSTEM)
fileName - the file name
is - the files's data
Throws:
PortalException - if the file's information was invalid

checkRoot

public void checkRoot(long companyId)
Description copied from class: BaseStore
Ensures company's root directory exists. Only implemented by JCRStore.checkRoot(long).

Specified by:
checkRoot in interface Store
Specified by:
checkRoot in class BaseStore
Parameters:
companyId - the primary key of the company

copyFileVersion

public void copyFileVersion(long companyId,
                            long repositoryId,
                            String fileName,
                            String fromVersionLabel,
                            String toVersionLabel)
                     throws PortalException
Description copied from class: BaseStore
Creates a new copy of the file version.

This method should be overrided if a more optimized approach can be used (e.g., FileSystemStore#copyFileVersion(long, long, String, String, String, String)).

Specified by:
copyFileVersion in interface Store
Overrides:
copyFileVersion in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository (optionally CompanyConstants#SYSTEM)
fileName - the original's file name
fromVersionLabel - the original file's version label
toVersionLabel - the new version label
Throws:
PortalException - if the file's information was invalid

deleteDirectory

public void deleteDirectory(long companyId,
                            long repositoryId,
                            String dirName)
Description copied from class: BaseStore
Deletes a directory.

Specified by:
deleteDirectory in interface Store
Specified by:
deleteDirectory in class BaseStore
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,
                       String fileName)
                throws PortalException
Description copied from class: BaseStore
Deletes a file. If a file has multiple versions, all versions will be deleted.

Specified by:
deleteFile in interface Store
Specified by:
deleteFile in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository (optionally CompanyConstants#SYSTEM)
fileName - the file's name
Throws:
PortalException - if the file's information was invalid

deleteFile

public void deleteFile(long companyId,
                       long repositoryId,
                       String fileName,
                       String versionLabel)
                throws PortalException
Description copied from class: BaseStore
Deletes a file at a particular version.

Specified by:
deleteFile in interface Store
Specified by:
deleteFile in class BaseStore
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
Throws:
PortalException - if the file's information was invalid

getFileAsStream

public InputStream getFileAsStream(long companyId,
                                   long repositoryId,
                                   String fileName,
                                   String versionLabel)
                            throws PortalException
Description copied from class: BaseStore
Returns the file as an InputStream object.

Specified by:
getFileAsStream in interface Store
Specified by:
getFileAsStream in class BaseStore
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 - if the file's information was invalid

getFileNames

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

getFileNames

public String[] getFileNames(long companyId,
                             long repositoryId,
                             String dirName)
Description copied from class: BaseStore
Returns all files of the directory.

Specified by:
getFileNames in interface Store
Specified by:
getFileNames in class BaseStore
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,
                        String fileName)
                 throws PortalException
Description copied from class: BaseStore
Returns the size of the file.

Specified by:
getFileSize in interface Store
Specified by:
getFileSize in class BaseStore
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 - if the file's information was invalid

getHeadVersionLabel

public String getHeadVersionLabel(long companyId,
                                  long repositoryId,
                                  String dirName)
                           throws NoSuchFileException
Throws:
NoSuchFileException

hasDirectory

public boolean hasDirectory(long companyId,
                            long repositoryId,
                            String dirName)
Description copied from class: BaseStore
Returns true if the directory exists.

Specified by:
hasDirectory in interface Store
Specified by:
hasDirectory in class BaseStore
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:
true if the directory exists; false otherwise

hasFile

public boolean hasFile(long companyId,
                       long repositoryId,
                       String fileName,
                       String versionLabel)
Description copied from class: BaseStore
Returns true if the file exists.

Specified by:
hasFile in interface Store
Specified by:
hasFile in class BaseStore
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

move

public void move(String srcDir,
                 String destDir)
Description copied from class: BaseStore
Moves an existing directory. Only implemented by JCRStore.move(String, String).

Specified by:
move in interface Store
Specified by:
move in class BaseStore
Parameters:
srcDir - the original directory's name
destDir - the new directory's name

updateFile

public void updateFile(long companyId,
                       long repositoryId,
                       long newRepositoryId,
                       String fileName)
Description copied from class: BaseStore
Moves a file to a new data repository.

Specified by:
updateFile in interface Store
Specified by:
updateFile in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository
newRepositoryId - the primary key of the new data repository
fileName - the file's name

updateFile

public void updateFile(long companyId,
                       long repositoryId,
                       String fileName,
                       String newFileName)

updateFile

public void updateFile(long companyId,
                       long repositoryId,
                       String fileName,
                       String versionLabel,
                       InputStream is)
                throws PortalException
Description copied from class: BaseStore
Updates a file based on an InputStream object.

Specified by:
updateFile in interface Store
Specified by:
updateFile in class BaseStore
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 new version label
is - the new file's data
Throws:
PortalException - if the file's information was invalid

updateFileVersion

public void updateFileVersion(long companyId,
                              long repositoryId,
                              String fileName,
                              String fromVersionLabel,
                              String toVersionLabel)
                       throws PortalException
Description copied from class: BaseStore
Update's a file version label. Similar to #copyFileVersion(long, long, String, String, String, String) except that the old file version is deleted.

Specified by:
updateFileVersion in interface Store
Overrides:
updateFileVersion in class BaseStore
Parameters:
companyId - the primary key of the company
repositoryId - the primary key of the data repository (optionally CompanyConstants#SYSTEM)
fileName - the file's name
fromVersionLabel - the file's version label
toVersionLabel - the file's new version label
Throws:
PortalException - if the file's information was invalid

createDocument

protected org.apache.chemistry.opencmis.client.api.Document createDocument(org.apache.chemistry.opencmis.client.api.Folder versioningFolder,
                                                                           String title,
                                                                           InputStream is)

createFolder

protected org.apache.chemistry.opencmis.client.api.Folder createFolder(org.apache.chemistry.opencmis.client.api.ObjectId parentFolderId,
                                                                       String name)

getCompanyFolder

protected org.apache.chemistry.opencmis.client.api.Folder getCompanyFolder(long companyId)

getDocument

protected org.apache.chemistry.opencmis.client.api.Document getDocument(org.apache.chemistry.opencmis.client.api.Folder parentFolder,
                                                                        String name)

getFolder

protected org.apache.chemistry.opencmis.client.api.Folder getFolder(org.apache.chemistry.opencmis.client.api.Folder parentFolder,
                                                                    String name)

getFolders

protected List<org.apache.chemistry.opencmis.client.api.Folder> getFolders(org.apache.chemistry.opencmis.client.api.Folder folder)

getRepositoryFolder

protected org.apache.chemistry.opencmis.client.api.Folder getRepositoryFolder(long companyId,
                                                                              long repositoryId)

getVersionedDocument

protected org.apache.chemistry.opencmis.client.api.Document getVersionedDocument(long companyId,
                                                                                 long repositoryId,
                                                                                 String fileName,
                                                                                 String versionLabel)
                                                                          throws NoSuchFileException
Throws:
NoSuchFileException

getVersioningFolder

protected org.apache.chemistry.opencmis.client.api.Folder getVersioningFolder(long companyId,
                                                                              long repositoryId,
                                                                              String fileName,
                                                                              boolean create)

Liferay 6.1.2-ce-ga3