com.atlassian.bamboo.buildqueue.manager

Interface AgentCapabilityService

All Known Implementing Classes:

AgentCapabilityServiceImpl

@Internal
public interface AgentCapabilityService

Method Summary

Modifier and Type	Method and Description
ErrorCollection	addCapability(PipelineDefinition agent, String key, String value) Add new capability for agent.
ReadOnlyCapabilitySet	getAgentCapabilities(PipelineDefinition agent, boolean includeShared)
void	removeCapabilities(PipelineDefinition agent) Remove all capabilities for agent.
void	removeCapability(PipelineDefinition agent, String capabilityKey) Remove agent's capability.
ErrorCollection	updateCapability(PipelineDefinition agent, String key, String value, CapabilitySource capabilitySource) Update value of existing capability.

Method Detail

removeCapability

void removeCapability(@NotNull
                      PipelineDefinition agent,
                      @NotNull
                      String capabilityKey)

Remove agent's capability.

removeCapabilities

void removeCapabilities(@NotNull
                        PipelineDefinition agent)

Remove all capabilities for agent.

Parameters:

agent -

getAgentCapabilities

@NotNull
ReadOnlyCapabilitySet getAgentCapabilities(@NotNull
                                                    PipelineDefinition agent,
                                                    boolean includeShared)

Parameters:

includeShared - if shared credentials should be returned

Returns:

agent's capability set. Should be not null.

addCapability

ErrorCollection addCapability(@NotNull
                              PipelineDefinition agent,
                              @NotNull
                              String key,
                              @NotNull
                              String value)

Add new capability for agent.

Returns:

error collection. It's empty if capability successfully added.

updateCapability

ErrorCollection updateCapability(@NotNull
                                 PipelineDefinition agent,
                                 @NotNull
                                 String key,
                                 @Nullable
                                 String value,
                                 @NotNull
                                 CapabilitySource capabilitySource)

Update value of existing capability.

Returns:

error collection. It's empty if capability successfully updated.