Package org.craftercms.core.controller.rest

Class ContentStoreRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.core.controller.rest.ContentStoreRestController

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@RestController
@RequestMapping("${crafter.core.rest.base.uri}/content_store")
public class ContentStoreRestController
extends RestControllerBase
implements org.springframework.beans.factory.InitializingBean

REST service that provides several methods to access the Crafter content store.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_CONTROL_HEADER_NAME
static final String	MUST_REVALIDATE_HEADER_VALUE
static final String	REQUEST_PARAM_CONTEXT_ID
static final String	REQUEST_PARAM_TREE_DEPTH
static final String	REQUEST_PARAM_URL
static final String	URL_CHILDREN
static final String	URL_DESCRIPTOR
static final String	URL_ITEM
static final String	URL_ROOT
static final String	URL_TREE

Fields inherited from class org.craftercms.core.controller.rest.RestControllerBase

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor	Description
ContentStoreRestController(ContentStoreService storeService, int treeDepthLimit)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<Item>	getChildren(org.springframework.web.context.request.WebRequest request, jakarta.servlet.http.HttpServletResponse response, String contextId, String url, boolean flatten)
org.dom4j.Document	getDescriptor(org.springframework.web.context.request.WebRequest request, jakarta.servlet.http.HttpServletResponse response, String contextId, String url, boolean flatten)	Deprecated. Will be removed in 4.1, use getItem instead
Item	getItem(org.springframework.web.context.request.WebRequest request, jakarta.servlet.http.HttpServletResponse response, String contextId, String url, boolean flatten)
Tree	getTree(org.springframework.web.context.request.WebRequest request, jakarta.servlet.http.HttpServletResponse response, String contextId, String url, Integer depth, boolean flatten)
void	setAllowedUrlPatterns(String[] allowedUrlPatterns)
void	setForbiddenUrlPatterns(String[] forbiddenUrlPatterns)

Methods inherited from class org.craftercms.core.controller.rest.RestControllerBase

createResponseMessage, createSingletonModifiableMap

Methods inherited from class java.lang.Object

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

Field Details

URL_ROOT

public static final String URL_ROOT

See Also:

• Constant Field Values

CACHE_CONTROL_HEADER_NAME

public static final String CACHE_CONTROL_HEADER_NAME

See Also:

• Constant Field Values

MUST_REVALIDATE_HEADER_VALUE

public static final String MUST_REVALIDATE_HEADER_VALUE

See Also:

• Constant Field Values

REQUEST_PARAM_CONTEXT_ID

public static final String REQUEST_PARAM_CONTEXT_ID

See Also:

• Constant Field Values

REQUEST_PARAM_URL

public static final String REQUEST_PARAM_URL

See Also:

• Constant Field Values

REQUEST_PARAM_TREE_DEPTH

public static final String REQUEST_PARAM_TREE_DEPTH

See Also:

• Constant Field Values

URL_DESCRIPTOR

public static final String URL_DESCRIPTOR

See Also:

• Constant Field Values

URL_ITEM

public static final String URL_ITEM

See Also:

• Constant Field Values

URL_CHILDREN

public static final String URL_CHILDREN

See Also:

• Constant Field Values

URL_TREE

public static final String URL_TREE

See Also:

• Constant Field Values

Constructor Details

ContentStoreRestController

@ConstructorProperties({"storeService","treeDepthLimit"})
public ContentStoreRestController(ContentStoreService storeService,
 int treeDepthLimit)

Method Details

setAllowedUrlPatterns

public void setAllowedUrlPatterns(String[] allowedUrlPatterns)

setForbiddenUrlPatterns

public void setForbiddenUrlPatterns(String[] forbiddenUrlPatterns)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getDescriptor

@RequestMapping(value="/descriptor",
                method=GET)
public org.dom4j.Document getDescriptor(org.springframework.web.context.request.WebRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam("contextId")
 String contextId,
 @RequestParam("url")
 String url,
 @RequestParam(required=false,defaultValue="false")
 boolean flatten)
                                 throws InvalidContextException,
StoreException,
PathNotFoundException,
ForbiddenPathException,
ItemProcessingException,
XmlMergeException,
XmlFileParseException

Deprecated.

Will be removed in 4.1, use getItem instead

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getItem

@RequestMapping(value="/item",
                method=GET)
public Item getItem(org.springframework.web.context.request.WebRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam("contextId")
 String contextId,
 @RequestParam("url")
 String url,
 @RequestParam(required=false,defaultValue="false")
 boolean flatten)
             throws InvalidContextException,
StoreException,
PathNotFoundException,
ForbiddenPathException,
ItemProcessingException,
XmlMergeException,
XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getChildren

@RequestMapping(value="/children",
                method=GET)
public List<Item> getChildren(org.springframework.web.context.request.WebRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam("contextId")
 String contextId,
 @RequestParam("url")
 String url,
 @RequestParam(required=false,defaultValue="false")
 boolean flatten)
                       throws InvalidContextException,
StoreException,
PathNotFoundException,
ForbiddenPathException,
ItemProcessingException,
XmlMergeException,
XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getTree

@RequestMapping(value="/tree",
                method=GET)
public Tree getTree(org.springframework.web.context.request.WebRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam("contextId")
 String contextId,
 @RequestParam("url")
 String url,
 @RequestParam(value="depth",required=false)
 Integer depth,
 @RequestParam(required=false,defaultValue="false")
 boolean flatten)
             throws InvalidContextException,
StoreException,
PathNotFoundException,
ForbiddenPathException,
ItemProcessingException,
XmlMergeException,
XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException