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.fileserver
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.plugins.labeller
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
com.atlassian.bamboo.v2.build.agent.messages
com.atlassian.bamboo.v2.build.agent.remote
com.atlassian.bamboo.v2.build.queue
com.atlassian.bamboo.v2.build.queue.queues
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
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 parameters of type Key

Modifier and Type	Method and Description
List<CurrentlyBuilding>	DefaultBuildExecutionManager.getCurrentlyBuilding(Key key)
List<CurrentlyBuilding>	BuildExecutionManager.getCurrentlyBuilding(Key key)
List<CurrentlyBuilding>	CurrentlyBuildingContainer.getCurrentlyBuildingByKey(Key key) Immutable list of currently building by plan.
BuildLogger	BuildLoggerManager.getLogger(Key key) Returns a BuildLogger for the given plan
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
File	DefaultBuildDirectoryManager.getBuildWorkingDirectory(Key key)
File	BuildDirectoryManager.getBuildWorkingDirectory(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<Key>	LoggerIds.get(Key key)

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

Modifier and Type	Method and Description
BuildLogFileAccessor	BuildLogFileAccessorFactory.createBuildLogFileAccessor(Key planKey, int buildNumber)
BuildLogFileAccessor	BuildLogFileAccessorFactoryImpl.createBuildLogFileAccessor(Key planKey, int buildNumber)
static LoggerId<Key>	LoggerIds.get(Key key)
static File	BuildLogUtils.getLogFileDirectory(Key entityKey) Deprecated. since 5.11, use StorageLocationService#getBuildLogsDirectory(Key) instead.
static String	BuildLogUtils.getLogFileName(Key entityKey, int resultNumber) Deprecated. since 5.11, use StorageLocationService#getLogFileName(Key, long) instead.
BuildLogger	DefaultBuildLoggerManager.getLogger(Key key)

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
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
Key	DeploymentContextImpl.getEntityKey()

Uses of Key in com.atlassian.bamboo.fileserver

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

Modifier and Type	Method and Description
static File	SystemDirectory.getBuildDataDirectory(Key key) Deprecated. since 5.12, use StorageLocationService instead.
static File	SystemDirectory.getBuildDownloadDataDirectory(Key key) Deprecated. since 5.12, use StorageLocationService instead.
static File	SystemDirectory.getBuildLogsDirectory(Key key) Deprecated. since 5.12, use StorageLocationService instead.
static File	SystemDirectory.getBuildResultsDirectory(Key buildKey) Deprecated. since 5.12, use StorageLocationService instead.

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
Key	DecoratedErrorDetailsImpl.getEntityKey()
Key	ErrorDetailsImpl.getEntityKey()
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
Collection<ErrorDetails>	AggregatedChainErrorAccessor.getErrors(Key key)
Collection<ErrorDetails>	DecoratingErrorAccessorImpl.getErrors(Key entityKey)
Collection<ErrorDetails>	DefaultErrorHandler.getErrors(Key planKey)
Collection<ErrorDetails>	ErrorAccessor.getErrors(Key entityKey) Obtain all the errors recorded against a specific plan
void	AbstractErrorUpdateHandler.recordError(Key entityKey, String context)
void	ErrorUpdateHandler.recordError(Key entityKey, String context) Record a build error against a plan/deployment
void	AbstractErrorUpdateHandler.recordError(Key entityKey, String context, Throwable throwable)
void	ErrorUpdateHandler.recordError(Key entityKey, String context, Throwable throwable) Record a build error against a plan/deployment
void	AbstractErrorUpdateHandler.recordError(Key entityKey, String context, Throwable throwable, Map<String,String> metadata)
void	ErrorUpdateHandler.recordError(Key entityKey, String context, Throwable throwable, Map<String,String> metadata) Record a build error against a plan/deployment

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
SMOutputElementAppender	SMOutputElementAppender.append(String elementName, 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
BuildResults	Persister.getBuildResults(Key planKey, int buildNumber) Deprecated. Get the Nth build for a given build.
BuildResults	CachedBuildPersisterDecorator.loadBuildResults(Key planKey, int buildNumber) Cache the build results so that the least used results get purged
void	DefaultAuditLogService.log(Collection<AuditLogService.FieldChange> changes, Key key)
void	AuditLogService.log(Collection<AuditLogService.FieldChange> changes, Key key) Add 'field change' messages to the system audit log.
default void	AuditLogService.log(String msg, Key plan) Deprecated. since 6.7
default void	AuditLogService.log(String s, Key planKey, AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(String msg, Key key, AuditLogEntityType entityType)
void	AuditLogService.log(String msg, Key key, AuditLogEntityType entityType) Add a message to the plans audit log.
void	DefaultAuditLogService.log(String msg, Key key, AuditLogEntityType entityType, AuditLogEntity entity)
void	AuditLogService.log(String s, Key key, AuditLogEntityType entityType, AuditLogEntity entity) Add a message to the entity's audit log.
void	DefaultAuditLogService.log(String username, String msg, Key key, AuditLogEntityType entityType)
void	DefaultAuditLogService.log(String username, String msg, Key key, AuditLogEntityType entityType, AuditLogEntity field)
void	DefaultAuditLogService.log(String fieldName, String oldValue, String newValue, Key plan)
void	AuditLogService.log(String fieldName, String oldValue, String newValue, Key plan) Add 'field change' message to the system audit log.
default void	AuditLogService.log(String fieldName, String oldValue, String newValue, Key planKey, AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(String fieldName, String oldValue, String newValue, Key key, AuditLogEntityType entityType, AuditLogEntity entity)
void	AuditLogService.log(String fieldName, String oldValue, String newValue, Key key, AuditLogEntityType entityType, AuditLogEntity entity) Add 'field change' message to the system audit log.
default void	AuditLogService.log(com.atlassian.user.User user, String msg, Key plan) Deprecated. since 6.7
default void	AuditLogService.log(com.atlassian.user.User user, String msg, Key planKey, AuditLogEntity entity) Deprecated. since 6.7
void	DefaultAuditLogService.log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType)
void	AuditLogService.log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType) Add a message to the entity's audit log.
void	DefaultAuditLogService.log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType, AuditLogEntity entity)
void	AuditLogService.log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType, 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
BuildResults	FileBasedPersister.getBuildResults(Key planKey, int buildNumber)
BuildResults	BuildPersisterDecorator.loadBuildResults(Key planKey, int buildNumber) Load the given build's buildNumber'th build results
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
Key	DeploymentResultKeyAsPlanResultKey.getEntityKey() Deprecated.
Key	PlanResultKey.getEntityKey()

Uses of Key in com.atlassian.bamboo.plugins.labeller

Methods in com.atlassian.bamboo.plugins.labeller with parameters of type Key

Modifier and Type	Method and Description
protected BuildLogFileAccessor	BuildLabeller.getBuildLogFileAccessor(Key planKey, int buildNumber)

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
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
SecureToken	SecureTokenServiceImpl.generate(Key key)
SecureToken	SecureTokenService.generate(Key key) Generates a SecureToken for a given Key
void	SecureTokenServiceImpl.invalidate(Key key)
void	SecureTokenService.invalidate(Key key) Invalidates the SecureToken for the given Key
boolean	SecureTokenServiceImpl.isValid(SecureToken tokenToValidate, Key key)
boolean	SecureTokenService.isValid(SecureToken tokenToValidate, 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(Key entityKey, int resultNumber) Deprecated. since 6.5 use StorageLocationService.getLogFileName(Key, long)
String	StorageLocationService.getLogFileName(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(Key entityKey, int resultNumber)
String	StorageLocationServiceImpl.getLogFileName(Key entityKey, long resultNumber)

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

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

Modifier and Type	Method and Description
SimpleBuildLogger	BuildLoggerManagerForTesting.getLogger(Key key)

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

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

Modifier and Type	Method and Description
static LoggerId<? extends Key>	LogMessageBatchConverter.readLoggerId(javax.jms.BytesMessage jmsMessage)

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

Methods in com.atlassian.bamboo.v2.build.agent.messages that return types with arguments of type Key

Modifier and Type	Method and Description
LoggerId<? extends Key>	LogMessageBatch.getLoggerId()

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

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

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

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

Modifier and Type	Method and Description
File	RemoteBuildDirectoryManager.getBuildWorkingDirectory(Key key)
BuildLogger	RemoteBuildLoggerManager.getLogger(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)

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(Key key)
void	BuildQueueManager.invalidateExecutors(Key planKey)
static void	QueueManagerUtils.removeFromQueue(BuildQueueManager buildQueueManager, Key planKey) Remove queued items for key.

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

Modifier and Type	Method and Description
void	QueueOfExecutables.recalculateExecutors(Set<Key> keys) Recalculates executors for a given plan - until then, any information about executor-executable mapping for this plan should be considered to be invalid.

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

Method parameters in com.atlassian.bamboo.v2.build.queue.queues with type arguments of type Key

Modifier and Type	Method and Description
void	AbstractQueueOfExecutables.recalculateExecutors(Set<Key> keys)

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()