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

Interface EnvironmentApi

All Known Implementing Classes:

EmbeddedEnvironmentApi, EnvironmentController

public interface EnvironmentApi

Method Summary

Modifier and Type	Method	Description
default EnvironmentDto	createEnvironment(EnvironmentDto environmentMetadataDto)
EnvironmentDto	createEnvironment(EnvironmentDto environmentMetadataDto, boolean force)
String	defaultEnvironmentName()
void	deleteEnvironment(String environmentName)
EnvironmentDto	getEnvironment(String environmentName)
EnvironmentDto	importEnvironment(EnvironmentDto environmentDto)
Set<EnvironmentDto>	listEnvironments()
Set<String>	listEnvironmentsNames()
void	updateEnvironment(String environmentName, EnvironmentDto environmentMetadataDto)

Method Details

listEnvironments

Set<EnvironmentDto> listEnvironments()

listEnvironmentsNames

Set<String> listEnvironmentsNames()

defaultEnvironmentName

String defaultEnvironmentName()

getEnvironment

EnvironmentDto getEnvironment(String environmentName)
                       throws EnvironmentNotFoundException

Throws:

EnvironmentNotFoundException

createEnvironment

default EnvironmentDto createEnvironment(EnvironmentDto environmentMetadataDto)
                                  throws InvalidEnvironmentNameException,
AlreadyExistingEnvironmentException

Throws:

InvalidEnvironmentNameException

AlreadyExistingEnvironmentException

createEnvironment

EnvironmentDto createEnvironment(EnvironmentDto environmentMetadataDto,
 boolean force)
                          throws InvalidEnvironmentNameException,
AlreadyExistingEnvironmentException

Throws:

InvalidEnvironmentNameException

AlreadyExistingEnvironmentException

importEnvironment

EnvironmentDto importEnvironment(EnvironmentDto environmentDto)

updateEnvironment

void updateEnvironment(String environmentName,
 EnvironmentDto environmentMetadataDto)
                throws InvalidEnvironmentNameException,
EnvironmentNotFoundException

Throws:

InvalidEnvironmentNameException

EnvironmentNotFoundException

deleteEnvironment

void deleteEnvironment(String environmentName)
                throws EnvironmentNotFoundException,
CannotDeleteEnvironmentException

Throws:

EnvironmentNotFoundException

CannotDeleteEnvironmentException