Package com.atlassian.bamboo.agent.ephemeral

Interface EphemeralAgentsService

All Known Implementing Classes:

EphemeralAgentsServiceImpl

@PublicApi
public interface EphemeralAgentsService

Service interface for managing ephemeral agents configuration and templates.

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EphemeralAgentsService.DuplicateTemplateNameException	Exception thrown when a duplicate template name is encountered.
static interface	EphemeralAgentsService.TemplateValidationAwareConsumer	Functional interface for consuming an EphemeralAgentTemplate with validation.

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateCapability(@NotNull EphemeralAgentTemplate template, @NotNull Capability capability)	Adds or updates a capability for the given ephemeral agent template.
@NotNull EphemeralAgentTemplate	copyEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Copies specified Ephemeral Agent Template and saves it within the persistence layer.
void	createEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Creates specified Ephemeral Agent Template within the persistence layer.
void	deleteEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Deletes specified Ephemeral Agent Template from the persistence layer.
@NotNull EphemeralAgentsConfiguration	getEphemeralAgentsBaseConfiguration()
@NotNull Optional<EphemeralAgentTemplate>	getEphemeralAgentTemplate(long id)	Gets the Ephemeral Agent Template for the requested ID if the one exist.
@NotNull List<EphemeralAgentTemplate>	getEphemeralAgentTemplates()	Gets all available Ephemeral Agent Templates.
@NotNull List<EphemeralAgentTemplate>	getEphemeralAgentTemplates(@Nullable String filter, int start, int limit)	Gets list of Ephemeral Agent Templates filtered.
boolean	isEphemeralAgentsEnabled()
void	removeCapability(@NotNull EphemeralAgentTemplate template, @NotNull String capabilityKey)	Removes a capability from the given ephemeral agent template.
void	saveEphemeralAgentsBaseConfiguration(@NotNull EphemeralAgentsConfiguration ephemeralAgentsConfiguration)	Persist ephemeral agents configuration.
TestConnectionResult	testConnection(EphemeralAgentsConfiguration configuration)	Validate ephemeral agents configuration and perform attempt to connect provider with provided settings.
void	updateEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Updates specified Ephemeral Agent Template within the persistence layer.

Method Details

getEphemeralAgentsBaseConfiguration

@NotNull
@NotNull EphemeralAgentsConfiguration getEphemeralAgentsBaseConfiguration()

Returns:

ephemeral agents configuration

saveEphemeralAgentsBaseConfiguration

void saveEphemeralAgentsBaseConfiguration(@NotNull
 @NotNull EphemeralAgentsConfiguration ephemeralAgentsConfiguration)
                                   throws WebValidationException

Persist ephemeral agents configuration.

Throws:

WebValidationException - when settings are not valid

testConnection

TestConnectionResult testConnection(EphemeralAgentsConfiguration configuration)

Validate ephemeral agents configuration and perform attempt to connect provider with provided settings.

Returns:

result of connection attempt

getEphemeralAgentTemplates

@NotNull
@NotNull List<EphemeralAgentTemplate> getEphemeralAgentTemplates()

Gets all available Ephemeral Agent Templates.

Returns:

list of the configurations

getEphemeralAgentTemplates

@NotNull
@NotNull List<EphemeralAgentTemplate> getEphemeralAgentTemplates(@Nullable
 @Nullable String filter,
 int start,
 int limit)

Gets list of Ephemeral Agent Templates filtered. It supports pagination.

Returns:

list of templates

getEphemeralAgentTemplate

@NotNull
@NotNull Optional<EphemeralAgentTemplate> getEphemeralAgentTemplate(long id)

Gets the Ephemeral Agent Template for the requested ID if the one exist.

Parameters:

id - entity identifier

Returns:

value if the one exists, empty otherwise

createEphemeralAgentTemplate

void createEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)
                           throws TemplateValidationException,
EphemeralAgentsService.DuplicateTemplateNameException

Creates specified Ephemeral Agent Template within the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to save

Throws:

TemplateValidationException

EphemeralAgentsService.DuplicateTemplateNameException

updateEphemeralAgentTemplate

void updateEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)
                           throws TemplateValidationException,
EphemeralAgentsService.DuplicateTemplateNameException

Updates specified Ephemeral Agent Template within the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to update

Throws:

TemplateValidationException

EphemeralAgentsService.DuplicateTemplateNameException

deleteEphemeralAgentTemplate

void deleteEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Deletes specified Ephemeral Agent Template from the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to delete

copyEphemeralAgentTemplate

@NotNull
@NotNull EphemeralAgentTemplate copyEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Copies specified Ephemeral Agent Template and saves it within the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to copy

Returns:

copy of the entity

Since:

9.4.0

isEphemeralAgentsEnabled

boolean isEphemeralAgentsEnabled()

Returns:

true if ephemeral agents functionality is enabled

addOrUpdateCapability

void addOrUpdateCapability(@NotNull
 @NotNull EphemeralAgentTemplate template,
 @NotNull
 @NotNull Capability capability)
                    throws WebValidationException

Adds or updates a capability for the given ephemeral agent template.

Parameters:

template - the ephemeral agent template

capability - the capability to add or update

Throws:

WebValidationException - if the capability is not valid

removeCapability

void removeCapability(@NotNull
 @NotNull EphemeralAgentTemplate template,
 @NotNull
 @NotNull String capabilityKey)

Removes a capability from the given ephemeral agent template.

Parameters:

template - the ephemeral agent template

capabilityKey - the key of the capability to remove