Package org.craftercms.engine.controller.rest

Class SiteContextRestController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.engine.controller.rest.SiteContextRestController

@CrafterRestController
@RequestMapping("${crafter.core.rest.base.uri}/site/context")
public class SiteContextRestController
extends org.craftercms.core.controller.rest.RestControllerBase

REST controller for operations related for the SiteContext

Author:

Alfonso Vásquez

Field Summary

Fields

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

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

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor	Description
SiteContextRestController(SiteContextManager contextManager, String configuredToken)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	destroy(String token)
Map<String,String>	getContextId(String token)
Map<String,Object>	getStatus(String token)
Map<String,Object>	rebuild(jakarta.servlet.http.HttpServletRequest request, String token)
Map<String,Object>	rebuildAll(String token)
Map<String,Object>	rebuildSchema(jakarta.servlet.http.HttpServletRequest request, String token)
protected final void	validateToken(String requestToken)

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

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_REBUILD_ALL

public static final String URL_REBUILD_ALL

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 Details

SiteContextRestController

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

Method Details

getContextId

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

destroy

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

rebuildAll

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

rebuild

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

rebuildSchema

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

getStatus

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

validateToken

protected final void validateToken(String requestToken)
                            throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException