org.craftercms.core.controller.rest

Class ContentStoreRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.core.controller.rest.ContentStoreRestController

@Controller
 @RequestMapping(value="${crafter.core.rest.base.uri}/content_store")
public class ContentStoreRestController
extends RestControllerBase

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

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_CONTROL_HEADER_NAME
static String	MODEL_ATTR_CHILDREN
static String	MODEL_ATTR_DESCRIPTOR
static String	MODEL_ATTR_ITEM
static String	MODEL_ATTR_TREE
static String	MUST_REVALIDATE_HEADER_VALUE
static String	REQUEST_PARAM_CONTEXT_ID
static String	REQUEST_PARAM_TREE_DEPTH
static String	REQUEST_PARAM_URL
static String	URL_CHILDREN
static String	URL_DESCRIPTOR
static String	URL_ITEM
static String	URL_ROOT
static String	URL_TREE

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

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor and Description
ContentStoreRestController()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getChildren(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url)
Map<String,Object>	getDescriptor(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url)
Map<String,Object>	getItem(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url)
Map<String,Object>	getTree(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url, Integer depth)
void	init()
void	setAllowedUrlPatterns(String[] allowedUrlPatterns)
void	setForbiddenUrlPatterns(String[] forbiddenUrlPatterns)
void	setStoreService(ContentStoreService storeService)

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

createMessageModel, handleAuthenticationException, handleException, handleForbiddenPathException, handleInvalidContextException, handlePathNotFoundException, handleValidationException, handleValidationRuntimeException

Methods inherited from class java.lang.Object

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

Field Detail

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

MODEL_ATTR_DESCRIPTOR

public static final String MODEL_ATTR_DESCRIPTOR

See Also:

Constant Field Values

MODEL_ATTR_ITEM

public static final String MODEL_ATTR_ITEM

See Also:

Constant Field Values

MODEL_ATTR_CHILDREN

public static final String MODEL_ATTR_CHILDREN

See Also:

Constant Field Values

MODEL_ATTR_TREE

public static final String MODEL_ATTR_TREE

See Also:

Constant Field Values

Constructor Detail

ContentStoreRestController

public ContentStoreRestController()

Method Detail

setStoreService

public void setStoreService(ContentStoreService storeService)

setAllowedUrlPatterns

public void setAllowedUrlPatterns(String[] allowedUrlPatterns)

setForbiddenUrlPatterns

public void setForbiddenUrlPatterns(String[] forbiddenUrlPatterns)

init

@PostConstruct
public void init()

getDescriptor

@RequestMapping(value="/descriptor",
                method=GET)
public Map<String,Object> getDescriptor(org.springframework.web.context.request.WebRequest request,
                                                                                                         javax.servlet.http.HttpServletResponse response,
                                                                                                         @RequestParam(value="contextId")
                                                                                                         String contextId,
                                                                                                         @RequestParam(value="url")
                                                                                                         String url)
                                                                                                  throws InvalidContextException,
                                                                                                         StoreException,
                                                                                                         PathNotFoundException,
                                                                                                         ForbiddenPathException,
                                                                                                         ItemProcessingException,
                                                                                                         XmlMergeException,
                                                                                                         XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getItem

@RequestMapping(value="/item",
                method=GET)
public Map<String,Object> getItem(org.springframework.web.context.request.WebRequest request,
                                                                                             javax.servlet.http.HttpServletResponse response,
                                                                                             @RequestParam(value="contextId")
                                                                                             String contextId,
                                                                                             @RequestParam(value="url")
                                                                                             String url)
                                                                                      throws InvalidContextException,
                                                                                             StoreException,
                                                                                             PathNotFoundException,
                                                                                             ForbiddenPathException,
                                                                                             ItemProcessingException,
                                                                                             XmlMergeException,
                                                                                             XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getChildren

@RequestMapping(value="/children",
                method=GET)
public Map<String,Object> getChildren(org.springframework.web.context.request.WebRequest request,
                                                                                                     javax.servlet.http.HttpServletResponse response,
                                                                                                     @RequestParam(value="contextId")
                                                                                                     String contextId,
                                                                                                     @RequestParam(value="url")
                                                                                                     String url)
                                                                                              throws InvalidContextException,
                                                                                                     StoreException,
                                                                                                     PathNotFoundException,
                                                                                                     ForbiddenPathException,
                                                                                                     ItemProcessingException,
                                                                                                     XmlMergeException,
                                                                                                     XmlFileParseException

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException

getTree

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

Throws:

InvalidContextException

StoreException

PathNotFoundException

ForbiddenPathException

ItemProcessingException

XmlMergeException

XmlFileParseException