Package com.chutneytesting.environment.api

Class HttpEnvironmentApi

java.lang.Object

com.chutneytesting.environment.api.HttpEnvironmentApi

All Implemented Interfaces:

EnvironmentApi

@RestController
@CrossOrigin(origins="*")
@RequestMapping("/api/v2/environment")
public class HttpEnvironmentApi
extends Object
implements EnvironmentApi

Method Summary

Modifier and Type	Method	Description
void	addTarget(String environmentName, TargetDto targetDto)
EnvironmentDto	createEnvironment(EnvironmentDto environmentDto)
EnvironmentDto	createEnvironment(EnvironmentDto environmentDto, boolean force)
void	deleteEnvironment(String environmentName)
void	deleteTarget(String environmentName, String targetName)
EnvironmentDto	getEnvironment(String environmentName)
TargetDto	getTarget(String environmentName, String targetName)
Set<EnvironmentDto>	listEnvironments()
Set<String>	listEnvironmentsNames()
Set<TargetDto>	listTargets()
Set<TargetDto>	listTargets(String environmentName)
Set<String>	listTargetsNames()
void	updateEnvironment(String environmentName, EnvironmentDto environmentDto)
void	updateTarget(String environmentName, String targetName, TargetDto targetDto)

Methods inherited from class java.lang.Object

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

Method Detail

listEnvironments

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping(path="",
            produces="application/json")
public Set<EnvironmentDto> listEnvironments()

Specified by:

listEnvironments in interface EnvironmentApi

listEnvironmentsNames

@PreAuthorize("hasAuthority(\'SCENARIO_EXECUTE\') or hasAuthority(\'CAMPAIGN_WRITE\') or hasAuthority(\'CAMPAIGN_EXECUTE\') or hasAuthority(\'COMPONENT_WRITE\')")
@GetMapping(path="/names",
            produces="application/json")
public Set<String> listEnvironmentsNames()

Specified by:

listEnvironmentsNames in interface EnvironmentApi

createEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PostMapping("")
public EnvironmentDto createEnvironment(@RequestBody
                                        EnvironmentDto environmentDto)
                                 throws InvalidEnvironmentNameException,
                                        AlreadyExistingEnvironmentException

Specified by:

createEnvironment in interface EnvironmentApi

Throws:

InvalidEnvironmentNameException

AlreadyExistingEnvironmentException

createEnvironment

public EnvironmentDto createEnvironment(@RequestBody
                                        EnvironmentDto environmentDto,
                                        boolean force)

Specified by:

createEnvironment in interface EnvironmentApi

deleteEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@DeleteMapping("/{environmentName}")
public void deleteEnvironment(@PathVariable("environmentName")
                              String environmentName)
                       throws EnvironmentNotFoundException,
                              CannotDeleteEnvironmentException

Specified by:

deleteEnvironment in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

CannotDeleteEnvironmentException

updateEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PutMapping("/{environmentName}")
public void updateEnvironment(@PathVariable("environmentName")
                              String environmentName,
                              @RequestBody
                              EnvironmentDto environmentDto)
                       throws InvalidEnvironmentNameException,
                              EnvironmentNotFoundException

Specified by:

updateEnvironment in interface EnvironmentApi

Throws:

InvalidEnvironmentNameException

EnvironmentNotFoundException

listTargets

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping(path="/{environmentName}/target",
            produces="application/json")
public Set<TargetDto> listTargets(@PathVariable("environmentName")
                                  String environmentName)
                           throws EnvironmentNotFoundException

Specified by:

listTargets in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

listTargets

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping(path="/target",
            produces="application/json")
public Set<TargetDto> listTargets()
                           throws EnvironmentNotFoundException

Specified by:

listTargets in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

listTargetsNames

@PreAuthorize("hasAuthority(\'COMPONENT_READ\')")
@GetMapping(path="/target/names",
            produces="application/json")
public Set<String> listTargetsNames()
                             throws EnvironmentNotFoundException

Specified by:

listTargetsNames in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

getEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping("/{environmentName}")
public EnvironmentDto getEnvironment(@PathVariable("environmentName")
                                     String environmentName)
                              throws EnvironmentNotFoundException

Specified by:

getEnvironment in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

getTarget

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping("/{environmentName}/target/{targetName}")
public TargetDto getTarget(@PathVariable("environmentName")
                           String environmentName,
                           @PathVariable("targetName")
                           String targetName)
                    throws EnvironmentNotFoundException,
                           TargetNotFoundException

Specified by:

getTarget in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

TargetNotFoundException

addTarget

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PostMapping("/{environmentName}/target")
public void addTarget(@PathVariable("environmentName")
                      String environmentName,
                      @RequestBody
                      TargetDto targetDto)
               throws EnvironmentNotFoundException,
                      AlreadyExistingTargetException

Specified by:

addTarget in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

AlreadyExistingTargetException

deleteTarget

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@DeleteMapping("/{environmentName}/target/{targetName}")
public void deleteTarget(@PathVariable("environmentName")
                         String environmentName,
                         @PathVariable("targetName")
                         String targetName)
                  throws EnvironmentNotFoundException,
                         TargetNotFoundException

Specified by:

deleteTarget in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

TargetNotFoundException

updateTarget

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PutMapping("/{environmentName}/target/{targetName}")
public void updateTarget(@PathVariable("environmentName")
                         String environmentName,
                         @PathVariable("targetName")
                         String targetName,
                         @RequestBody
                         TargetDto targetDto)
                  throws EnvironmentNotFoundException,
                         TargetNotFoundException

Specified by:

updateTarget in interface EnvironmentApi

Throws:

EnvironmentNotFoundException

TargetNotFoundException