info.magnolia.rest.delivery.jcr.v2

Class ConfiguredJcrDeliveryEndpointDefinition

java.lang.Object

info.magnolia.rest.registry.ConfiguredEndpointDefinition

info.magnolia.rest.delivery.jcr.v2.ConfiguredJcrDeliveryEndpointDefinition

All Implemented Interfaces:

JcrDeliveryEndpointDefinition, info.magnolia.rest.EndpointDefinition, Serializable

public class ConfiguredJcrDeliveryEndpointDefinition
extends info.magnolia.rest.registry.ConfiguredEndpointDefinition
implements JcrDeliveryEndpointDefinition

Configured content delivery node endpoint definition version 2.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfiguredJcrDeliveryEndpointDefinition()

Method Summary

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

Methods inherited from class info.magnolia.rest.registry.ConfiguredEndpointDefinition

getEndpointPath, getImplementationClass, getName, isEnabled, setEnabled, setEndpointPath, setImplementationClass, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.rest.EndpointDefinition

getEndpointPath, getImplementationClass, getName, isEnabled

Constructor Detail

ConfiguredJcrDeliveryEndpointDefinition

public ConfiguredJcrDeliveryEndpointDefinition()

Method Detail

getWorkspace

public String getWorkspace()

Description copied from interface: JcrDeliveryEndpointDefinition

Defines the target workspace to serve content from.

Specified by:

getWorkspace in interface JcrDeliveryEndpointDefinition

Returns:

a workspace name;

setWorkspace

public void setWorkspace(String workspace)

getRootPath

public String getRootPath()

Description copied from interface: JcrDeliveryEndpointDefinition

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

Specified by:

getRootPath in interface JcrDeliveryEndpointDefinition

setRootPath

public void setRootPath(String rootPath)

isStrict

public boolean isStrict()

Description copied from interface: JcrDeliveryEndpointDefinition

Specifies whether to include only the exact node type and ignore sub types.

Specified by:

isStrict in interface JcrDeliveryEndpointDefinition

setStrict

public void setStrict(boolean strict)

getNodeTypes

public List<String> getNodeTypes()

Specified by:

getNodeTypes in interface JcrDeliveryEndpointDefinition

setNodeTypes

public void setNodeTypes(List<String> nodeTypes)

getChildNodeTypes

public List<String> getChildNodeTypes()

Specified by:

getChildNodeTypes in interface JcrDeliveryEndpointDefinition

setChildNodeTypes

public void setChildNodeTypes(List<String> childNodeTypes)

getDepth

public int getDepth()

Description copied from interface: JcrDeliveryEndpointDefinition

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

Specified by:

getDepth in interface JcrDeliveryEndpointDefinition

Returns:

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

setDepth

public void setDepth(int depth)

getReferenceDepth

public int getReferenceDepth()

Description copied from interface: JcrDeliveryEndpointDefinition

Defines the depth for resolving references..

Specified by:

getReferenceDepth in interface JcrDeliveryEndpointDefinition

setReferenceDepth

public void setReferenceDepth(int referenceDepth)

isReferenceRepeat

public boolean isReferenceRepeat()

Specified by:

isReferenceRepeat in interface JcrDeliveryEndpointDefinition

setReferenceRepeat

public void setReferenceRepeat(boolean referenceRepeat)

getLimit

public long getLimit()

Description copied from interface: JcrDeliveryEndpointDefinition

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

Specified by:

getLimit in interface JcrDeliveryEndpointDefinition

Returns:

10 by default

setLimit

public void setLimit(long limit)

isIncludeSystemProperties

public boolean isIncludeSystemProperties()

Description copied from interface: JcrDeliveryEndpointDefinition

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

Specified by:

isIncludeSystemProperties in interface JcrDeliveryEndpointDefinition

Returns:

false by default.

setIncludeSystemProperties

public void setIncludeSystemProperties(boolean includeSystemProperties)

isBypassWorkspaceAcls

public boolean isBypassWorkspaceAcls()

Description copied from interface: JcrDeliveryEndpointDefinition

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/*'.

Specified by:

isBypassWorkspaceAcls in interface JcrDeliveryEndpointDefinition

setBypassWorkspaceAcls

public void setBypassWorkspaceAcls(boolean bypassWorkspaceAcls)

getReferences

public List<ReferenceDefinition> getReferences()

Specified by:

getReferences in interface JcrDeliveryEndpointDefinition

setReferences

public void setReferences(List<ReferenceDefinition> references)

getSystemProperties

public List<String> getSystemProperties()

Specified by:

getSystemProperties in interface JcrDeliveryEndpointDefinition

setSystemProperties

public void setSystemProperties(List<String> systemProperties)