com.liferay.portal.kernel.repository

Class BaseRepositoryImpl

java.lang.Object

com.liferay.portal.kernel.repository.BaseRepositoryImpl

All Implemented Interfaces:

BaseRepository, Repository

Direct Known Subclasses:

BaseCmisRepository, CMISRepositoryHandler

public abstract class BaseRepositoryImpl
extends java.lang.Object
implements BaseRepository

Third-party repository implementations should extend from this class.

Author:

Alexander Chow

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetEntryLocalService	assetEntryLocalService
protected CompanyLocalService	companyLocalService
protected CounterLocalService	counterLocalService
protected DLAppHelperLocalService	dlAppHelperLocalService
protected UserLocalService	userLocalService

Constructor Summary

Constructors

Constructor and Description
BaseRepositoryImpl()

Method Summary

Methods

Modifier and Type	Method and Description
FileEntry	addFileEntry(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)
void	checkInFileEntry(long fileEntryId, java.lang.String lockUuid) Deprecated. As of 6.2.0, replaced by Repository.checkInFileEntry(long, String, ServiceContext)
protected void	clearManualCheckInRequired(long fileEntryId, ServiceContext serviceContext)
void	deleteFileEntry(long folderId, java.lang.String title)
void	deleteFileVersion(long fileEntryId, java.lang.String version)
void	deleteFolder(long parentFolderId, java.lang.String title)
long	getCompanyId()
java.util.List<java.lang.Object>	getFileEntriesAndFileShortcuts(long folderId, int status, int start, int end)
int	getFileEntriesAndFileShortcutsCount(long folderId, int status)
int	getFileEntriesAndFileShortcutsCount(long folderId, int status, java.lang.String[] mimeTypes)
java.util.List<Folder>	getFolders(long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator obc)
abstract java.util.List<java.lang.Object>	getFoldersAndFileEntries(long folderId, int start, int end, OrderByComparator obc)
abstract java.util.List<java.lang.Object>	getFoldersAndFileEntries(long folderId, java.lang.String[] mimeTypes, int start, int end, OrderByComparator obc)
java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator obc)
java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator obc)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, boolean includeMountFolders)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders)
abstract int	getFoldersAndFileEntriesCount(long folderId)
abstract int	getFoldersAndFileEntriesCount(long folderId, java.lang.String[] mimeTypes)
int	getFoldersCount(long parentFolderId, int status, boolean includeMountfolders)
long	getGroupId()
LocalRepository	getLocalRepository()
java.lang.Object[]	getRepositoryEntryIds(java.lang.String objectId)
java.util.List<FileEntry>	getRepositoryFileEntries(long userId, long rootFolderId, int start, int end, OrderByComparator obc)
java.util.List<FileEntry>	getRepositoryFileEntries(long userId, long rootFolderId, java.lang.String[] mimeTypes, int status, int start, int end, OrderByComparator obc)
int	getRepositoryFileEntriesCount(long userId, long rootFolderId)
int	getRepositoryFileEntriesCount(long userId, long rootFolderId, java.lang.String[] mimeTypes, int status)
long	getRepositoryId()
UnicodeProperties	getTypeSettingsProperties()
abstract void	initRepository()
Lock	lockFileEntry(long fileEntryId) Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, ServiceContext)
Lock	lockFileEntry(long fileEntryId, java.lang.String owner, long expirationTime) Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, String, long, ServiceContext)
Hits	search(SearchContext searchContext)
void	setAssetEntryLocalService(AssetEntryLocalService assetEntryLocalService)
void	setCompanyId(long companyId)
void	setCompanyLocalService(CompanyLocalService companyLocalService)
void	setCounterLocalService(CounterLocalService counterLocalService)
void	setDLAppHelperLocalService(DLAppHelperLocalService dlAppHelperLocalService)
void	setGroupId(long groupId)
protected void	setManualCheckInRequired(long fileEntryId, ServiceContext serviceContext)
void	setRepositoryId(long repositoryId)
void	setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
void	setUserLocalService(UserLocalService userLocalService)
void	unlockFolder(long parentFolderId, java.lang.String title, java.lang.String lockUuid)
FileEntry	updateFileEntry(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)
boolean	verifyFileEntryLock(long fileEntryId, java.lang.String lockUuid)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.repository.BaseRepository

getSupportedConfigurations, getSupportedParameters

Methods inherited from interface com.liferay.portal.kernel.repository.Repository

addFileEntry, addFolder, cancelCheckOut, checkInFileEntry, checkInFileEntry, checkOutFileEntry, checkOutFileEntry, copyFileEntry, deleteFileEntry, deleteFolder, getFileEntries, getFileEntries, getFileEntries, getFileEntriesCount, getFileEntriesCount, getFileEntriesCount, getFileEntry, getFileEntry, getFileEntryByUuid, getFileVersion, getFolder, getFolder, getFolders, getFoldersCount, getFoldersFileEntriesCount, getMountFolders, getMountFoldersCount, getSubfolderIds, getSubfolderIds, lockFolder, lockFolder, moveFileEntry, moveFolder, refreshFileEntryLock, refreshFolderLock, revertFileEntry, search, search, search, unlockFolder, updateFileEntry, updateFolder, verifyFileEntryCheckOut, verifyInheritableLock

Field Detail

assetEntryLocalService

protected AssetEntryLocalService assetEntryLocalService

companyLocalService

protected CompanyLocalService companyLocalService

counterLocalService

protected CounterLocalService counterLocalService

dlAppHelperLocalService

protected DLAppHelperLocalService dlAppHelperLocalService

userLocalService

protected UserLocalService userLocalService

Constructor Detail

BaseRepositoryImpl

public BaseRepositoryImpl()

Method Detail

addFileEntry

public FileEntry addFileEntry(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)
                       throws PortalException,
                              SystemException

Specified by:

addFileEntry in interface Repository

Throws:

PortalException

SystemException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                    java.lang.String lockUuid)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0, replaced by Repository.checkInFileEntry(long, String, ServiceContext)

Specified by:

checkInFileEntry in interface Repository

Throws:

PortalException

SystemException

deleteFileEntry

public void deleteFileEntry(long folderId,
                   java.lang.String title)
                     throws PortalException,
                            SystemException

Specified by:

deleteFileEntry in interface Repository

Throws:

PortalException

SystemException

deleteFileVersion

public void deleteFileVersion(long fileEntryId,
                     java.lang.String version)

Specified by:

deleteFileVersion in interface Repository

deleteFolder

public void deleteFolder(long parentFolderId,
                java.lang.String title)
                  throws PortalException,
                         SystemException

Specified by:

deleteFolder in interface Repository

Throws:

PortalException

SystemException

getCompanyId

public long getCompanyId()

getFileEntriesAndFileShortcuts

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

Specified by:

getFileEntriesAndFileShortcuts in interface Repository

Throws:

PortalException

SystemException

getFileEntriesAndFileShortcutsCount

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

Specified by:

getFileEntriesAndFileShortcutsCount in interface Repository

Throws:

PortalException

SystemException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long folderId,
                                      int status,
                                      java.lang.String[] mimeTypes)
                                        throws PortalException,
                                               SystemException

Specified by:

getFileEntriesAndFileShortcutsCount in interface Repository

Throws:

PortalException

SystemException

getFolders

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

Specified by:

getFolders in interface Repository

Throws:

PortalException

SystemException

getFoldersAndFileEntries

public abstract java.util.List<java.lang.Object> getFoldersAndFileEntries(long folderId,
                                                        int start,
                                                        int end,
                                                        OrderByComparator obc)
                                                                   throws SystemException

Throws:

SystemException

getFoldersAndFileEntries

public abstract java.util.List<java.lang.Object> getFoldersAndFileEntries(long folderId,
                                                        java.lang.String[] mimeTypes,
                                                        int start,
                                                        int end,
                                                        OrderByComparator obc)
                                                                   throws PortalException,
                                                                          SystemException

Throws:

PortalException

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                                        int status,
                                                                        boolean includeMountFolders,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator obc)
                                                                          throws SystemException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface Repository

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                                        int status,
                                                                        java.lang.String[] mimeTypes,
                                                                        boolean includeMountFolders,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator obc)
                                                                          throws PortalException,
                                                                                 SystemException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface Repository

Throws:

PortalException

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface Repository

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                int status,
                                                java.lang.String[] mimeTypes,
                                                boolean includeMountFolders)
                                                  throws PortalException,
                                                         SystemException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface Repository

Throws:

PortalException

SystemException

getFoldersAndFileEntriesCount

public abstract int getFoldersAndFileEntriesCount(long folderId)
                                           throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesCount

public abstract int getFoldersAndFileEntriesCount(long folderId,
                                java.lang.String[] mimeTypes)
                                           throws PortalException,
                                                  SystemException

Throws:

PortalException

SystemException

getFoldersCount

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

Specified by:

getFoldersCount in interface Repository

Throws:

PortalException

SystemException

getGroupId

public long getGroupId()

getLocalRepository

public LocalRepository getLocalRepository()

Specified by:

getLocalRepository in interface BaseRepository

getRepositoryEntryIds

public java.lang.Object[] getRepositoryEntryIds(java.lang.String objectId)
                                         throws SystemException

Throws:

SystemException

getRepositoryFileEntries

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

Specified by:

getRepositoryFileEntries in interface Repository

Throws:

PortalException

SystemException

getRepositoryFileEntries

public java.util.List<FileEntry> getRepositoryFileEntries(long userId,
                                                 long rootFolderId,
                                                 java.lang.String[] mimeTypes,
                                                 int status,
                                                 int start,
                                                 int end,
                                                 OrderByComparator obc)
                                                   throws PortalException,
                                                          SystemException

Specified by:

getRepositoryFileEntries in interface Repository

Throws:

PortalException

SystemException

getRepositoryFileEntriesCount

public int getRepositoryFileEntriesCount(long userId,
                                long rootFolderId)
                                  throws PortalException,
                                         SystemException

Specified by:

getRepositoryFileEntriesCount in interface Repository

Throws:

PortalException

SystemException

getRepositoryFileEntriesCount

public int getRepositoryFileEntriesCount(long userId,
                                long rootFolderId,
                                java.lang.String[] mimeTypes,
                                int status)
                                  throws PortalException,
                                         SystemException

Specified by:

getRepositoryFileEntriesCount in interface Repository

Throws:

PortalException

SystemException

getRepositoryId

public long getRepositoryId()

Specified by:

getRepositoryId in interface Repository

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()

initRepository

public abstract void initRepository()
                             throws PortalException,
                                    SystemException

Specified by:

initRepository in interface BaseRepository

Throws:

PortalException

SystemException

lockFileEntry

public Lock lockFileEntry(long fileEntryId)
                   throws PortalException,
                          SystemException

Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, ServiceContext)

Specified by:

lockFileEntry in interface Repository

Throws:

PortalException

SystemException

lockFileEntry

public Lock lockFileEntry(long fileEntryId,
                 java.lang.String owner,
                 long expirationTime)
                   throws PortalException,
                          SystemException

Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, String, long, ServiceContext)

Specified by:

lockFileEntry in interface Repository

Throws:

PortalException

SystemException

search

public Hits search(SearchContext searchContext)
            throws SearchException

Specified by:

search in interface Repository

Throws:

SearchException

setAssetEntryLocalService

public void setAssetEntryLocalService(AssetEntryLocalService assetEntryLocalService)

Specified by:

setAssetEntryLocalService in interface BaseRepository

setCompanyId

public void setCompanyId(long companyId)

Specified by:

setCompanyId in interface BaseRepository

setCompanyLocalService

public void setCompanyLocalService(CompanyLocalService companyLocalService)

Specified by:

setCompanyLocalService in interface BaseRepository

setCounterLocalService

public void setCounterLocalService(CounterLocalService counterLocalService)

Specified by:

setCounterLocalService in interface BaseRepository

setDLAppHelperLocalService

public void setDLAppHelperLocalService(DLAppHelperLocalService dlAppHelperLocalService)

Specified by:

setDLAppHelperLocalService in interface BaseRepository

setGroupId

public void setGroupId(long groupId)

Specified by:

setGroupId in interface BaseRepository

setRepositoryId

public void setRepositoryId(long repositoryId)

Specified by:

setRepositoryId in interface BaseRepository

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

Specified by:

setTypeSettingsProperties in interface BaseRepository

setUserLocalService

public void setUserLocalService(UserLocalService userLocalService)

Specified by:

setUserLocalService in interface BaseRepository

unlockFolder

public void unlockFolder(long parentFolderId,
                java.lang.String title,
                java.lang.String lockUuid)
                  throws PortalException,
                         SystemException

Specified by:

unlockFolder in interface Repository

Throws:

PortalException

SystemException

updateFileEntry

public FileEntry updateFileEntry(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)
                          throws PortalException,
                                 SystemException

Specified by:

updateFileEntry in interface Repository

Throws:

PortalException

SystemException

verifyFileEntryLock

public boolean verifyFileEntryLock(long fileEntryId,
                          java.lang.String lockUuid)

Specified by:

verifyFileEntryLock in interface Repository

clearManualCheckInRequired

protected void clearManualCheckInRequired(long fileEntryId,
                              ServiceContext serviceContext)
                                   throws NoSuchRepositoryEntryException,
                                          SystemException

Throws:

NoSuchRepositoryEntryException

SystemException

setManualCheckInRequired

protected void setManualCheckInRequired(long fileEntryId,
                            ServiceContext serviceContext)
                                 throws NoSuchRepositoryEntryException,
                                        SystemException

Throws:

NoSuchRepositoryEntryException

SystemException