Package com.chutneytesting.environment.api

Interface EnvironmentApi

All Known Implementing Classes:

EmbeddedEnvironmentApi, HttpEnvironmentApi

public interface EnvironmentApi

Method Summary

Modifier and Type	Method	Description
void	addTarget(String environmentName, TargetDto targetMetadataDto)
default EnvironmentDto	createEnvironment(EnvironmentDto environmentMetadataDto)
EnvironmentDto	createEnvironment(EnvironmentDto environmentMetadataDto, 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 environmentMetadataDto)
void	updateTarget(String environmentName, String targetName, TargetDto targetMetadataDto)

Method Detail

listEnvironments

Set<EnvironmentDto> listEnvironments()

listEnvironmentsNames

Set<String> listEnvironmentsNames()

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

deleteEnvironment

void deleteEnvironment(String environmentName)
                throws EnvironmentNotFoundException,
                       CannotDeleteEnvironmentException

Throws:

EnvironmentNotFoundException

CannotDeleteEnvironmentException

updateEnvironment

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

Throws:

InvalidEnvironmentNameException

EnvironmentNotFoundException

listTargets

Set<TargetDto> listTargets(String environmentName)
                    throws EnvironmentNotFoundException

Throws:

EnvironmentNotFoundException

listTargets

Set<TargetDto> listTargets()
                    throws EnvironmentNotFoundException

Throws:

EnvironmentNotFoundException

listTargetsNames

Set<String> listTargetsNames()
                      throws EnvironmentNotFoundException

Throws:

EnvironmentNotFoundException

getEnvironment

EnvironmentDto getEnvironment(String environmentName)
                       throws EnvironmentNotFoundException

Throws:

EnvironmentNotFoundException

getTarget

TargetDto getTarget(String environmentName,
                    String targetName)
             throws EnvironmentNotFoundException,
                    TargetNotFoundException

Throws:

EnvironmentNotFoundException

TargetNotFoundException

addTarget

void addTarget(String environmentName,
               TargetDto targetMetadataDto)
        throws EnvironmentNotFoundException,
               AlreadyExistingTargetException

Throws:

EnvironmentNotFoundException

AlreadyExistingTargetException

deleteTarget

void deleteTarget(String environmentName,
                  String targetName)
           throws EnvironmentNotFoundException,
                  TargetNotFoundException

Throws:

EnvironmentNotFoundException

TargetNotFoundException

updateTarget

void updateTarget(String environmentName,
                  String targetName,
                  TargetDto targetMetadataDto)
           throws EnvironmentNotFoundException,
                  TargetNotFoundException

Throws:

EnvironmentNotFoundException

TargetNotFoundException