Uses of Interface
com.atlassian.bamboo.Key

Packages that use Key

Package	Description
com.atlassian.bamboo
com.atlassian.bamboo.build
com.atlassian.bamboo.build.fileserver
com.atlassian.bamboo.build.logger
com.atlassian.bamboo.core
com.atlassian.bamboo.deployments
com.atlassian.bamboo.deployments.execution
com.atlassian.bamboo.key
com.atlassian.bamboo.logger
com.atlassian.bamboo.migration
com.atlassian.bamboo.persister
com.atlassian.bamboo.persister.file
com.atlassian.bamboo.persister.xstream
com.atlassian.bamboo.plan
com.atlassian.bamboo.rest.model
com.atlassian.bamboo.rest.model.deployments
com.atlassian.bamboo.security
com.atlassian.bamboo.storage
com.atlassian.bamboo.storage.location
com.atlassian.bamboo.testutils.build.logger
com.atlassian.bamboo.v2.build
com.atlassian.bamboo.v2.build.agent.messages
com.atlassian.bamboo.v2.build.agent.remote
com.atlassian.bamboo.v2.build.agent.remote.workspaces
com.atlassian.bamboo.v2.build.queue
com.atlassian.bamboo.vcs.configuration.legacy

Uses of Key in com.atlassian.bamboo

Subinterfaces of Key in com.atlassian.bamboo

Modifier and Type	Interface and Description
interface	ResultKey Common interface to identify a result of running something identified by a Key

Methods in com.atlassian.bamboo that return Key

Modifier and Type	Method and Description
@NotNull Key	ResultKey.getEntityKey() What is this a result of.
static Key	KeyType.getKeyFromString(String key) Get the typed key from its string representation
Key	KeyType.toKey(String key) Attempt to create the correct key for this KeyType with the provided key

Uses of Key in com.atlassian.bamboo.build

Methods in com.atlassian.bamboo.build with type parameters of type Key

Modifier and Type	Method and Description
<T extends Key> @NotNull BuildLoggerWithoutLogAccess	BuildLoggerManager.getLoggerWithoutLogAccess(@NotNull LoggerId<T> loggerId) Returns a BuildLoggerWithoutLogAccess for the given LoggerId

Methods in com.atlassian.bamboo.build with parameters of type Key

Modifier and Type	Method and Description
@NotNull List<CurrentlyBuilding>	DefaultBuildExecutionManager.getCurrentlyBuilding(@NotNull Key key)
@NotNull List<CurrentlyBuilding>	BuildExecutionManager.getCurrentlyBuilding(@NotNull Key key)
List<CurrentlyBuilding>	CurrentlyBuildingContainer.getCurrentlyBuildingByKey(Key key) Immutable list of currently building by plan.
@NotNull BuildLogger	BuildLoggerManager.getLogger(@NotNull Key key) Returns a BuildLogger for the given plan
@NotNull BuildLoggerWithoutLogAccess	BuildLoggerManager.getLoggerWithoutLogAccess(@NotNull Key resultKey) Returns a BuildLoggerWithoutLogAccess for the given result
int	CurrentlyBuildingContainer.numberOfCurrentlyBuildingForKey(Key key)

Uses of Key in com.atlassian.bamboo.build.fileserver

Methods in com.atlassian.bamboo.build.fileserver with parameters of type Key

Modifier and Type	Method and Description
@NotNull File	DefaultBuildDirectoryManager.getBuildWorkingDirectory(@NotNull Key key)
@NotNull File	BuildDirectoryManager.getBuildWorkingDirectory(@NotNull Key key) Returns the working directory for the plan.

Uses of Key in com.atlassian.bamboo.build.logger

Classes in com.atlassian.bamboo.build.logger with type parameters of type Key

Modifier and Type	Class and Description
class	LoggerId<T extends Key>

Fields in com.atlassian.bamboo.build.logger declared as Key

Modifier and Type	Field and Description
protected T	LoggerId.key

Methods in com.atlassian.bamboo.build.logger that return types with arguments of type Key

Modifier and Type	Method and Description
static LoggerId<? extends Key>	LoggerIds.get(Key key)

Methods in com.atlassian.bamboo.build.logger with parameters of type Key

Modifier and Type	Method and Description
BuildLogFileAccessor	BuildLogFileAccessorFactoryImpl.createBuildLogFileAccessor(Key key, int buildNumber)
BuildLogFileAccessor	BuildLogFileAccessorFactory.createBuildLogFileAccessor(Key planKey, int buildNumber)
static LoggerId<? extends Key>	LoggerIds.get(Key key)
@NotNull BuildLogger	DefaultBuildLoggerManager.getLogger(@NotNull Key key)
@NotNull BuildLoggerWithoutLogAccess	DefaultBuildLoggerManager.getLoggerWithoutLogAccess(@NotNull Key key)

Method parameters in com.atlassian.bamboo.build.logger with type arguments of type Key

Modifier and Type	Method and Description
void	BuildLoggerImpl.switchPersistence(LoggerId<? extends Key> loggerId, boolean persistent)

Constructor parameters in com.atlassian.bamboo.build.logger with type arguments of type Key

Constructor and Description
BuildLoggerImpl(LoggerId<? extends Key> loggerId, @NotNull ExpiryTicker expiryTicker)

Uses of Key in com.atlassian.bamboo.core

Methods in com.atlassian.bamboo.core with parameters of type Key

Modifier and Type	Method and Description
static <V,E extends Throwable> V	ScopedExclusionServiceHelper.withLockedKeyIdentifiedEntity(ScopedExclusionService exclusionService, Key key, ScopedExclusionService.ExclusiveFunction<Key,V,E> functor)

Method parameters in com.atlassian.bamboo.core with type arguments of type Key

Modifier and Type	Method and Description
static <V,E extends Throwable> V	ScopedExclusionServiceHelper.withLockedKeyIdentifiedEntity(ScopedExclusionService exclusionService, Key key, ScopedExclusionService.ExclusiveFunction<Key,V,E> functor)

Uses of Key in com.atlassian.bamboo.deployments

Subinterfaces of Key in com.atlassian.bamboo.deployments

Modifier and Type	Interface and Description
interface	DeploymentKey
interface	DeploymentResultKey

Classes in com.atlassian.bamboo.deployments that implement Key

Modifier and Type	Class and Description
class	DeploymentKeyImpl
class	DeploymentResultKeyImpl

Methods in com.atlassian.bamboo.deployments that return Key

Modifier and Type	Method and Description
@NotNull Key	DeploymentResultKeyImpl.getEntityKey()

Methods in com.atlassian.bamboo.deployments with parameters of type Key

Modifier and Type	Method and Description
int	DeploymentKeyImpl.compareTo(Key key)

Uses of Key in com.atlassian.bamboo.deployments.execution

Methods in com.atlassian.bamboo.deployments.execution that return Key

Modifier and Type	Method and Description
@NotNull Key	DeploymentContextImpl.getEntityKey()

Uses of Key in com.atlassian.bamboo.key

Classes in com.atlassian.bamboo.key with type parameters of type Key

Modifier and Type	Class and Description
class	KeyUserType<K extends Key>

Uses of Key in com.atlassian.bamboo.logger

Methods in com.atlassian.bamboo.logger that return Key

Modifier and Type	Method and Description
@Nullable Key	DecoratedErrorDetailsImpl.getEntityKey()
@Nullable Key	ErrorDetailsImpl.getEntityKey()
@Nullable Key	ErrorDetails.getEntityKey() Get entity key associated with this error

Methods in com.atlassian.bamboo.logger with parameters of type Key

Modifier and Type	Method and Description
@NotNull Collection<ErrorDetails>	AggregatedChainErrorAccessor.getErrors(@NotNull Key key)
@NotNull Collection<ErrorDetails>	DefaultErrorHandler.getErrors(@NotNull Key planKey)
@NotNull Collection<ErrorDetails>	DecoratingErrorAccessorImpl.getErrors(@NotNull Key entityKey)
@NotNull Collection<ErrorDetails>	ErrorAccessor.getErrors(@NotNull Key entityKey) Obtain all the errors recorded against a specific plan
void	ErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context) Record a build error against a plan/deployment
void	AbstractErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context)
void	ErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable) Record a build error against a plan/deployment
void	AbstractErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable)
void	ErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable, @Nullable Map<String,String> metadata) Record a build error against a plan/deployment
void	AbstractErrorUpdateHandler.recordError(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable, @Nullable Map<String,String> metadata)

Uses of Key in com.atlassian.bamboo.migration

Methods in com.atlassian.bamboo.migration with parameters of type Key

Modifier and Type	Method and Description
@NotNull SMOutputElementAppender	SMOutputElementAppender.append(@NotNull String elementName, @Nullable Key key)

Uses of Key in com.atlassian.bamboo.persister

Classes in com.atlassian.bamboo.persister with type parameters of type Key

Modifier and Type	Interface and Description
interface	XStreamObjectPersister<K extends Key,V>

Methods in com.atlassian.bamboo.persister with parameters of type Key

Modifier and Type	Method and Description
@Nullable BuildResults	Persister.getBuildResults(Key planKey, int buildNumber) Get the Nth build for a given build.
@Nullable BuildResults	CachedBuildPersisterDecorator.loadBuildResults(Key planKey, int buildNumber) Cache the build results so that the least used results get purged
void	DefaultAuditLogService.log(@NotNull Collection<AuditLogService.FieldChange> changes, @Nullable Key key)
void	AuditLogService.log(@NotNull Collection<AuditLogService.FieldChange> changes, @Nullable Key key) Add 'field change' messages to the system audit log.
default void	AuditLogService.log(@NotNull String msg, @Nullable Key plan) Deprecated. since 6.7
default void	AuditLogService.log(@NotNull String s, @Nullable Key planKey, @Nullable AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType)
void	AuditLogService.log(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType) Add a message to the plans audit log.
void	DefaultAuditLogService.log(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType, @Nullable AuditLogEntity entity)
void	AuditLogService.log(@NotNull String s, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity entity) Add a message to the entity's audit log.
void	DefaultAuditLogService.log(@Nullable String username, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType)
void	DefaultAuditLogService.log(@Nullable String username, @NotNull String msg, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity field)
void	DefaultAuditLogService.log(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key plan)
void	AuditLogService.log(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key plan) Add 'field change' message to the system audit log.
default void	AuditLogService.log(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key planKey, @Nullable AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity entity)
void	AuditLogService.log(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key key, AuditLogEntityType entityType, @Nullable AuditLogEntity entity) Add 'field change' message to the system audit log.
default void	AuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key plan) Deprecated. since 6.7
default void	AuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key planKey, @Nullable AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType)
void	AuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, @Nullable AuditLogEntityType entityType) Add a message to the entity's audit log.
void	DefaultAuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType, @Nullable AuditLogEntity entity)
void	AuditLogService.log(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity entity) Add a message to the plans audit log.
static void	TaskAuditLogHelper.logTaskConfigurationChanges(AuditLogService auditLogService, TaskManager taskManager, AuditLogEntityType entityType, Key key, TaskDefinition taskDefinition, Map<String,String> oldConfiguration, String oldDescription, boolean oldIsEnabled)
static void	TriggerAuditLogHelper.logTriggerChanges(AuditLogService auditLogService, Key key, TriggerDefinition oldTriggerDefinition, TriggerDefinition newTriggerDefinition, AuditLogEntityType entityType)
static void	TriggerAuditLogHelper.logTriggerCreation(AuditLogService auditLogService, Key key, TriggerDefinition triggerDefinition, AuditLogEntityType entityType)
static void	TriggerAuditLogHelper.logTriggerRemoval(AuditLogService auditLogService, Key key, TriggerDefinition triggerDefinition, AuditLogEntityType entityType)

Uses of Key in com.atlassian.bamboo.persister.file

Methods in com.atlassian.bamboo.persister.file with parameters of type Key

Modifier and Type	Method and Description
@Nullable BuildResults	FileBasedPersister.getBuildResults(Key planKey, int buildNumber)
@Nullable BuildResults	BuildPersisterDecorator.loadBuildResults(Key planKey, int buildNumber) Load the given build's buildNumber'th build results
@Nullable BuildResults	XStreamBuildPersister.loadBuildResults(Key planKey, int buildNumber) Load the build buildresults for the given build number

Uses of Key in com.atlassian.bamboo.persister.xstream

Classes in com.atlassian.bamboo.persister.xstream with type parameters of type Key

Modifier and Type	Class and Description
class	AbstractXStreamPersister<K extends Key,V>

Uses of Key in com.atlassian.bamboo.plan

Classes in com.atlassian.bamboo.plan that implement Key

Modifier and Type	Class and Description
class	DeploymentResultKeyAsPlanResultKey Deprecated. since 5.12 with not replacement.
class	PlanKey Identifier for Plan PlanKeys can be created via PlanKeys
class	PlanResultKey Identifier for result objects such as ChainResultsSummary and BuildResultsSummary Can be created from PlanKeys

Methods in com.atlassian.bamboo.plan that return Key

Modifier and Type	Method and Description
@NotNull Key	DeploymentResultKeyAsPlanResultKey.getEntityKey() Deprecated.
@NotNull Key	PlanResultKey.getEntityKey()

Uses of Key in com.atlassian.bamboo.rest.model

Classes in com.atlassian.bamboo.rest.model that implement Key

Modifier and Type	Class and Description
class	RestKey Used to represent a Key object in rest.
class	RestResultKey

Methods in com.atlassian.bamboo.rest.model that return Key

Modifier and Type	Method and Description
@NotNull Key	RestResultKey.getEntityKey()

Constructors in com.atlassian.bamboo.rest.model with parameters of type Key

Constructor and Description
RestKey(Key key)

Uses of Key in com.atlassian.bamboo.rest.model.deployments

Classes in com.atlassian.bamboo.rest.model.deployments that implement Key

Modifier and Type	Class and Description
class	RestDeploymentResultKey

Uses of Key in com.atlassian.bamboo.security

Methods in com.atlassian.bamboo.security that return Key

Modifier and Type	Method and Description
Key	XStreamSecureTokenPersister.PersistedSecureToken.getKey()

Methods in com.atlassian.bamboo.security with parameters of type Key

Modifier and Type	Method and Description
@NotNull SecureToken	SecureTokenServiceImpl.generate(@NotNull Key key)
@NotNull SecureToken	SecureTokenService.generate(@NotNull Key key) Generates a SecureToken for a given Key
void	SecureTokenServiceImpl.invalidate(@NotNull Key key)
void	SecureTokenService.invalidate(@NotNull Key key) Invalidates the SecureToken for the given Key
boolean	SecureTokenServiceImpl.isValid(@NotNull SecureToken tokenToValidate, @NotNull Key key)
boolean	SecureTokenService.isValid(@NotNull SecureToken tokenToValidate, @NotNull Key key) Checks if the given SecureToken is valid for given Key

Constructors in com.atlassian.bamboo.security with parameters of type Key

Constructor and Description
PersistedSecureToken(Key key, SecureToken secureToken)

Uses of Key in com.atlassian.bamboo.storage

Methods in com.atlassian.bamboo.storage with parameters of type Key

Modifier and Type	Method and Description
File	StorageLocationService.getBuildDataDirectory(Key key) Returns the top level build data directory for a plan or deployment project.
File	StorageLocationService.getBuildDownloadDataDirectory(Key key) Returns the "download data" directory for a plan or deployment project.
File	StorageLocationService.getBuildLogsDirectory(Key key) Eg.
File	StorageLocationService.getBuildResultsDirectory(Key buildKey) Eg.
File	StorageLocationService.getLogFile(Key entityKey, int resultNumber) Deprecated. since 6.5 use StorageLocationService.getLogFile(Key, long)
File	StorageLocationService.getLogFile(Key entityKey, long resultNumber) Returns the location of the log file for the specified build or deployment.
String	StorageLocationService.getLogFileName(@NotNull Key entityKey, int resultNumber) Deprecated. since 6.5 use StorageLocationService.getLogFileName(Key, long)
String	StorageLocationService.getLogFileName(@NotNull Key entityKey, long resultNumber) Returns the standard name of the log file for the specified build or deployment.

Uses of Key in com.atlassian.bamboo.storage.location

Methods in com.atlassian.bamboo.storage.location with parameters of type Key

Modifier and Type	Method and Description
File	StorageLocationServiceImpl.getBuildDataDirectory(Key key)
File	StorageLocationServiceImpl.getBuildDownloadDataDirectory(Key key)
File	StorageLocationServiceImpl.getBuildLogsDirectory(Key key)
File	StorageLocationServiceImpl.getBuildResultsDirectory(Key buildKey)
File	StorageLocationServiceImpl.getLogFile(Key entityKey, int resultNumber)
File	StorageLocationServiceImpl.getLogFile(Key entityKey, long resultNumber)
String	StorageLocationServiceImpl.getLogFileName(@NotNull Key entityKey, int resultNumber)
String	StorageLocationServiceImpl.getLogFileName(@NotNull Key entityKey, long resultNumber)
@NotNull String	StorageTagService.getStorageLabel(@NotNull Key key) Returns the storage label for the specified key.
@NotNull String	AbstractStorageTagService.getStorageLabel(@NotNull Key key)

Uses of Key in com.atlassian.bamboo.testutils.build.logger

Methods in com.atlassian.bamboo.testutils.build.logger with type parameters of type Key

Modifier and Type	Method and Description
<T extends Key> @NotNull BuildLoggerWithoutLogAccess	BuildLoggerManagerForTesting.getLoggerWithoutLogAccess(@NotNull LoggerId<T> loggerId)

Methods in com.atlassian.bamboo.testutils.build.logger with parameters of type Key

Modifier and Type	Method and Description
@NotNull SimpleBuildLogger	BuildLoggerManagerForTesting.getLogger(@NotNull Key key)
@NotNull BuildLoggerWithoutLogAccess	BuildLoggerManagerForTesting.getLoggerWithoutLogAccess(@NotNull Key resultKey)

Uses of Key in com.atlassian.bamboo.v2.build

Classes in com.atlassian.bamboo.v2.build that implement Key

Modifier and Type	Class and Description
class	BuildKey A key that represents a unique build execution.

Methods in com.atlassian.bamboo.v2.build that return Key

Modifier and Type	Method and Description
Key	BuildContextImpl.getEntityKey()
Key	CommonContext.getEntityKey()

Uses of Key in com.atlassian.bamboo.v2.build.agent.messages

Constructor parameters in com.atlassian.bamboo.v2.build.agent.messages with type arguments of type Key

Constructor and Description
AbstractAddLogEntry(LoggerId<? extends Key> loggerId, boolean needToPersistOnTarget, LogEntry logEntry)
AbstractBuildLoggerMessage(LoggerId<? extends Key> loggerId)
AddBuildLogEntry(LoggerId<? extends Key> loggerId, boolean needPersistingOnTarget, LogEntry logEntry)
AddErrorLogEntry(LoggerId<? extends Key> loggerId, boolean needPersistingOnTarget, LogEntry logEntry)

Uses of Key in com.atlassian.bamboo.v2.build.agent.remote

Methods in com.atlassian.bamboo.v2.build.agent.remote with type parameters of type Key

Modifier and Type	Method and Description
<T extends Key> @NotNull BuildLoggerWithoutLogAccess	RemoteBuildLoggerManager.getLoggerWithoutLogAccess(@NotNull LoggerId<T> loggerId)

Methods in com.atlassian.bamboo.v2.build.agent.remote with parameters of type Key

Modifier and Type	Method and Description
@NotNull File	RemoteBuildDirectoryManager.getBuildWorkingDirectory(@NotNull Key key)
@NotNull BuildLogger	RemoteBuildLoggerManager.getLogger(@NotNull Key key)
@NotNull BuildLoggerWithoutLogAccess	RemoteBuildLoggerManager.getLoggerWithoutLogAccess(@NotNull Key key)

Constructor parameters in com.atlassian.bamboo.v2.build.agent.remote with type arguments of type Key

Constructor and Description
RemoteBuildLogger(File logFile, LoggerId<? extends Key> loggerId, BambooAgentMessageSender sender, ExpiryTicker expiryTicker, BuildHangingConfig buildHangingConfig)

Uses of Key in com.atlassian.bamboo.v2.build.agent.remote.workspaces

Methods in com.atlassian.bamboo.v2.build.agent.remote.workspaces with parameters of type Key

Modifier and Type	Method and Description
void	AgentWorkspacesManager.registerWorkspace(@NotNull Key key) Register workspace as being in use.
void	RemoteAgentWorkspaceManagerImpl.registerWorkspace(@NotNull Key key)
void	AgentWorkspacesManager.unregisterWorkspace(@NotNull Key key) Mark workspace as unused and to be deleted in the next AgentWorkspacesManager.scanAndRemoveUnusedWorkspaces().
void	RemoteAgentWorkspaceManagerImpl.unregisterWorkspace(@NotNull Key key)

Uses of Key in com.atlassian.bamboo.v2.build.queue

Methods in com.atlassian.bamboo.v2.build.queue with parameters of type Key

Modifier and Type	Method and Description
void	BuildQueueManagerImpl.invalidateExecutors(@NotNull Key key)
void	BuildQueueManager.invalidateExecutors(@NotNull Key planKey)
static void	QueueManagerUtils.removeFromQueue(@NotNull BuildQueueManager buildQueueManager, @NotNull Key planKey) Remove queued items for key.

Uses of Key in com.atlassian.bamboo.vcs.configuration.legacy

Methods in com.atlassian.bamboo.vcs.configuration.legacy that return Key

Modifier and Type	Method and Description
Key	DeploymentRepositoryBuildContext.getEntityKey()