org.craftercms.engine.controller.rest

Class SiteContextRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.engine.controller.rest.SiteContextRestController

All Implemented Interfaces:

org.craftercms.commons.rest.ManagementTokenAware

@RestController
 @RequestMapping(value="${crafter.core.rest.base.uri}/site/context")
public class SiteContextRestController
extends org.craftercms.core.controller.rest.RestControllerBase
implements org.craftercms.commons.rest.ManagementTokenAware

REST controller for operations related for the SiteContext

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_ATTR_ID
static String	MODEL_ATTR_STATUS
static String	URL_CONTEXT_ID
static String	URL_DESTROY
static String	URL_GRAPHQL
static String	URL_REBUILD
static String	URL_ROOT
static String	URL_STATUS

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

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor and Description
SiteContextRestController(SiteContextManager contextManager, String configuredToken)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	destroy(String token)
String	getConfiguredToken()
Map<String,String>	getContextId(String token)
Map<String,Object>	getStatus(String token)
Map<String,Object>	rebuild(javax.servlet.http.HttpServletRequest request, String token)
Map<String,Object>	rebuildSchema(javax.servlet.http.HttpServletRequest request, String token)

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

Methods inherited from interface org.craftercms.commons.rest.ManagementTokenAware

validateToken

Field Detail

URL_ROOT

public static final String URL_ROOT

See Also:

Constant Field Values

URL_CONTEXT_ID

public static final String URL_CONTEXT_ID

See Also:

Constant Field Values

URL_DESTROY

public static final String URL_DESTROY

See Also:

Constant Field Values

URL_REBUILD

public static final String URL_REBUILD

See Also:

Constant Field Values

URL_GRAPHQL

public static final String URL_GRAPHQL

See Also:

Constant Field Values

URL_STATUS

public static final String URL_STATUS

See Also:

Constant Field Values

MODEL_ATTR_ID

public static final String MODEL_ATTR_ID

See Also:

Constant Field Values

MODEL_ATTR_STATUS

public static final String MODEL_ATTR_STATUS

See Also:

Constant Field Values

Constructor Detail

SiteContextRestController

@ConstructorProperties(value={"contextManager","configuredToken"})
public SiteContextRestController(SiteContextManager contextManager,
                                                                                                    String configuredToken)

Method Detail

getContextId

@GetMapping(value="/id")
public Map<String,String> getContextId(@RequestParam
                                                                String token)
                                                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

destroy

@GetMapping(value="/destroy")
public Map<String,Object> destroy(@RequestParam
                                                                String token)
                                                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

rebuild

@GetMapping(value="/rebuild")
public Map<String,Object> rebuild(javax.servlet.http.HttpServletRequest request,
                                                                @RequestParam
                                                                String token)
                                                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

rebuildSchema

@GetMapping(value="/graphql/rebuild")
public Map<String,Object> rebuildSchema(javax.servlet.http.HttpServletRequest request,
                                                                              @RequestParam
                                                                              String token)
                                                                       throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

getStatus

@GetMapping(value="/status")
public Map<String,Object> getStatus(@RequestParam
                                                                 String token)
                                                          throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

getConfiguredToken

public String getConfiguredToken()

Specified by:

getConfiguredToken in interface org.craftercms.commons.rest.ManagementTokenAware