com.liferay.portal.kernel.repository

Class DefaultLocalRepositoryImpl

java.lang.Object

com.liferay.portal.kernel.repository.DefaultLocalRepositoryImpl

All Implemented Interfaces:

CapabilityProvider, DocumentRepository, LocalRepository

public class DefaultLocalRepositoryImpl
extends java.lang.Object
implements LocalRepository

This class is designed for third party repository implementations. Since the paradigm of remote and local services exists only within Liferay, the assumption is that all permission checking will be delegated to the specific repository. There are also many calls within this class that pass in a user ID as a parameter. These methods should only be called for administration of Liferay repositories and are hence not supported in all third party repositories. This includes moving between document library hooks and LAR import/export. Calling these methods will throw an UnsupportedOperationException.

Constructor Summary

Constructors

Constructor and Description
DefaultLocalRepositoryImpl(Repository repository)

Method Summary

Modifier and Type	Method and Description
FileEntry	addFileEntry(long userId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.File file, ServiceContext serviceContext)
FileEntry	addFileEntry(long userId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.InputStream is, long size, ServiceContext serviceContext)
FileShortcut	addFileShortcut(long userId, long folderId, long toFileEntryId, ServiceContext serviceContext)
Folder	addFolder(long userId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, java.lang.String changeLog, ServiceContext serviceContext)
void	checkInFileEntry(long userId, long fileEntryId, java.lang.String lockUuid, ServiceContext serviceContext)
FileEntry	copyFileEntry(long userId, long groupId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
void	deleteAll()
void	deleteFileEntry(long fileEntryId)
void	deleteFileShortcut(long fileShortcutId)
void	deleteFileShortcuts(long toFileEntryId)
void	deleteFolder(long folderId)
<T extends Capability> T	getCapability(java.lang.Class<T> capabilityClass)
java.util.List<FileEntry>	getFileEntries(long folderId, int status, int start, int end, OrderByComparator<FileEntry> obc)
java.util.List<FileEntry>	getFileEntries(long folderId, int start, int end, OrderByComparator<FileEntry> obc)
java.util.List<RepositoryEntry>	getFileEntriesAndFileShortcuts(long folderId, int status, int start, int end)
int	getFileEntriesAndFileShortcutsCount(long folderId, int status)
int	getFileEntriesCount(long folderId)
int	getFileEntriesCount(long folderId, int status)
FileEntry	getFileEntry(long fileEntryId)
FileEntry	getFileEntry(long folderId, java.lang.String title)
FileEntry	getFileEntryByUuid(java.lang.String uuid)
FileShortcut	getFileShortcut(long fileShortcutId)
FileVersion	getFileVersion(long fileVersionId)
Folder	getFolder(long folderId)
Folder	getFolder(long parentFolderId, java.lang.String name)
java.util.List<Folder>	getFolders(long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
java.util.List<Folder>	getFolders(long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
java.util.List<RepositoryEntry>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, boolean includeMountFolders)
int	getFoldersCount(long parentFolderId, boolean includeMountfolders)
int	getFoldersCount(long parentFolderId, int status, boolean includeMountfolders)
java.util.List<FileEntry>	getRepositoryFileEntries(long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> obc)
long	getRepositoryId()
<T extends Capability> boolean	isCapabilityProvided(java.lang.Class<T> capabilityClass)
FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
Folder	moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext)
void	revertFileEntry(long userId, long fileEntryId, java.lang.String version, ServiceContext serviceContext)
void	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds) Deprecated. As of Wilberforce (7.0.x)
FileEntry	updateFileEntry(long userId, long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, ServiceContext serviceContext)
FileEntry	updateFileEntry(long userId, long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.InputStream is, long size, ServiceContext serviceContext)
FileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)
void	updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
Folder	updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLocalRepositoryImpl

public DefaultLocalRepositoryImpl(Repository repository)

Method Detail

addFileEntry

public FileEntry addFileEntry(long userId,
                              long folderId,
                              java.lang.String sourceFileName,
                              java.lang.String mimeType,
                              java.lang.String title,
                              java.lang.String description,
                              java.lang.String changeLog,
                              java.io.File file,
                              ServiceContext serviceContext)

Specified by:

addFileEntry in interface DocumentRepository

addFileEntry

public FileEntry addFileEntry(long userId,
                              long folderId,
                              java.lang.String sourceFileName,
                              java.lang.String mimeType,
                              java.lang.String title,
                              java.lang.String description,
                              java.lang.String changeLog,
                              java.io.InputStream is,
                              long size,
                              ServiceContext serviceContext)

Specified by:

addFileEntry in interface DocumentRepository

addFileShortcut

public FileShortcut addFileShortcut(long userId,
                                    long folderId,
                                    long toFileEntryId,
                                    ServiceContext serviceContext)

Specified by:

addFileShortcut in interface DocumentRepository

addFolder

public Folder addFolder(long userId,
                        long parentFolderId,
                        java.lang.String name,
                        java.lang.String description,
                        ServiceContext serviceContext)

Specified by:

addFolder in interface DocumentRepository

checkInFileEntry

public void checkInFileEntry(long userId,
                             long fileEntryId,
                             boolean majorVersion,
                             java.lang.String changeLog,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DocumentRepository

Throws:

PortalException

checkInFileEntry

public void checkInFileEntry(long userId,
                             long fileEntryId,
                             java.lang.String lockUuid,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DocumentRepository

Throws:

PortalException

copyFileEntry

public FileEntry copyFileEntry(long userId,
                               long groupId,
                               long fileEntryId,
                               long destFolderId,
                               ServiceContext serviceContext)
                        throws PortalException

Specified by:

copyFileEntry in interface DocumentRepository

Throws:

PortalException

deleteAll

public void deleteAll()

Specified by:

deleteAll in interface DocumentRepository

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws PortalException

Specified by:

deleteFileEntry in interface DocumentRepository

Throws:

PortalException

deleteFileShortcut

public void deleteFileShortcut(long fileShortcutId)
                        throws PortalException

Specified by:

deleteFileShortcut in interface DocumentRepository

Throws:

PortalException

deleteFileShortcuts

public void deleteFileShortcuts(long toFileEntryId)
                         throws PortalException

Specified by:

deleteFileShortcuts in interface DocumentRepository

Throws:

PortalException

deleteFolder

public void deleteFolder(long folderId)
                  throws PortalException

Specified by:

deleteFolder in interface DocumentRepository

Throws:

PortalException

getCapability

public <T extends Capability> T getCapability(java.lang.Class<T> capabilityClass)

Specified by:

getCapability in interface CapabilityProvider

getFileEntries

public java.util.List<FileEntry> getFileEntries(long folderId,
                                                int status,
                                                int start,
                                                int end,
                                                OrderByComparator<FileEntry> obc)
                                         throws PortalException

Specified by:

getFileEntries in interface DocumentRepository

Throws:

PortalException

getFileEntries

public java.util.List<FileEntry> getFileEntries(long folderId,
                                                int start,
                                                int end,
                                                OrderByComparator<FileEntry> obc)
                                         throws PortalException

Specified by:

getFileEntries in interface DocumentRepository

Throws:

PortalException

getFileEntriesAndFileShortcuts

public java.util.List<RepositoryEntry> getFileEntriesAndFileShortcuts(long folderId,
                                                                      int status,
                                                                      int start,
                                                                      int end)
                                                               throws PortalException

Specified by:

getFileEntriesAndFileShortcuts in interface DocumentRepository

Throws:

PortalException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long folderId,
                                               int status)
                                        throws PortalException

Specified by:

getFileEntriesAndFileShortcutsCount in interface DocumentRepository

Throws:

PortalException

getFileEntriesCount

public int getFileEntriesCount(long folderId)
                        throws PortalException

Specified by:

getFileEntriesCount in interface DocumentRepository

Throws:

PortalException

getFileEntriesCount

public int getFileEntriesCount(long folderId,
                               int status)
                        throws PortalException

Specified by:

getFileEntriesCount in interface DocumentRepository

Throws:

PortalException

getFileEntry

public FileEntry getFileEntry(long fileEntryId)
                       throws PortalException

Specified by:

getFileEntry in interface DocumentRepository

Throws:

PortalException

getFileEntry

public FileEntry getFileEntry(long folderId,
                              java.lang.String title)
                       throws PortalException

Specified by:

getFileEntry in interface DocumentRepository

Throws:

PortalException

getFileEntryByUuid

public FileEntry getFileEntryByUuid(java.lang.String uuid)
                             throws PortalException

Specified by:

getFileEntryByUuid in interface DocumentRepository

Throws:

PortalException

getFileShortcut

public FileShortcut getFileShortcut(long fileShortcutId)

Specified by:

getFileShortcut in interface DocumentRepository

getFileVersion

public FileVersion getFileVersion(long fileVersionId)
                           throws PortalException

Specified by:

getFileVersion in interface DocumentRepository

Throws:

PortalException

getFolder

public Folder getFolder(long folderId)
                 throws PortalException

Specified by:

getFolder in interface DocumentRepository

Throws:

PortalException

getFolder

public Folder getFolder(long parentFolderId,
                        java.lang.String name)
                 throws PortalException

Specified by:

getFolder in interface DocumentRepository

Throws:

PortalException

getFolders

public java.util.List<Folder> getFolders(long parentFolderId,
                                         boolean includeMountFolders,
                                         int start,
                                         int end,
                                         OrderByComparator<Folder> obc)
                                  throws PortalException

Specified by:

getFolders in interface DocumentRepository

Throws:

PortalException

getFolders

public java.util.List<Folder> getFolders(long parentFolderId,
                                         int status,
                                         boolean includeMountFolders,
                                         int start,
                                         int end,
                                         OrderByComparator<Folder> obc)
                                  throws PortalException

Specified by:

getFolders in interface DocumentRepository

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public java.util.List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                                                int status,
                                                                                boolean includeMountFolders,
                                                                                int start,
                                                                                int end,
                                                                                OrderByComparator<?> obc)
                                                                         throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DocumentRepository

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
                                                  throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DocumentRepository

Throws:

PortalException

getFoldersCount

public int getFoldersCount(long parentFolderId,
                           boolean includeMountfolders)
                    throws PortalException

Specified by:

getFoldersCount in interface DocumentRepository

Throws:

PortalException

getFoldersCount

public int getFoldersCount(long parentFolderId,
                           int status,
                           boolean includeMountfolders)
                    throws PortalException

Specified by:

getFoldersCount in interface DocumentRepository

Throws:

PortalException

getRepositoryFileEntries

public java.util.List<FileEntry> getRepositoryFileEntries(long userId,
                                                          long rootFolderId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator<FileEntry> obc)
                                                   throws PortalException

Specified by:

getRepositoryFileEntries in interface DocumentRepository

Throws:

PortalException

getRepositoryId

public long getRepositoryId()

Specified by:

getRepositoryId in interface DocumentRepository

isCapabilityProvided

public <T extends Capability> boolean isCapabilityProvided(java.lang.Class<T> capabilityClass)

Specified by:

isCapabilityProvided in interface CapabilityProvider

moveFileEntry

public FileEntry moveFileEntry(long userId,
                               long fileEntryId,
                               long newFolderId,
                               ServiceContext serviceContext)

Specified by:

moveFileEntry in interface DocumentRepository

moveFolder

public Folder moveFolder(long userId,
                         long folderId,
                         long parentFolderId,
                         ServiceContext serviceContext)

Specified by:

moveFolder in interface DocumentRepository

revertFileEntry

public void revertFileEntry(long userId,
                            long fileEntryId,
                            java.lang.String version,
                            ServiceContext serviceContext)
                     throws PortalException

Specified by:

revertFileEntry in interface DocumentRepository

Throws:

PortalException

updateAsset

@Deprecated
public void updateAsset(long userId,
                                    FileEntry fileEntry,
                                    FileVersion fileVersion,
                                    long[] assetCategoryIds,
                                    java.lang.String[] assetTagNames,
                                    long[] assetLinkEntryIds)

Deprecated. As of Wilberforce (7.0.x)

Specified by:

updateAsset in interface LocalRepository

updateFileEntry

public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 java.lang.String sourceFileName,
                                 java.lang.String mimeType,
                                 java.lang.String title,
                                 java.lang.String description,
                                 java.lang.String changeLog,
                                 boolean majorVersion,
                                 java.io.File file,
                                 ServiceContext serviceContext)

Specified by:

updateFileEntry in interface DocumentRepository

updateFileEntry

public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 java.lang.String sourceFileName,
                                 java.lang.String mimeType,
                                 java.lang.String title,
                                 java.lang.String description,
                                 java.lang.String changeLog,
                                 boolean majorVersion,
                                 java.io.InputStream is,
                                 long size,
                                 ServiceContext serviceContext)

Specified by:

updateFileEntry in interface DocumentRepository

updateFileShortcut

public FileShortcut updateFileShortcut(long userId,
                                       long fileShortcutId,
                                       long folderId,
                                       long toFileEntryId,
                                       ServiceContext serviceContext)

Specified by:

updateFileShortcut in interface DocumentRepository

updateFileShortcuts

public void updateFileShortcuts(long oldToFileEntryId,
                                long newToFileEntryId)

Specified by:

updateFileShortcuts in interface DocumentRepository

updateFolder

public Folder updateFolder(long folderId,
                           long parentFolderId,
                           java.lang.String name,
                           java.lang.String description,
                           ServiceContext serviceContext)

Specified by:

updateFolder in interface DocumentRepository