org.pentaho.platform.web.http.api.resources

Class FileResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

org.pentaho.platform.web.http.api.resources.FileResource

public class FileResource
extends AbstractJaxRSResource

Represents a file node in the getRepository(). This api provides methods for discovering information about repository files as well as CRUD operations

Author:

aaron

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_ZIP
static String	PATH_SEPARATOR

Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
FileResource()
FileResource(javax.servlet.http.HttpServletResponse httpServletResponse)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	copyFiles(String pathId, Integer mode, String params)
javax.ws.rs.core.Response	createFile(String pathId, InputStream fileContents)
javax.ws.rs.core.Response	doDeleteFiles(String params)
javax.ws.rs.core.Response	doDeleteFilesPermanent(String params)
javax.ws.rs.core.Response	doDeleteLocale(String pathId, String locale)
String	doGetCanAccess(String pathId, String permissions)
List<Setting>	doGetCanAccessList(String pathId, String permissions)
String	doGetCanAdminister()
String	doGetCanCreate()
org.pentaho.platform.repository2.unified.webservices.RepositoryFileTreeDto	doGetChildren(String pathId, Integer depth, String filter, Boolean showHidden)
org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto	doGetContentCreator(String pathId)
List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto>	doGetDeletedFiles()
javax.ws.rs.core.Response	doGetDirAsZip(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile)
javax.ws.rs.core.Response	doGetDirAsZip(String pathId)
org.pentaho.platform.repository2.unified.webservices.RepositoryFileAclDto	doGetFileAcl(String pathId)
javax.ws.rs.core.Response	doGetFileAsInline(String pathId)
List<org.pentaho.platform.repository2.unified.webservices.LocaleMapDto>	doGetFileLocales(String pathId)
javax.ws.rs.core.Response	doGetFileOrDir(org.pentaho.platform.api.repository2.unified.RepositoryFile repoFile) Overloaded this method to try and reduce calls to the repository
javax.ws.rs.core.Response	doGetFileOrDir(String pathId) Overloaded this method to try and reduce calls to the repository
javax.ws.rs.core.Response	doGetFileOrDirAsDownload(String pathId, String strWithManifest) Compatibility endpoint for browsers since you can't specify Accepts headers in browsers Added path param withManifest to indicate that manifest containing ACL and metadata should be included
List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto>	doGetGeneratedContent(String pathId)
List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto>	doGetGeneratedContentForSchedule(String lineageId)
List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto>	doGetGeneratedContentForUser(String pathId, String user)
List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto>	doGetLocaleProperties(String pathId, String locale)
List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto>	doGetMetadata(String pathId)
org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto	doGetProperties(String pathId)
org.pentaho.platform.repository2.unified.webservices.RepositoryFileTreeDto	doGetRootChildren(Integer depth, String filter, Boolean showHidden)
org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto	doGetRootProperties()
String	doIsParameterizable(String pathId)
javax.ws.rs.core.Response	doRename(String pathId, String newName)
javax.ws.rs.core.Response	doRestore(String params)
javax.ws.rs.core.Response	doSetLocaleProperties(String pathId, String locale, List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> properties)
javax.ws.rs.core.Response	doSetMetadata(String pathId, List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> metadata) Even though the hidden flag is a property of the file node itself, and not the metadata child, it is considered metadata from PUC and is included in the setMetadata call
static org.pentaho.platform.api.engine.IAuthorizationPolicy	getPolicy()
static org.pentaho.platform.api.repository2.unified.IUnifiedRepository	getRepository()
static org.pentaho.platform.repository2.unified.webservices.DefaultUnifiedRepositoryWebService	getRepoWs()
org.pentaho.platform.repository.RepositoryDownloadWhitelist	getWhitelist()
static String	idToPath(String pathId)
javax.ws.rs.core.Response	setContentCreator(String pathId, org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto contentCreator)
javax.ws.rs.core.Response	setFileAcls(String pathId, org.pentaho.platform.repository2.unified.webservices.RepositoryFileAclDto acl)
void	setWhitelist(org.pentaho.platform.repository.RepositoryDownloadWhitelist whitelist)

Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

setHttpHeaders

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

Constant Field Values

APPLICATION_ZIP

public static final String APPLICATION_ZIP

See Also:

Constant Field Values

Constructor Detail

FileResource

public FileResource()

FileResource

public FileResource(javax.servlet.http.HttpServletResponse httpServletResponse)

Method Detail

idToPath

public static String idToPath(String pathId)

doDeleteFiles

public javax.ws.rs.core.Response doDeleteFiles(String params)

doDeleteFilesPermanent

public javax.ws.rs.core.Response doDeleteFilesPermanent(String params)

doRestore

public javax.ws.rs.core.Response doRestore(String params)

createFile

public javax.ws.rs.core.Response createFile(String pathId,
                                   InputStream fileContents)
                                     throws IOException

Throws:

IOException

copyFiles

public javax.ws.rs.core.Response copyFiles(String pathId,
                                  Integer mode,
                                  String params)

doGetFileOrDir

public javax.ws.rs.core.Response doGetFileOrDir(String pathId)
                                         throws FileNotFoundException

Overloaded this method to try and reduce calls to the repository

Parameters:

pathId -

Returns:

Throws:

FileNotFoundException

doGetFileOrDir

public javax.ws.rs.core.Response doGetFileOrDir(org.pentaho.platform.api.repository2.unified.RepositoryFile repoFile)
                                         throws FileNotFoundException

Overloaded this method to try and reduce calls to the repository

Parameters:

repoFile -

Returns:

Throws:

FileNotFoundException

doGetDirAsZip

public javax.ws.rs.core.Response doGetDirAsZip(String pathId)

doGetDirAsZip

public javax.ws.rs.core.Response doGetDirAsZip(org.pentaho.platform.api.repository2.unified.RepositoryFile repositoryFile)

Parameters:

repositoryFile -

Returns:

doIsParameterizable

public String doIsParameterizable(String pathId)
                           throws FileNotFoundException

Throws:

FileNotFoundException

doGetFileOrDirAsDownload

public javax.ws.rs.core.Response doGetFileOrDirAsDownload(String pathId,
                                                 String strWithManifest)
                                                   throws FileNotFoundException

Compatibility endpoint for browsers since you can't specify Accepts headers in browsers Added path param withManifest to indicate that manifest containing ACL and metadata should be included

Parameters:

pathId -

Returns:

Throws:

FileNotFoundException

doGetFileAsInline

public javax.ws.rs.core.Response doGetFileAsInline(String pathId)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

setFileAcls

public javax.ws.rs.core.Response setFileAcls(String pathId,
                                    org.pentaho.platform.repository2.unified.webservices.RepositoryFileAclDto acl)

setContentCreator

public javax.ws.rs.core.Response setContentCreator(String pathId,
                                          org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto contentCreator)

doGetFileLocales

public List<org.pentaho.platform.repository2.unified.webservices.LocaleMapDto> doGetFileLocales(String pathId)

doGetLocaleProperties

public List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> doGetLocaleProperties(String pathId,
                                                                                                       String locale)

doSetLocaleProperties

public javax.ws.rs.core.Response doSetLocaleProperties(String pathId,
                                              String locale,
                                              List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> properties)

doDeleteLocale

public javax.ws.rs.core.Response doDeleteLocale(String pathId,
                                       String locale)

doGetRootProperties

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto doGetRootProperties()

doGetCanAccessList

public List<Setting> doGetCanAccessList(String pathId,
                               String permissions)

doGetCanAccess

public String doGetCanAccess(String pathId,
                    String permissions)

doGetCanAdminister

public String doGetCanAdminister()

doGetCanCreate

public String doGetCanCreate()

doGetFileAcl

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileAclDto doGetFileAcl(String pathId)

doGetProperties

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto doGetProperties(String pathId)

doGetContentCreator

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto doGetContentCreator(String pathId)

doGetGeneratedContent

public List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto> doGetGeneratedContent(String pathId)

doGetGeneratedContentForUser

public List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto> doGetGeneratedContentForUser(String pathId,
                                                                                                        String user)

doGetGeneratedContentForSchedule

public List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto> doGetGeneratedContentForSchedule(String lineageId)

doGetRootChildren

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileTreeDto doGetRootChildren(Integer depth,
                                                                                           String filter,
                                                                                           Boolean showHidden)

doGetChildren

public org.pentaho.platform.repository2.unified.webservices.RepositoryFileTreeDto doGetChildren(String pathId,
                                                                                       Integer depth,
                                                                                       String filter,
                                                                                       Boolean showHidden)

doGetDeletedFiles

public List<org.pentaho.platform.repository2.unified.webservices.RepositoryFileDto> doGetDeletedFiles()

doGetMetadata

public List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> doGetMetadata(String pathId)

doRename

public javax.ws.rs.core.Response doRename(String pathId,
                                 String newName)

doSetMetadata

public javax.ws.rs.core.Response doSetMetadata(String pathId,
                                      List<org.pentaho.platform.repository2.unified.webservices.StringKeyStringValueDto> metadata)

Even though the hidden flag is a property of the file node itself, and not the metadata child, it is considered metadata from PUC and is included in the setMetadata call

Parameters:

pathId -

metadata -

Returns:

getWhitelist

public org.pentaho.platform.repository.RepositoryDownloadWhitelist getWhitelist()

setWhitelist

public void setWhitelist(org.pentaho.platform.repository.RepositoryDownloadWhitelist whitelist)

getPolicy

public static org.pentaho.platform.api.engine.IAuthorizationPolicy getPolicy()

getRepository

public static org.pentaho.platform.api.repository2.unified.IUnifiedRepository getRepository()

getRepoWs

public static org.pentaho.platform.repository2.unified.webservices.DefaultUnifiedRepositoryWebService getRepoWs()