public class RepositoryRequest extends Object
Modifier and Type | Class and Description |
---|---|
static class |
RepositoryRequest.FILES_TYPE_FILTER |
Modifier and Type | Field and Description |
---|---|
static String |
PATH_SEPARATOR |
Constructor and Description |
---|
RepositoryRequest()
This class encapsulates the parameters received by the "children" and "tree" REST calls.
|
RepositoryRequest(String path,
Boolean showHidden,
Integer depth,
String legacyFilter) |
Modifier and Type | Method and Description |
---|---|
String |
getChildNodeFilter() |
Integer |
getDepth() |
Set<String> |
getExcludeMemberSet() |
Set<String> |
getIncludeMemberSet() |
String |
getPath() |
RepositoryRequest.FILES_TYPE_FILTER |
getTypes() |
boolean |
isIncludeAcls() |
boolean |
isShowHidden() |
void |
setChildNodeFilter(String childNodeFilter) |
void |
setDepth(Integer depth) |
void |
setExcludeMemberSet(Set<String> excludeMemberSet) |
void |
setIncludeAcls(boolean includeAcls) |
void |
setIncludeMemberSet(Set<String> includeMemberSet) |
void |
setPath(String path) |
void |
setShowHidden(boolean showHidden) |
void |
setTypes(RepositoryRequest.FILES_TYPE_FILTER types)
Sets whether files, folders, or both are returned: ( FILES | FOLDERS | [default] FILES_FOLDERS )
|
public static final String PATH_SEPARATOR
public RepositoryRequest()
public RepositoryRequest.FILES_TYPE_FILTER getTypes()
public void setTypes(RepositoryRequest.FILES_TYPE_FILTER types)
public void setIncludeMemberSet(Set<String> includeMemberSet)
includeMemberSet
- A set of field names to be included in the output.public void setExcludeMemberSet(Set<String> excludeMemberSet)
includeMemberSet
- A set of field names to be excluded in the output.public boolean isShowHidden()
public void setShowHidden(boolean showHidden)
showHidden
- Whether to return information about hidden files. Default is false.public Integer getDepth()
public void setDepth(Integer depth)
depth
- 0 fetches just file at path; positive integer n fetches node at path plus n levels of children; negative
integer fetches all children. If n > 0 and setTypes(FILES_TYPE_FILTER)
is set to
FILES then only the top level children will be processed.public String getChildNodeFilter()
public void setChildNodeFilter(String childNodeFilter)
childNodefilter
- filter may be a full name or a partial name with one or more wildcard characters ("*"), or a disjunction
(using the "|" character to represent logical OR) of these; filter does not apply to root node.public String getPath()
public void setPath(String path)
path
- Path to filepublic boolean isIncludeAcls()
public void setIncludeAcls(boolean includeAcls)
includeAcls
- Set to true to return ACL permission information with the output. Default is false.Copyright © 2002–2017 Pentaho Corporation. All rights reserved.