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

All Known Implementing Classes:

CapabilityContextImpl

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

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

Method Detail

getCapabilitySet

@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
                      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
java.lang.String getCapabilityValue(@NotNull
                                             java.lang.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