public interface JcrDeliveryEndpointDefinition
extends info.magnolia.rest.EndpointDefinition
JcrDeliveryEndpointDefinition
configures the behavior of the JcrDeliveryEndpoint
to serve content from specific workspaces or node types.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() |
default 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.
|
default boolean |
isReferenceRepeat() |
default boolean |
isStrict()
Specifies whether to include only the exact node type and ignore sub types.
|
String getWorkspace()
String getRootPath()
default boolean isStrict()
int getDepth()
default int getReferenceDepth()
default boolean isReferenceRepeat()
long getLimit()
boolean isIncludeSystemProperties()
boolean isBypassWorkspaceAcls()
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/*'.
List<ReferenceDefinition> getReferences()
Copyright © 2020 Magnolia International Ltd.. All rights reserved.