Package org.craftercms.deployer.impl.rest

Class TargetController

java.lang.Object

org.craftercms.deployer.impl.rest.TargetController

@Validated
@RestController
@RequestMapping("/api/1/target")
public class TargetController
extends Object

Main controller for target related operations.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URL
static final String	CREATE_TARGET_IF_NOT_EXISTS_URL
static final String	CREATE_TARGET_URL
static final String	DELETE_IF_EXIST_TARGET_URL
static final String	DELETE_TARGET_URL
static final String	DEPLOY_ALL_TARGETS_URL
static final String	DEPLOY_TARGET_URL
protected final DeploymentService	deploymentService
static final String	DUPLICATE_TARGET_URL
static final String	ENGINE_URL_PARAM_NAME
static final String	GET_ALL_DEPLOYMENTS_URL
static final String	GET_ALL_TARGETS_URL
static final String	GET_CURRENT_DEPLOYMENT_URL
static final String	GET_PENDING_DEPLOYMENTS_URL
static final String	GET_TARGET_URL
protected String	managementToken
static final String	NOTIFICATION_ADDRESSESS_PARAM_NAME
static final String	RECREATE_INDEX_URL
static final String	REPO_BRANCH_PARAM_NAME
static final String	REPO_URL_PARAM_NAME
static final String	REPO_USERNAME_PARAM_NAME
static final String	SSH_PRIVATE_KEY_PATH_PARAM_NAME
protected final TargetService	targetService
static final String	UNLOCK_TARGET_URL

Constructor Summary

Constructors

Constructor	Description
TargetController(TargetService targetService, DeploymentService deploymentService)

Method Summary

Modifier and Type	Method	Description
protected org.springframework.http.HttpHeaders	createResponseHeaders(String locationUrlTemplate, Object... variables)
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	createTarget(@Valid CreateTargetRequest params)	Creates a Deployer Target.
protected org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	createTarget(CreateTargetRequest createRequest, boolean createIfNotExists)
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	createTargetIfNotExists(@Valid CreateTargetRequest params)
org.springframework.http.ResponseEntity<Void>	deleteTarget(@NotBlank String env, @NotBlank String siteName)	Deletes the Target with the specified environment and site name.
org.springframework.http.ResponseEntity<Void>	deleteTargetIfExists(@NotBlank String env, @NotBlank String siteName)	Deletes the Target with the specified environment and site name, does nothing if the target is not found.
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	deployAllTargets(Map<String,Object> params)	Deploys all current Targets.
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	deployTarget(@NotBlank String env, @NotBlank String siteName, Map<String,Object> params)	Deploys the Target with the specified environment and site name.
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	duplicateTarget(@NotEmpty String env, String sourceSiteName, @Valid DuplicateTargetRequest duplicateTargetRequest)
org.springframework.http.ResponseEntity<Collection<Deployment>>	getAllDeployments(@NotBlank String env, @NotBlank String siteName)	Gets all deployments for a target (pending and current).
org.springframework.http.ResponseEntity<List<Target>>	getAllTargets()	Returns all current Targets
org.springframework.http.ResponseEntity<Deployment>	getCurrentDeployment(@NotBlank String env, @NotBlank String siteName)	Gets the current deployment for a target.
org.springframework.http.ResponseEntity<Collection<Deployment>>	getPendingDeployments(@NotBlank String env, @NotBlank String siteName)	Gets the pending deployments for a target.
org.springframework.http.ResponseEntity<Target>	getTarget(@NotBlank String env, @NotBlank String siteName)	Returns a Target.
org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result>	recreateIndex(@NotBlank String env, @NotBlank String siteName)	Recreates the underlying OpenSearch index for the Target with the specified environment and site name.
void	unlockTarget(String env, String siteName)
protected void	validateManagementToken()	Requires ManagementToken.HEADER_NAME.
protected void	validateToken(String token)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URL

public static final String BASE_URL

See Also:

• Constant Field Values

CREATE_TARGET_URL

public static final String CREATE_TARGET_URL

See Also:

• Constant Field Values

CREATE_TARGET_IF_NOT_EXISTS_URL

public static final String CREATE_TARGET_IF_NOT_EXISTS_URL

See Also:

• Constant Field Values

DUPLICATE_TARGET_URL

public static final String DUPLICATE_TARGET_URL

See Also:

• Constant Field Values

GET_TARGET_URL

public static final String GET_TARGET_URL

See Also:

• Constant Field Values

GET_ALL_TARGETS_URL

public static final String GET_ALL_TARGETS_URL

See Also:

• Constant Field Values

DELETE_TARGET_URL

public static final String DELETE_TARGET_URL

See Also:

• Constant Field Values

DELETE_IF_EXIST_TARGET_URL

public static final String DELETE_IF_EXIST_TARGET_URL

See Also:

• Constant Field Values

DEPLOY_TARGET_URL

public static final String DEPLOY_TARGET_URL

See Also:

• Constant Field Values

DEPLOY_ALL_TARGETS_URL

public static final String DEPLOY_ALL_TARGETS_URL

See Also:

• Constant Field Values

GET_PENDING_DEPLOYMENTS_URL

public static final String GET_PENDING_DEPLOYMENTS_URL

See Also:

• Constant Field Values

GET_CURRENT_DEPLOYMENT_URL

public static final String GET_CURRENT_DEPLOYMENT_URL

See Also:

• Constant Field Values

GET_ALL_DEPLOYMENTS_URL

public static final String GET_ALL_DEPLOYMENTS_URL

See Also:

• Constant Field Values

UNLOCK_TARGET_URL

public static final String UNLOCK_TARGET_URL

See Also:

• Constant Field Values

RECREATE_INDEX_URL

public static final String RECREATE_INDEX_URL

See Also:

• Constant Field Values

REPO_URL_PARAM_NAME

public static final String REPO_URL_PARAM_NAME

See Also:

• Constant Field Values

REPO_BRANCH_PARAM_NAME

public static final String REPO_BRANCH_PARAM_NAME

See Also:

• Constant Field Values

REPO_USERNAME_PARAM_NAME

public static final String REPO_USERNAME_PARAM_NAME

See Also:

• Constant Field Values

SSH_PRIVATE_KEY_PATH_PARAM_NAME

public static final String SSH_PRIVATE_KEY_PATH_PARAM_NAME

See Also:

• Constant Field Values

ENGINE_URL_PARAM_NAME

public static final String ENGINE_URL_PARAM_NAME

See Also:

• Constant Field Values

NOTIFICATION_ADDRESSESS_PARAM_NAME

public static final String NOTIFICATION_ADDRESSESS_PARAM_NAME

See Also:

• Constant Field Values

targetService

protected final TargetService targetService

deploymentService

protected final DeploymentService deploymentService

managementToken

@Value("${deployer.main.management.authorizationToken}")
protected String managementToken

Constructor Details

TargetController

@Autowired
public TargetController(TargetService targetService,
 DeploymentService deploymentService)

Method Details

createTarget

@RequestMapping(value="/create",
                method=POST)
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> createTarget(@Valid @RequestBody
 @Valid CreateTargetRequest params)
                                                                                         throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Creates a Deployer Target.

Parameters:

params - the body of the request with the template parameters that will be used to create the target. The body must contain at least a env and site_name parameter. Other required parameters depend on the template used.

Returns:

the response entity 201 CREATED status

Throws:

DeployerException - if an error occurred during target creation

org.craftercms.commons.exceptions.InvalidManagementTokenException

createTargetIfNotExists

@RequestMapping(value="/create_if_not_exists",
                method=POST)
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> createTargetIfNotExists(@Valid @RequestBody
 @Valid CreateTargetRequest params)
                                                                                                    throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

DeployerException

org.craftercms.commons.exceptions.InvalidManagementTokenException

getTarget

@RequestMapping(value="/get/{env}/{site_name}",
                method=GET)
public org.springframework.http.ResponseEntity<Target> getTarget(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                          throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Returns a Target.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the response entity with the target's properties and 200 OK status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

getAllTargets

@RequestMapping(value="/get-all",
                method=GET)
public org.springframework.http.ResponseEntity<List<Target>> getAllTargets()
                                                                    throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Returns all current Targets

Returns:

the response entity with all the properties of the targets and 200 OK status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

deleteTarget

@RequestMapping(value="/delete/{env}/{site_name}",
                method=POST)
public org.springframework.http.ResponseEntity<Void> deleteTarget(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                           throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Deletes the Target with the specified environment and site name.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the response entity with a 204 NO CONTENT status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

deleteTargetIfExists

@RequestMapping(value="/delete-if-exists/{env}/{site_name}",
                method=POST)
public org.springframework.http.ResponseEntity<Void> deleteTargetIfExists(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                                   throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Deletes the Target with the specified environment and site name, does nothing if the target is not found.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the response entity with a 204 NO CONTENT status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

deployTarget

@RequestMapping(value="/deploy/{env}/{site_name}",
                method=POST)
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> deployTarget(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName,
 @RequestBody(required=false)
 Map<String,Object> params)
                                                                                         throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Deploys the Target with the specified environment and site name.

Parameters:

env - the target's environment

siteName - the target's site name

params - any additional parameters that can be used by the DeploymentProcessors, for example reprocess_all_files

Returns:

the response entity with a 200 OK status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

deployAllTargets

@RequestMapping(value="/deploy-all",
                method=POST)
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> deployAllTargets(@RequestBody(required=false)
 Map<String,Object> params)
                                                                                             throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Deploys all current Targets.

Parameters:

params - any additional parameters that can be used by the DeploymentProcessors, for example reprocess_all_files

Returns:

the response entity with a 200 OK status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

getPendingDeployments

@RequestMapping(value="/deployments/get-pending/{env}/{site_name}",
                method=GET)
public org.springframework.http.ResponseEntity<Collection<Deployment>> getPendingDeployments(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                                                      throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Gets the pending deployments for a target.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the pending deployments for the target

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

getCurrentDeployment

@RequestMapping(value="/deployments/get-current/{env}/{site_name}",
                method=GET)
public org.springframework.http.ResponseEntity<Deployment> getCurrentDeployment(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                                         throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Gets the current deployment for a target.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the pending and current deployments for the target

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

getAllDeployments

@RequestMapping(value="/deployments/get-all/{env}/{site_name}",
                method=GET)
public org.springframework.http.ResponseEntity<Collection<Deployment>> getAllDeployments(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                                                  throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Gets all deployments for a target (pending and current).

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the pending and current deployments for the target

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

recreateIndex

@RequestMapping(value="/recreate/{env}/{site_name}",
                method=POST)
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> recreateIndex(@NotBlank @PathVariable("env")
 @NotBlank String env,
 @NotBlank @PathVariable("site_name")
 @NotBlank String siteName)
                                                                                          throws DeployerException,
org.craftercms.commons.exceptions.InvalidManagementTokenException,
org.craftercms.commons.config.ConfigurationException

Recreates the underlying OpenSearch index for the Target with the specified environment and site name.

Parameters:

env - the target's environment

siteName - the target's site name

Returns:

the response entity with a 200 OK status

Throws:

DeployerException - if an error occurred

org.craftercms.commons.exceptions.InvalidManagementTokenException

org.craftercms.commons.config.ConfigurationException

createTarget

protected org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> createTarget(CreateTargetRequest createRequest,
 boolean createIfNotExists)
                                                                                            throws DeployerException

Throws:

DeployerException

createResponseHeaders

protected org.springframework.http.HttpHeaders createResponseHeaders(String locationUrlTemplate,
 Object... variables)

unlockTarget

@ResponseStatus(OK)
@PostMapping("/unlock/{env}/{site_name}")
public void unlockTarget(@PathVariable("env")
 String env,
 @PathVariable("site_name")
 String siteName)
                  throws TargetNotFoundException,
TargetServiceException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

TargetNotFoundException

TargetServiceException

org.craftercms.commons.exceptions.InvalidManagementTokenException

duplicateTarget

@ResponseStatus(CREATED)
@PostMapping("/duplicate/{env}/{site_name}")
public org.springframework.http.ResponseEntity<org.craftercms.commons.rest.Result> duplicateTarget(@NotEmpty @PathVariable("env")
 @NotEmpty String env,
 @PathVariable("site_name")
 String sourceSiteName,
 @Valid @RequestBody
 @Valid DuplicateTargetRequest duplicateTargetRequest)
                                                                                            throws TargetServiceException,
TargetAlreadyExistsException,
TargetNotFoundException,
org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

TargetServiceException

TargetAlreadyExistsException

TargetNotFoundException

org.craftercms.commons.exceptions.InvalidManagementTokenException

validateManagementToken

protected void validateManagementToken()
                                throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Requires ManagementToken.HEADER_NAME. A token query parameter is ignored.

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

validateToken

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

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException