info.magnolia.rest.delivery.jcr.v1

Class WorkspaceParameters

java.lang.Object

info.magnolia.rest.delivery.jcr.v1.WorkspaceParameters

Deprecated.

since 2.1, consider to use JcrDeliveryEndpoint with embedded configuration.

@Deprecated
public class WorkspaceParameters
extends Object

Default parameters for a specific workspace, for use by the JCR delivery endpoint.

Constructor Summary

Constructors

Constructor and Description
WorkspaceParameters() Deprecated.

Method Summary

Modifier and Type	Method and Description
List<String>	getChildNodeTypes() Deprecated.
int	getDepth() Deprecated. Defines the depth for child-nodes to be included in the responses.
long	getLimit() Deprecated. Defines the amount of results to return in a paginated result set.
List<String>	getNodeTypes() Deprecated.
List<ReferenceDefinition>	getReferences() Deprecated.
String	getRootPath() Deprecated. Defines the root path used to resolve the given node path parameter, and to execute queries.
String	getWorkspace() Deprecated. Defines the target workspace to serve content from.
boolean	isBypassWorkspaceAcls() Deprecated. Defines whether or not workspace permissions (ACLs) should be evaluated.
boolean	isIncludeSystemProperties() Deprecated. Defines whether jcr:—and mgnl:-prefixed properties will be included in responses.
void	setBypassWorkspaceAcls(boolean bypassWorkspaceAcls) Deprecated.
void	setChildNodeTypes(List<String> childNodeTypes) Deprecated.
void	setDepth(int depth) Deprecated.
void	setIncludeSystemProperties(boolean includeSystemProperties) Deprecated.
void	setLimit(long limit) Deprecated.
void	setNodeTypes(List<String> nodeTypes) Deprecated.
void	setReferences(List<ReferenceDefinition> references) Deprecated.
void	setRootPath(String rootPath) Deprecated.
void	setWorkspace(String workspace) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceParameters

public WorkspaceParameters()

Deprecated.

Method Detail

getWorkspace

public String getWorkspace()

Deprecated.

Defines the target workspace to serve content from.

Returns:

a logical workspace name; if empty the JcrDeliveryEndpoint will try to use the workspace-params key as both endpoint prefix and workspace name.

setWorkspace

public void setWorkspace(String workspace)

Deprecated.

getRootPath

public String getRootPath()

Deprecated.

Defines the root path used to resolve the given node path parameter, and to execute queries.

setRootPath

public void setRootPath(String rootPath)

Deprecated.

getDepth

public int getDepth()

Deprecated.

Defines the depth for child-nodes to be included in the responses.

Returns:

the depth, relative to result nodes; by default, child-nodes are not included.

setDepth

public void setDepth(int depth)

Deprecated.

isIncludeSystemProperties

public boolean isIncludeSystemProperties()

Deprecated.

Defines whether jcr:—and mgnl:-prefixed properties will be included in responses.

Returns:

false by default.

setIncludeSystemProperties

public void setIncludeSystemProperties(boolean includeSystemProperties)

Deprecated.

getNodeTypes

public List<String> getNodeTypes()

Deprecated.

setNodeTypes

public void setNodeTypes(List<String> nodeTypes)

Deprecated.

getChildNodeTypes

public List<String> getChildNodeTypes()

Deprecated.

setChildNodeTypes

public void setChildNodeTypes(List<String> childNodeTypes)

Deprecated.

getLimit

public long getLimit()

Deprecated.

Defines the amount of results to return in a paginated result set.

Returns:

10 by default

setLimit

public void setLimit(long limit)

Deprecated.

isBypassWorkspaceAcls

public boolean isBypassWorkspaceAcls()

Deprecated.

Defines whether or not workspace permissions (ACLs) should be evaluated.

This may be used to serve all content for the given workspace params to anonymous users; until relevant JCR permissions for the anonymous user are set up.
Mind however that URI permissions are still evaluated. The rest-anonymous role has a GET permission to '/.rest/delivery/*'.

setBypassWorkspaceAcls

public void setBypassWorkspaceAcls(boolean bypassWorkspaceAcls)

Deprecated.

getReferences

public List<ReferenceDefinition> getReferences()

Deprecated.

setReferences

public void setReferences(List<ReferenceDefinition> references)

Deprecated.