Package fr.enedis.chutney.environment.api.environment

Class HttpEnvironmentApi

java.lang.Object

fr.enedis.chutney.environment.api.environment.HttpEnvironmentApi

All Implemented Interfaces:

EnvironmentApi

@RestController
@RequestMapping("/api/v2/environments")
public class HttpEnvironmentApi
extends Object
implements EnvironmentApi

Method Summary

Modifier and Type	Method	Description
EnvironmentDto	createEnvironment(EnvironmentDto environmentDto)
EnvironmentDto	createEnvironment(EnvironmentDto environmentDto, boolean force)
String	defaultEnvironmentName()
void	deleteEnvironment(String environmentName)
EnvironmentDto	getEnvironment(String environmentName)
EnvironmentDto	importEnvironment(EnvironmentDto environmentDto)
EnvironmentDto	importEnvironment(org.springframework.web.multipart.MultipartFile file)
Set<EnvironmentDto>	listEnvironments()
Set<String>	listEnvironmentsNames()
void	updateEnvironment(String environmentName, EnvironmentDto environmentDto)

Methods inherited from class java.lang.Object

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

Method Details

listEnvironments

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@GetMapping(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\')")
@GetMapping(path="/names",
            produces="application/json")
public Set<String> listEnvironmentsNames()

Specified by:

listEnvironmentsNames in interface EnvironmentApi

defaultEnvironmentName

public String defaultEnvironmentName()

Specified by:

defaultEnvironmentName in interface EnvironmentApi

createEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PostMapping(consumes="application/json")
public EnvironmentDto createEnvironment(@RequestBody
 EnvironmentDto environmentDto)
                                 throws InvalidEnvironmentNameException,
AlreadyExistingEnvironmentException

Specified by:

createEnvironment in interface EnvironmentApi

Throws:

InvalidEnvironmentNameException

AlreadyExistingEnvironmentException

importEnvironment

@PreAuthorize("hasAuthority(\'ENVIRONMENT_ACCESS\')")
@PostMapping(consumes="multipart/form-data")
public EnvironmentDto importEnvironment(@RequestParam("file")
 org.springframework.web.multipart.MultipartFile file)

importEnvironment

public EnvironmentDto importEnvironment(EnvironmentDto environmentDto)

Specified by:

importEnvironment in interface EnvironmentApi

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

getEnvironment

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

Specified by:

getEnvironment in interface EnvironmentApi

Throws:

EnvironmentNotFoundException