Package org.pentaho.platform.repository2.unified.webservices

Interface IUnifiedRepositoryWebService

All Known Subinterfaces:

IUnifiedRepositoryJaxwsWebService

All Known Implementing Classes:

DefaultUnifiedRepositoryJaxwsWebService, DefaultUnifiedRepositoryWebService, DiUnifiedRepositoryJaxwsWebService

public interface IUnifiedRepositoryWebService

JAX-WS-safe version of IUnifiedRepositoryService.

• No method overloading (e.g. getFile(id, versionId) becomes getFileAtVersion(id, versionId).
• No interfaces (e.g. Serializable becomes String).
• No references to public static inner classes.

Author:

mlowery

Method Summary

Modifier and Type	Method	Description
boolean	canUnlockFile(String fileId)
void	copyFile(String string, String destAbsPath, String versionMessage)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	createFile(String parentFolderId, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data, String versionMessage)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	createFileWithAcl(String parentFolderId, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl, String versionMessage)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	createFolder(String parentFolderId, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, String versionMessage)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	createFolderWithAcl(String parentFolderId, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl, String versionMessage)
void	deleteFile(String fileId, String versionMessage)
void	deleteFileAtVersion(String fileId, String versionId)
void	deleteFileWithPermanentFlag(String fileId, boolean permanent, String versionMessage)
void	deleteLocalePropertiesForFile(String fileId, String locale)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto	getAcl(String fileId)
List<PentahoLocale>	getAvailableLocalesForFileById(String fileId)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getChildren(String folderId)	Deprecated.
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getChildrenFromRequest(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getChildrenWithFilter(String folderId, String filter)	Deprecated.
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getChildrenWithFilterAndHidden(String folderId, String filter, Boolean showHiddenFiles)	Deprecated.
org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto	getDataAsNodeForRead(String fileId)
org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto	getDataAsNodeForReadAtVersion(String fileId, String versionId)
List<org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto>	getDataAsNodeForReadInBatch(List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> files)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getDeletedFiles()
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getDeletedFilesInFolder(String folderPath)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getDeletedFilesInFolderWithFilter(String folderPath, String filter)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto>	getEffectiveAces(String fileId)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto>	getEffectiveAcesWithForceFlag(String fileId, boolean forceEntriesInheriting)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	getFile(String path, boolean loadLocaleMaps, PentahoLocale locale)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	getFileAtVersion(String fileId, String versionId)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	getFileById(String fileId, boolean loadLocaleMaps, PentahoLocale locale)
List<org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto>	getFileMetadata(String fileId)
PropertiesWrapper	getLocalePropertiesForFileById(String fileId, String locale)
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto>	getReferrers(String fileId)
List<Character>	getReservedChars()
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto	getTree(String path, int depth, String filter, boolean showHidden)	Deprecated.
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto	getTreeFromRequest(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)
List<org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto>	getVersionSummaries(String fileId)
org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto	getVersionSummary(String fileId, String versionId)
List<org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto>	getVersionSummaryInBatch(List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> files)
boolean	hasAccess(String path, List<Integer> permissions)
void	lockFile(String fileId, String message)
void	moveFile(String fileId, String destAbsPath, String versionMessage)
void	restoreFileAtVersion(String fileId, String versionId, String versionMessage)
void	setFileMetadata(String fileId, List<org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto> fileMetadataMap)
void	setLocalePropertiesForFileByFileId(String fileId, String locale, Properties properties)
void	undeleteFile(String fileId, String versionMessage)
void	unlockFile(String fileId)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto	updateAcl(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	updateFile(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data, String versionMessage)
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto	updateFolder(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file, String versionMessage)

Method Detail

getFile

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto getFile(String path,
                                                                                   boolean loadLocaleMaps,
                                                                                   PentahoLocale locale)

getFileById

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto getFileById(String fileId,
                                                                                       boolean loadLocaleMaps,
                                                                                       PentahoLocale locale)

getDataAsNodeForRead

org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto getDataAsNodeForRead(String fileId)

getDataAsNodeForReadInBatch

List<org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto> getDataAsNodeForReadInBatch(List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> files)

createFile

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto createFile(String parentFolderId,
                                                                                      org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                      org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data,
                                                                                      String versionMessage)

createFileWithAcl

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto createFileWithAcl(String parentFolderId,
                                                                                             org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                             org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data,
                                                                                             org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl,
                                                                                             String versionMessage)

createFolder

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto createFolder(String parentFolderId,
                                                                                        org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                        String versionMessage)

updateFolder

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto updateFolder(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                        String versionMessage)

createFolderWithAcl

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto createFolderWithAcl(String parentFolderId,
                                                                                               org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                               org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl,
                                                                                               String versionMessage)

getChildren

@Deprecated
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getChildren(String folderId)

Deprecated.

getChildrenWithFilter

@Deprecated
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getChildrenWithFilter(String folderId,
                                                                                                       String filter)

Deprecated.

getChildrenWithFilterAndHidden

@Deprecated
List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getChildrenWithFilterAndHidden(String folderId,
                                                                                                                String filter,
                                                                                                                Boolean showHiddenFiles)

Deprecated.

getChildrenFromRequest

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getChildrenFromRequest(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)

updateFile

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto updateFile(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto file,
                                                                                      org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto data,
                                                                                      String versionMessage)

deleteFileWithPermanentFlag

void deleteFileWithPermanentFlag(String fileId,
                                 boolean permanent,
                                 String versionMessage)

deleteFile

void deleteFile(String fileId,
                String versionMessage)

deleteFileAtVersion

void deleteFileAtVersion(String fileId,
                         String versionId)

undeleteFile

void undeleteFile(String fileId,
                  String versionMessage)

getDeletedFilesInFolder

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getDeletedFilesInFolder(String folderPath)

getDeletedFilesInFolderWithFilter

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getDeletedFilesInFolderWithFilter(String folderPath,
                                                                                                                   String filter)

getDeletedFiles

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getDeletedFiles()

moveFile

void moveFile(String fileId,
              String destAbsPath,
              String versionMessage)

copyFile

void copyFile(String string,
              String destAbsPath,
              String versionMessage)

lockFile

void lockFile(String fileId,
              String message)

unlockFile

void unlockFile(String fileId)

getTree

@Deprecated
org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto getTree(String path,
                                                                                       int depth,
                                                                                       String filter,
                                                                                       boolean showHidden)

Deprecated.

getTreeFromRequest

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto getTreeFromRequest(org.pentaho.platform.api.repository2.unified.RepositoryRequest repositoryRequest)

getAcl

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto getAcl(String fileId)

updateAcl

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto updateAcl(org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto acl)

hasAccess

boolean hasAccess(String path,
                  List<Integer> permissions)

getEffectiveAces

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto> getEffectiveAces(String fileId)

getEffectiveAcesWithForceFlag

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto> getEffectiveAcesWithForceFlag(String fileId,
                                                                                                                     boolean forceEntriesInheriting)

getDataAsNodeForReadAtVersion

org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto getDataAsNodeForReadAtVersion(String fileId,
                                                                                                                 String versionId)

getVersionSummary

org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto getVersionSummary(String fileId,
                                                                                             String versionId)

getVersionSummaryInBatch

List<org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto> getVersionSummaryInBatch(List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> files)

getVersionSummaries

List<org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto> getVersionSummaries(String fileId)

getFileAtVersion

org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto getFileAtVersion(String fileId,
                                                                                            String versionId)

restoreFileAtVersion

void restoreFileAtVersion(String fileId,
                          String versionId,
                          String versionMessage)

canUnlockFile

boolean canUnlockFile(String fileId)

getReferrers

List<org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto> getReferrers(String fileId)

setFileMetadata

void setFileMetadata(String fileId,
                     List<org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto> fileMetadataMap)

getFileMetadata

List<org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto> getFileMetadata(String fileId)

getReservedChars

List<Character> getReservedChars()

getAvailableLocalesForFileById

List<PentahoLocale> getAvailableLocalesForFileById(String fileId)

getLocalePropertiesForFileById

PropertiesWrapper getLocalePropertiesForFileById(String fileId,
                                                 String locale)

setLocalePropertiesForFileByFileId

void setLocalePropertiesForFileByFileId(String fileId,
                                        String locale,
                                        Properties properties)

deleteLocalePropertiesForFile

void deleteLocalePropertiesForFile(String fileId,
                                   String locale)