com.atlassian.bamboo.v2.build.agent.capability

Interface CapabilityContext

All Known Implementing Classes:

CapabilityContextImpl

@PublicApi
public interface CapabilityContext

Allows the ability to retrieve a capability set specific to the context it is called from. Capability set is stored in ThreadLocal.

Method Summary

Modifier and Type	Method and Description
void	clearCapabilitySet() Removes whatever is currently stored in thread local
@Nullable ReadOnlyCapabilitySet	getCapabilitySet() Retrieves the capability set currently stored within the context, If empty the shared local (server) capabilities are returned
@Nullable String	getCapabilityValue(@NotNull String key) Convenience method.
void	setCapabilitySet(@Nullable ReadOnlyCapabilitySet capabilitySet) Stores a specific capability set within the ThreadLocal

Method Detail

getCapabilitySet

@Nullable
@Nullable ReadOnlyCapabilitySet getCapabilitySet()

Retrieves the capability set currently stored within the context, If empty the shared local (server) capabilities are returned

Returns:

ReadOnlyCapabilitySet

setCapabilitySet

void setCapabilitySet(@Nullable
                      @Nullable ReadOnlyCapabilitySet capabilitySet)

Stores a specific capability set within the ThreadLocal

Parameters:

capabilitySet -

clearCapabilitySet

void clearCapabilitySet()

Removes whatever is currently stored in thread local

getCapabilityValue

@Nullable
@Nullable String getCapabilityValue(@NotNull
                                              @NotNull String key)

Convenience method. Retrieves value of capability.

Parameters:

key - capability key

Returns:

capability value or null if there are no capabilities set or there's no capability of given key