Liferay 7.0-ce-m2

com.liferay.portal.kernel.repository
Class BaseRepositoryImpl

java.lang.Object
  extended by com.liferay.portal.kernel.repository.BaseRepositoryImpl
All Implemented Interfaces:
BaseRepository, CapabilityProvider, DocumentRepository, Repository
Direct Known Subclasses:
BaseCmisRepository, CMISRepositoryHandler

public abstract class BaseRepositoryImpl
extends Object
implements BaseRepository, CapabilityProvider

Third-party repository implementations should extend from this class.


Field Summary
protected  AssetEntryLocalService assetEntryLocalService
           
protected  CompanyLocalService companyLocalService
           
protected  DLAppHelperLocalService dlAppHelperLocalService
           
protected  RepositoryEntryLocalService repositoryEntryLocalService
           
protected  UserLocalService userLocalService
           
 
Constructor Summary
BaseRepositoryImpl()
           
 
Method Summary
 FileEntry addFileEntry(long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext)
           
 void checkInFileEntry(long fileEntryId, 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, String title)
           
 void deleteFileVersion(long fileEntryId, String version)
           
 void deleteFolder(long parentFolderId, String name)
           
<T extends Capability>
T
getCapability(Class<T> capabilityClass)
           
 long getCompanyId()
           
 List<Object> getFileEntriesAndFileShortcuts(long folderId, int status, int start, int end)
           
 int getFileEntriesAndFileShortcutsCount(long folderId, int status)
           
 int getFileEntriesAndFileShortcutsCount(long folderId, int status, String[] mimeTypes)
           
 List<Folder> getFolders(long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator<Folder> obc)
           
abstract  List<Object> getFoldersAndFileEntries(long folderId, int start, int end, OrderByComparator<?> obc)
           
abstract  List<Object> getFoldersAndFileEntries(long folderId, String[] mimeTypes, int start, int end, OrderByComparator<?> obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
           
 int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, boolean includeMountFolders)
           
 int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
           
abstract  int getFoldersAndFileEntriesCount(long folderId)
           
abstract  int getFoldersAndFileEntriesCount(long folderId, String[] mimeTypes)
           
 int getFoldersCount(long parentFolderId, int status, boolean includeMountfolders)
           
 long getGroupId()
           
 LocalRepository getLocalRepository()
           
 Object[] getRepositoryEntryIds(String objectId)
           
 List<FileEntry> getRepositoryFileEntries(long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> obc)
           
 List<FileEntry> getRepositoryFileEntries(long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> obc)
           
 int getRepositoryFileEntriesCount(long userId, long rootFolderId)
           
 int getRepositoryFileEntriesCount(long userId, long rootFolderId, String[] mimeTypes, int status)
           
 long getRepositoryId()
           
 UnicodeProperties getTypeSettingsProperties()
           
abstract  void initRepository()
           
<T extends Capability>
boolean
isCapabilityProvided(Class<T> capabilityClass)
           
 Lock lockFileEntry(long fileEntryId)
          Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, ServiceContext)
 Lock lockFileEntry(long fileEntryId, 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 setDLAppHelperLocalService(DLAppHelperLocalService dlAppHelperLocalService)
           
 void setGroupId(long groupId)
           
protected  void setManualCheckInRequired(long fileEntryId, ServiceContext serviceContext)
           
 void setRepositoryEntryLocalService(RepositoryEntryLocalService repositoryEntryLocalService)
           
 void setRepositoryId(long repositoryId)
           
 void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 void setUserLocalService(UserLocalService userLocalService)
           
 void unlockFolder(long parentFolderId, String name, String lockUuid)
           
 FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext)
           
 boolean verifyFileEntryLock(long fileEntryId, 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

dlAppHelperLocalService

protected DLAppHelperLocalService dlAppHelperLocalService

repositoryEntryLocalService

protected RepositoryEntryLocalService repositoryEntryLocalService

userLocalService

protected UserLocalService userLocalService
Constructor Detail

BaseRepositoryImpl

public BaseRepositoryImpl()
Method Detail

addFileEntry

public FileEntry addFileEntry(long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              File file,
                              ServiceContext serviceContext)
                       throws PortalException
Specified by:
addFileEntry in interface Repository
Throws:
PortalException

checkInFileEntry

@Deprecated
public void checkInFileEntry(long fileEntryId,
                                        String lockUuid)
                      throws PortalException
Deprecated. As of 6.2.0, replaced by Repository.checkInFileEntry(long, String, ServiceContext)

Specified by:
checkInFileEntry in interface Repository
Throws:
PortalException

deleteFileEntry

public void deleteFileEntry(long folderId,
                            String title)
                     throws PortalException
Specified by:
deleteFileEntry in interface Repository
Throws:
PortalException

deleteFileVersion

public void deleteFileVersion(long fileEntryId,
                              String version)
Specified by:
deleteFileVersion in interface Repository

deleteFolder

public void deleteFolder(long parentFolderId,
                         String name)
                  throws PortalException
Specified by:
deleteFolder in interface Repository
Throws:
PortalException

getCapability

public <T extends Capability> T getCapability(Class<T> capabilityClass)
Specified by:
getCapability in interface CapabilityProvider

getCompanyId

public long getCompanyId()

getFileEntriesAndFileShortcuts

public List<Object> getFileEntriesAndFileShortcuts(long folderId,
                                                   int status,
                                                   int start,
                                                   int end)
                                            throws PortalException
Specified by:
getFileEntriesAndFileShortcuts in interface Repository
Throws:
PortalException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long folderId,
                                               int status)
                                        throws PortalException
Specified by:
getFileEntriesAndFileShortcutsCount in interface Repository
Throws:
PortalException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long folderId,
                                               int status,
                                               String[] mimeTypes)
                                        throws PortalException
Specified by:
getFileEntriesAndFileShortcutsCount in interface Repository
Throws:
PortalException

getFolders

public List<Folder> getFolders(long parentFolderId,
                               int status,
                               boolean includeMountfolders,
                               int start,
                               int end,
                               OrderByComparator<Folder> obc)
                        throws PortalException
Specified by:
getFolders in interface Repository
Throws:
PortalException

getFoldersAndFileEntries

public abstract List<Object> getFoldersAndFileEntries(long folderId,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<?> obc)

getFoldersAndFileEntries

public abstract List<Object> getFoldersAndFileEntries(long folderId,
                                                      String[] mimeTypes,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<?> obc)
                                               throws PortalException
Throws:
PortalException

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                             int status,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<?> obc)
Specified by:
getFoldersAndFileEntriesAndFileShortcuts in interface Repository

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                             int status,
                                                             String[] mimeTypes,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<?> obc)
                                                      throws PortalException
Specified by:
getFoldersAndFileEntriesAndFileShortcuts in interface Repository
Throws:
PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
Specified by:
getFoldersAndFileEntriesAndFileShortcutsCount in interface Repository

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                         int status,
                                                         String[] mimeTypes,
                                                         boolean includeMountFolders)
                                                  throws PortalException
Specified by:
getFoldersAndFileEntriesAndFileShortcutsCount in interface Repository
Throws:
PortalException

getFoldersAndFileEntriesCount

public abstract int getFoldersAndFileEntriesCount(long folderId)

getFoldersAndFileEntriesCount

public abstract int getFoldersAndFileEntriesCount(long folderId,
                                                  String[] mimeTypes)
                                           throws PortalException
Throws:
PortalException

getFoldersCount

public int getFoldersCount(long parentFolderId,
                           int status,
                           boolean includeMountfolders)
                    throws PortalException
Specified by:
getFoldersCount in interface Repository
Throws:
PortalException

getGroupId

public long getGroupId()

getLocalRepository

public LocalRepository getLocalRepository()
Specified by:
getLocalRepository in interface BaseRepository

getRepositoryEntryIds

public Object[] getRepositoryEntryIds(String objectId)
                               throws PortalException
Throws:
PortalException

getRepositoryFileEntries

public List<FileEntry> getRepositoryFileEntries(long userId,
                                                long rootFolderId,
                                                int start,
                                                int end,
                                                OrderByComparator<FileEntry> obc)
                                         throws PortalException
Specified by:
getRepositoryFileEntries in interface Repository
Throws:
PortalException

getRepositoryFileEntries

public List<FileEntry> getRepositoryFileEntries(long userId,
                                                long rootFolderId,
                                                String[] mimeTypes,
                                                int status,
                                                int start,
                                                int end,
                                                OrderByComparator<FileEntry> obc)
                                         throws PortalException
Specified by:
getRepositoryFileEntries in interface Repository
Throws:
PortalException

getRepositoryFileEntriesCount

public int getRepositoryFileEntriesCount(long userId,
                                         long rootFolderId)
                                  throws PortalException
Specified by:
getRepositoryFileEntriesCount in interface Repository
Throws:
PortalException

getRepositoryFileEntriesCount

public int getRepositoryFileEntriesCount(long userId,
                                         long rootFolderId,
                                         String[] mimeTypes,
                                         int status)
                                  throws PortalException
Specified by:
getRepositoryFileEntriesCount in interface Repository
Throws:
PortalException

getRepositoryId

public long getRepositoryId()
Specified by:
getRepositoryId in interface DocumentRepository

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()

initRepository

public abstract void initRepository()
                             throws PortalException
Specified by:
initRepository in interface BaseRepository
Throws:
PortalException

isCapabilityProvided

public <T extends Capability> boolean isCapabilityProvided(Class<T> capabilityClass)
Specified by:
isCapabilityProvided in interface CapabilityProvider

lockFileEntry

@Deprecated
public Lock lockFileEntry(long fileEntryId)
                   throws PortalException
Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, ServiceContext)

Specified by:
lockFileEntry in interface Repository
Throws:
PortalException

lockFileEntry

@Deprecated
public Lock lockFileEntry(long fileEntryId,
                                     String owner,
                                     long expirationTime)
                   throws PortalException
Deprecated. As of 6.2.0, replaced by Repository.checkOutFileEntry(long, String, long, ServiceContext)

Specified by:
lockFileEntry in interface Repository
Throws:
PortalException

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

setDLAppHelperLocalService

public void setDLAppHelperLocalService(DLAppHelperLocalService dlAppHelperLocalService)
Specified by:
setDLAppHelperLocalService in interface BaseRepository

setGroupId

public void setGroupId(long groupId)
Specified by:
setGroupId in interface BaseRepository

setRepositoryEntryLocalService

public void setRepositoryEntryLocalService(RepositoryEntryLocalService repositoryEntryLocalService)
Specified by:
setRepositoryEntryLocalService 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,
                         String name,
                         String lockUuid)
                  throws PortalException
Specified by:
unlockFolder in interface Repository
Throws:
PortalException

updateFileEntry

public FileEntry updateFileEntry(long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 File file,
                                 ServiceContext serviceContext)
                          throws PortalException
Specified by:
updateFileEntry in interface Repository
Throws:
PortalException

verifyFileEntryLock

public boolean verifyFileEntryLock(long fileEntryId,
                                   String lockUuid)
Specified by:
verifyFileEntryLock in interface Repository

clearManualCheckInRequired

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

setManualCheckInRequired

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

Liferay 7.0-ce-m2