Uses of Interface
com.atlassian.bamboo.Key
Packages that use Key
Package
Description
-
Uses of Key in com.atlassian.bamboo
Subinterfaces of Key in com.atlassian.bambooModifier and TypeInterfaceDescriptioninterface
Common interface to identify a result of running something identified by aKey
Methods in com.atlassian.bamboo that return KeyModifier and TypeMethodDescription@NotNull Key
ResultKey.getEntityKey()
What is this a result of.static Key
KeyType.getKeyFromString
(String key) Get the typed key from its string representationAttempt to create the correct key for this KeyType with the provided key -
Uses of Key in com.atlassian.bamboo.agent
Methods in com.atlassian.bamboo.agent that return types with arguments of type KeyModifier and TypeMethodDescription@NotNull Collection<Key>
TaskContainerExistenceService.verifyExistence
(@NotNull Collection<Key> keys) @NotNull Collection<Key>
TaskContainerExistenceServiceImpl.verifyExistence
(@NotNull Collection<Key> keys) Method parameters in com.atlassian.bamboo.agent with type arguments of type KeyModifier and TypeMethodDescription@NotNull Collection<Key>
TaskContainerExistenceService.verifyExistence
(@NotNull Collection<Key> keys) @NotNull Collection<Key>
TaskContainerExistenceServiceImpl.verifyExistence
(@NotNull Collection<Key> keys) -
Uses of Key in com.atlassian.bamboo.build
Methods in com.atlassian.bamboo.build with type parameters of type KeyModifier and TypeMethodDescription<T extends Key>
@NotNull BuildLoggerWithoutLogAccessBuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull LoggerId<T> loggerId) Returns aBuildLoggerWithoutLogAccess
for the givenLoggerId
<T extends Key>
voidBuildLoggerManager.removeLogger
(LoggerId<T> loggerId) Remove a logger if you are finished with it.Methods in com.atlassian.bamboo.build with parameters of type KeyModifier and TypeMethodDescription@NotNull List<CurrentlyBuilding>
BuildExecutionManager.getCurrentlyBuilding
(@NotNull Key key) @NotNull List<CurrentlyBuilding>
DefaultBuildExecutionManager.getCurrentlyBuilding
(@NotNull Key key) CurrentlyBuildingContainer.getCurrentlyBuildingByKey
(Key key) Immutable list of currently building by plan.@NotNull BuildLogger
Returns aBuildLogger
for the given plan@NotNull BuildLoggerWithoutLogAccess
BuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull Key resultKey) Returns aBuildLoggerWithoutLogAccess
for the given resultint
CurrentlyBuildingContainer.numberOfCurrentlyBuildingForKey
(Key key) Method parameters in com.atlassian.bamboo.build with type arguments of type KeyModifier and TypeMethodDescription@NotNull FileWritingBuildLogger
ServerBuildLoggerManager.getFileWritingLogger
(@NotNull LoggerId<? extends Key> loggerId) Returns aBuildLogger
. -
Uses of Key in com.atlassian.bamboo.build.fileserver
Methods in com.atlassian.bamboo.build.fileserver with parameters of type KeyModifier and TypeMethodDescription@NotNull File
BuildDirectoryManager.getBuildWorkingDirectory
(@NotNull Key key) Returns the working directory for the plan.@NotNull File
DefaultBuildDirectoryManager.getBuildWorkingDirectory
(@NotNull Key key) -
Uses of Key in com.atlassian.bamboo.build.logger
Classes in com.atlassian.bamboo.build.logger with type parameters of type KeyFields in com.atlassian.bamboo.build.logger declared as KeyMethods in com.atlassian.bamboo.build.logger with type parameters of type KeyModifier and TypeMethodDescription<T extends Key>
@NotNull BuildLoggerWithoutLogAccessDefaultBuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull LoggerId<T> loggerId) <T extends Key>
voidDefaultBuildLoggerManager.removeLogger
(LoggerId<T> loggerId) Methods in com.atlassian.bamboo.build.logger that return types with arguments of type KeyMethods in com.atlassian.bamboo.build.logger with parameters of type KeyModifier and TypeMethodDescriptionBuildLogFileAccessorFactory.createBuildLogFileAccessor
(Key planKey, int buildNumber) BuildLogFileAccessorFactoryImpl.createBuildLogFileAccessor
(Key key, int buildNumber) @NotNull BuildLogger
@NotNull BuildLoggerWithoutLogAccess
DefaultBuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull Key key) Method parameters in com.atlassian.bamboo.build.logger with type arguments of type KeyModifier and TypeMethodDescription@NotNull FileWritingBuildLogger
DefaultBuildLoggerManager.getFileWritingLogger
(@NotNull LoggerId<? extends Key> loggerId) Constructor parameters in com.atlassian.bamboo.build.logger with type arguments of type KeyModifierConstructorDescriptionBuildLoggerImpl
(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 KeyModifier and TypeMethodDescriptionstatic <V,
E extends Throwable>
VScopedExclusionServiceHelper.withLockedKeyIdentifiedEntity
(ScopedExclusionService exclusionService, Key key, ScopedExclusionService.ExclusiveFunction<Key, V, E> functor) Method parameters in com.atlassian.bamboo.core with type arguments of type KeyModifier and TypeMethodDescriptionstatic <V,
E extends Throwable>
VScopedExclusionServiceHelper.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.deploymentsModifier and TypeInterfaceDescriptioninterface
interface
interface
Classes in com.atlassian.bamboo.deployments that implement KeyMethods in com.atlassian.bamboo.deployments that return KeyMethods in com.atlassian.bamboo.deployments with parameters of type KeyModifier and TypeMethodDescriptionint
static long
DeploymentKeys.getDeploymentIdFromKey
(@NotNull Key key) static long
DeploymentKeys.getEnvironmentIdFromKey
(@NotNull Key key) -
Uses of Key in com.atlassian.bamboo.deployments.environments.events
Methods in com.atlassian.bamboo.deployments.environments.events that return types with arguments of type Key -
Uses of Key in com.atlassian.bamboo.deployments.execution
Methods in com.atlassian.bamboo.deployments.execution that return Key -
Uses of Key in com.atlassian.bamboo.key
Classes in com.atlassian.bamboo.key with type parameters of type Key -
Uses of Key in com.atlassian.bamboo.logger
Methods in com.atlassian.bamboo.logger that return KeyModifier and TypeMethodDescription@Nullable Key
DecoratedErrorDetailsImpl.getEntityKey()
@Nullable Key
ErrorDetails.getEntityKey()
Get entity key associated with this error@Nullable Key
ErrorDetailsImpl.getEntityKey()
Methods in com.atlassian.bamboo.logger with parameters of type KeyModifier and TypeMethodDescription@NotNull Collection<ErrorDetails>
@NotNull Collection<ErrorDetails>
@NotNull Collection<ErrorDetails>
@NotNull Collection<ErrorDetails>
Obtain all the errors recorded against a specific planvoid
AbstractErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context) void
AbstractErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable) void
AbstractErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable, @Nullable Map<String, String> metadata) void
ErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context) Record a build error against a plan/deploymentvoid
ErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable) Record a build error against a plan/deploymentvoid
ErrorUpdateHandler.recordError
(@NotNull Key entityKey, @Nullable String context, @NotNull Throwable throwable, @Nullable 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 -
Uses of Key in com.atlassian.bamboo.persister
Classes in com.atlassian.bamboo.persister with type parameters of type KeyMethods in com.atlassian.bamboo.persister with parameters of type KeyModifier and TypeMethodDescription@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 purgeddefault void
Deprecated.since 6.7default void
AuditLogService.log
(@NotNull String s, @Nullable Key planKey, @Nullable AuditLogEntity entity) Deprecated.since 6.7void
AuditLogService.log
(@NotNull String s, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity entity) Add a message to the entity's audit log.void
AuditLogService.log
(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType) Add a message to the plans audit log.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.7void
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.void
AuditLogService.log
(@NotNull Collection<AuditLogService.FieldChange> changes, @Nullable Key key) Add 'field change' messages to the system audit log.default void
AuditLogService.log
(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key plan) Deprecated.since 6.7default void
AuditLogService.log
(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key planKey, @Nullable AuditLogEntity entity) Deprecated.since 6.7void
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
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.void
DefaultAuditLogService.log
(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType) void
DefaultAuditLogService.log
(@NotNull String msg, @Nullable Key key, AuditLogEntityType entityType, @Nullable AuditLogEntity entity) void
DefaultAuditLogService.log
(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key plan) void
DefaultAuditLogService.log
(@NotNull String fieldName, @Nullable String oldValue, @Nullable String newValue, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity entity) void
DefaultAuditLogService.log
(@NotNull Collection<AuditLogService.FieldChange> changes, @Nullable Key key) void
DefaultAuditLogService.log
(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType) void
DefaultAuditLogService.log
(@Nullable com.atlassian.user.User user, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType, @Nullable AuditLogEntity entity) void
DefaultAuditLogService.log
(@Nullable String username, @NotNull String msg, @Nullable Key key, @Nullable AuditLogEntityType entityType, @Nullable AuditLogEntity field) void
DefaultAuditLogService.log
(@Nullable String username, @NotNull String msg, @Nullable Key key, AuditLogEntityType entityType) 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 KeyModifier and TypeMethodDescription@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 -
Uses of Key in com.atlassian.bamboo.persister.xstream.journal
Classes in com.atlassian.bamboo.persister.xstream.journal with type parameters of type KeyModifier and TypeInterfaceDescriptioninterface
XStreamJournal<K extends Key,
V extends XStreamJournalEntry> A utility to journal changes to an entity as list of XStream-ed objects.class
XStreamJournalImpl<K extends Key,
V extends XStreamJournalEntry> -
Uses of Key in com.atlassian.bamboo.plan
Classes in com.atlassian.bamboo.plan that implement KeyModifier and TypeClassDescriptionclass
Deprecated.since 5.12 with not replacement.final class
class
Identifier for result objects such asChainResultsSummary
andBuildResultsSummary
Can be created fromPlanKeys
Methods in com.atlassian.bamboo.plan that return KeyModifier and TypeMethodDescription@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 KeyModifier and TypeClassDescriptionclass
Used to represent a Key object in rest.class
Methods in com.atlassian.bamboo.rest.model that return KeyConstructors in com.atlassian.bamboo.rest.model with parameters of type Key -
Uses of Key in com.atlassian.bamboo.rest.model.deployments
Classes in com.atlassian.bamboo.rest.model.deployments that implement Key -
Uses of Key in com.atlassian.bamboo.security
Methods in com.atlassian.bamboo.security that return KeyMethods in com.atlassian.bamboo.security with parameters of type KeyModifier and TypeMethodDescription@NotNull SecureToken
Generates aSecureToken
for a givenKey
@NotNull SecureToken
void
SecureTokenService.invalidate
(@NotNull Key key) Invalidates theSecureToken
for the givenKey
void
SecureTokenServiceImpl.invalidate
(@NotNull Key key) boolean
SecureTokenService.isValid
(@NotNull SecureToken tokenToValidate, @NotNull Key key) Checks if the givenSecureToken
is valid for givenKey
boolean
SecureTokenServiceImpl.isValid
(@NotNull SecureToken tokenToValidate, @NotNull Key key) Constructors in com.atlassian.bamboo.security with parameters of type Key -
Uses of Key in com.atlassian.bamboo.storage
Methods in com.atlassian.bamboo.storage with parameters of type KeyModifier and TypeMethodDescriptionStorageLocationService.getBuildDataDirectory
(Key key) Returns the top level build data directory for a plan or deployment project.StorageLocationService.getBuildDownloadDataDirectory
(Key key) Returns the "download data" directory for a plan or deployment project.StorageLocationService.getBuildLogsDirectory
(Key key) Eg.StorageLocationService.getBuildResultsDirectory
(Key buildKey) Eg.StorageLocationService.getLogFile
(Key entityKey, int resultNumber) Deprecated.since 6.5 useStorageLocationService.getLogFile(Key, long)
StorageLocationService.getLogFile
(Key entityKey, long resultNumber) Returns the location of the log file for the specified build or deployment.StorageLocationService.getLogFileName
(@NotNull Key entityKey, int resultNumber) Deprecated.since 6.5 useStorageLocationService.getLogFileName(Key, long)
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 KeyModifier and TypeMethodDescriptionStorageLocationServiceImpl.getBuildDataDirectory
(Key key) StorageLocationServiceImpl.getBuildDownloadDataDirectory
(Key key) StorageLocationServiceImpl.getBuildLogsDirectory
(Key key) StorageLocationServiceImpl.getBuildResultsDirectory
(Key buildKey) StorageLocationServiceImpl.getLogFile
(Key entityKey, int resultNumber) StorageLocationServiceImpl.getLogFile
(Key entityKey, long resultNumber) StorageLocationServiceImpl.getLogFileName
(@NotNull Key entityKey, int resultNumber) StorageLocationServiceImpl.getLogFileName
(@NotNull Key entityKey, long resultNumber) @NotNull String
AbstractStorageTagService.getStorageLabel
(@NotNull Key key) @NotNull String
StorageTagService.getStorageLabel
(@NotNull Key key) Returns the storage label for the specified key. -
Uses of Key in com.atlassian.bamboo.testutils.build.logger
Methods in com.atlassian.bamboo.testutils.build.logger with type parameters of type KeyModifier and TypeMethodDescription<T extends Key>
@NotNull BuildLoggerWithoutLogAccessBuildLoggerManagerForTesting.getLoggerWithoutLogAccess
(@NotNull LoggerId<T> loggerId) Methods in com.atlassian.bamboo.testutils.build.logger with parameters of type KeyModifier and TypeMethodDescription@NotNull SimpleBuildLogger
@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 KeyMethods in com.atlassian.bamboo.v2.build that return Key -
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 KeyModifier and TypeMethodDescriptionLogMessageBatchConverter.readLoggerId
(javax.jms.BytesMessage jmsMessage) Method parameters in com.atlassian.bamboo.v2.build.agent with type arguments of type KeyModifier and TypeMethodDescriptionstatic AbstractAddLogEntry
LogMessageBatchConverter.readLogEntry
(LoggerId<? extends Key> loggerId, 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 KeyConstructor parameters in com.atlassian.bamboo.v2.build.agent.messages with type arguments of type KeyModifierConstructorDescriptionprotected
AbstractAddLogEntry
(LoggerId<? extends Key> loggerId, boolean needToPersistOnTarget, boolean addedAfterLogSpoolClosed, LogEntry logEntry) protected
AbstractBuildLoggerMessage
(LoggerId<? extends Key> loggerId) AddBuildLogEntry
(LoggerId<? extends Key> loggerId, boolean needPersistingOnTarget, boolean addedAfterLogSpoolClosed, LogEntry logEntry) AddErrorLogEntry
(LoggerId<? extends Key> loggerId, boolean needPersistingOnTarget, boolean addedAfterLogSpoolClosed, 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 KeyModifier and TypeMethodDescription<T extends Key>
@NotNull BuildLoggerWithoutLogAccessRemoteBuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull LoggerId<T> loggerId) Methods in com.atlassian.bamboo.v2.build.agent.remote with parameters of type KeyModifier and TypeMethodDescription@NotNull File
RemoteBuildDirectoryManager.getBuildWorkingDirectory
(@NotNull Key key) @NotNull BuildLogger
@NotNull BuildLoggerWithoutLogAccess
RemoteBuildLoggerManager.getLoggerWithoutLogAccess
(@NotNull Key key) Constructor parameters in com.atlassian.bamboo.v2.build.agent.remote with type arguments of type KeyModifierConstructorDescriptionRemoteBuildLogger
(File logFile, LoggerId<? extends Key> loggerId, BambooAgentMessageSender sender, ExpiryTicker expiryTicker, BuildHangingConfig buildHangingConfig, boolean dcMode) -
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 KeyModifier and TypeMethodDescriptionvoid
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 nextAgentWorkspacesManager.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 KeyModifier and TypeMethodDescriptionvoid
BuildQueueManager.invalidateExecutors
(@NotNull Key planKey) void
BuildQueueManagerImpl.invalidateExecutors
(@NotNull Key key) static void
QueueManagerUtils.removeFromQueue
(@NotNull BuildQueueManager buildQueueManager, @NotNull LocalResultProcessor localResultProcessor, @NotNull Key planKey) Remove queued items for key.Method parameters in com.atlassian.bamboo.v2.build.queue with type arguments of type KeyModifier and TypeMethodDescriptionvoid
QueueOfExecutables.recalculateExecutors
(@NotNull 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 KeyModifier and TypeMethodDescriptionvoid
AbstractQueueOfExecutables.recalculateExecutors
(@NotNull Set<Key> keys) -
Uses of Key in com.atlassian.bamboo.vcs.configuration.legacy
Methods in com.atlassian.bamboo.vcs.configuration.legacy that return Key