Package com.atlassian.bamboo.agent.ephemeral

Class EphemeralAgentsServiceImpl

java.lang.Object

com.atlassian.bamboo.agent.ephemeral.EphemeralAgentsServiceImpl

All Implemented Interfaces:

EphemeralAgentsService

public class EphemeralAgentsServiceImpl
extends Object
implements EphemeralAgentsService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.agent.ephemeral.EphemeralAgentsService

EphemeralAgentsService.DuplicateTemplateNameException, EphemeralAgentsService.TemplateValidationAwareConsumer

Constructor Summary

Constructors

Constructor	Description
EphemeralAgentsServiceImpl()

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.

Methods inherited from class java.lang.Object

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

Constructor Details

EphemeralAgentsServiceImpl

public EphemeralAgentsServiceImpl()

Method Details

getEphemeralAgentsBaseConfiguration

@NotNull
public @NotNull EphemeralAgentsConfiguration getEphemeralAgentsBaseConfiguration()

Specified by:

getEphemeralAgentsBaseConfiguration in interface EphemeralAgentsService

Returns:

ephemeral agents configuration

saveEphemeralAgentsBaseConfiguration

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

Description copied from interface: EphemeralAgentsService

Persist ephemeral agents configuration.

Specified by:

saveEphemeralAgentsBaseConfiguration in interface EphemeralAgentsService

Throws:

WebValidationException - when settings are not valid

isEphemeralAgentsEnabled

public boolean isEphemeralAgentsEnabled()

Specified by:

isEphemeralAgentsEnabled in interface EphemeralAgentsService

Returns:

true if ephemeral agents functionality is enabled

testConnection

public TestConnectionResult testConnection(EphemeralAgentsConfiguration configuration)

Description copied from interface: EphemeralAgentsService

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

Specified by:

testConnection in interface EphemeralAgentsService

Returns:

result of connection attempt

getEphemeralAgentTemplates

@NotNull
public @NotNull List<EphemeralAgentTemplate> getEphemeralAgentTemplates()

Description copied from interface: EphemeralAgentsService

Gets all available Ephemeral Agent Templates.

Specified by:

getEphemeralAgentTemplates in interface EphemeralAgentsService

Returns:

list of the configurations

getEphemeralAgentTemplates

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

Description copied from interface: EphemeralAgentsService

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

Specified by:

getEphemeralAgentTemplates in interface EphemeralAgentsService

Returns:

list of templates

getEphemeralAgentTemplate

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

Description copied from interface: EphemeralAgentsService

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

Specified by:

getEphemeralAgentTemplate in interface EphemeralAgentsService

Parameters:

id - entity identifier

Returns:

value if the one exists, empty otherwise

createEphemeralAgentTemplate

public void createEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)
                                  throws TemplateValidationException

Description copied from interface: EphemeralAgentsService

Creates specified Ephemeral Agent Template within the persistence layer.

Specified by:

createEphemeralAgentTemplate in interface EphemeralAgentsService

Parameters:

ephemeralAgentTemplate - entity to save

Throws:

TemplateValidationException

updateEphemeralAgentTemplate

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

Description copied from interface: EphemeralAgentsService

Updates specified Ephemeral Agent Template within the persistence layer.

Specified by:

updateEphemeralAgentTemplate in interface EphemeralAgentsService

Parameters:

ephemeralAgentTemplate - entity to update

Throws:

TemplateValidationException

EphemeralAgentsService.DuplicateTemplateNameException

deleteEphemeralAgentTemplate

public void deleteEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Description copied from interface: EphemeralAgentsService

Deletes specified Ephemeral Agent Template from the persistence layer.

Specified by:

deleteEphemeralAgentTemplate in interface EphemeralAgentsService

Parameters:

ephemeralAgentTemplate - entity to delete

copyEphemeralAgentTemplate

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

Description copied from interface: EphemeralAgentsService

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

Specified by:

copyEphemeralAgentTemplate in interface EphemeralAgentsService

Parameters:

ephemeralAgentTemplate - entity to copy

Returns:

copy of the entity

addOrUpdateCapability

public void addOrUpdateCapability(@NotNull
 @NotNull EphemeralAgentTemplate template,
 @NotNull
 @NotNull Capability capability)

Description copied from interface: EphemeralAgentsService

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

Specified by:

addOrUpdateCapability in interface EphemeralAgentsService

Parameters:

template - the ephemeral agent template

capability - the capability to add or update

removeCapability

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

Description copied from interface: EphemeralAgentsService

Removes a capability from the given ephemeral agent template.

Specified by:

removeCapability in interface EphemeralAgentsService

Parameters:

template - the ephemeral agent template

capabilityKey - the key of the capability to remove