Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abortIfCanceled() - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Ensures that the export has not been canceled.
- ABSTAIN - Enum constant in enum class com.atlassian.bitbucket.permission.PermissionVote
- AbstractHomeUpdateHandler - Class in com.atlassian.bitbucket.home
-
Provides a base class for implementing
HomeUpdateHandler
s. - AbstractHomeUpdateHandler() - Constructor for class com.atlassian.bitbucket.home.AbstractHomeUpdateHandler
- AbstractRepositoryScmRequest - Class in com.atlassian.bitbucket.scm
-
Extends
AbstractScmRequest
and adds properties to facilitate implementingSCM requests
which interact with a repository, to read orwrite
. - AbstractRepositoryScmRequest(Repository, boolean) - Constructor for class com.atlassian.bitbucket.scm.AbstractRepositoryScmRequest
- AbstractScm - Class in com.atlassian.bitbucket.scm
-
Convenience implementation of
Scm
that returnsnull
for all of the optional contract members. - AbstractScm() - Constructor for class com.atlassian.bitbucket.scm.AbstractScm
- AbstractScm(Set<ScmFeature>) - Constructor for class com.atlassian.bitbucket.scm.AbstractScm
- AbstractScmRequest - Class in com.atlassian.bitbucket.scm
-
A simple base class to facilitate implementing
SCM requests
. - AbstractScmRequest() - Constructor for class com.atlassian.bitbucket.scm.AbstractScmRequest
- AbstractScmRequestHandlerModuleDescriptor<T> - Class in com.atlassian.bitbucket.scm
-
A base class for constructing module descriptors for
ScmRequest
handlers. - AbstractScmRequestHandlerModuleDescriptor(ModuleFactory, int) - Constructor for class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
- accept(T) - Method in interface com.atlassian.bitbucket.io.IoConsumer
-
Performs this operation on the given argument.
- accept(T, U) - Method in interface com.atlassian.bitbucket.io.IoBiConsumer
-
Performs this operation on the given arguments.
- ActionResult - Interface in com.atlassian.bitbucket.build.server.operations
-
The result of a request from Bitbucket to a CI system to perform a certain action.
- ActionState - Enum Class in com.atlassian.bitbucket.build.server.operations
-
The final state of the request to perform an action.
- ACTIVE - Enum constant in enum class com.atlassian.bitbucket.shutdown.ShutdownHookStatus
-
Indicates that the component has some currently running tasks which will be interrupted, if component is terminated.
- add(String, K) - Method in interface com.atlassian.bitbucket.migration.EntityImportMapping
-
Adds a mapping between the
exportId
andlocalId
. - ADDED_TO_ANY_REF - Enum constant in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Any commit added to any ref.
- ADDED_TO_REPOSITORY - Enum constant in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Any new commit added to any ref.
- addEntriesAsArchive(Path, IoConsumer<SequentialArchive>, boolean) - Method in interface com.atlassian.bitbucket.migration.ExportSection
-
Adds entries packaged as an archive to the export archive
- addEntry(Path, IoConsumer<OutputStream>) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addEntry(Path, IoConsumer<OutputStream>, boolean) - Method in interface com.atlassian.bitbucket.migration.ExportSection
-
Creates a file with the given
entryName
under thissection
of the export archive, then consumes theOutputStream
it obtains from the file, using the givenConsumer
- addError(KeyedMessage, Object) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Report a failed export of the provided entity
- addError(KeyedMessage, Object) - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Report a failed import
- addError(KeyedMessage, Object, Throwable) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Report an error during an export for the provided entity and with an optional
Throwable
to log - addError(KeyedMessage, Object, Throwable) - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Report a failed import
- addFieldError(String, String) - Method in interface com.atlassian.bitbucket.ui.ValidationErrors
-
Add an error message to a specific field.
- addFormError(String) - Method in interface com.atlassian.bitbucket.ui.ValidationErrors
-
Add a general error message that will be rendered at the top of the form.
- addPathFromDisk(Path) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, int) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, Path) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, PathMatcher) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, PathMatcher, int) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, Path, int) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, Path, PathMatcher) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addPathFromDisk(Path, Path, PathMatcher, int) - Method in interface com.atlassian.bitbucket.migration.SequentialArchive
-
Add an entry to an archive.
- addSectionIfAbsent(Path, Consumer<ExportSection>) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Creates a
section
with the given relative path inside the export archive. - addWarning(KeyedMessage, Object) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Report a warning during an export for the provided entity
- addWarning(KeyedMessage, Object) - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Report a warning during an import
- addWarning(KeyedMessage, Object, Throwable) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Report a warning during an export for the provided entity and with an optional
Throwable
to log - addWarning(KeyedMessage, Object, Throwable) - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Report a warning during an import
- andThen(Function<? super R, ? extends V>) - Method in interface com.atlassian.bitbucket.io.IoFunction
-
Returns a composed function that first applies this function to its input, and then applies the
after
function to the result. - apply(HomeUpdate) - Method in interface com.atlassian.bitbucket.home.HomeUpdateHandler
-
Applies whatever changes are necessary to replace references to the old shared home directory location with references to the new one.
- apply(IoFunction<InputStream, T>) - Method in interface com.atlassian.bitbucket.migration.EntrySource
-
Apply the
IoFunction
to the file represented by this entry and return the result. - apply(T) - Method in interface com.atlassian.bitbucket.io.IoFunction
-
Applies this function to the given argument.
- archive(Repository, ArchiveCommandParameters, TypeAwareOutputSupplier) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Streams an archive of the repository at the specified commit, in the requested format.
- ARCHIVE_VERSION - Static variable in interface com.atlassian.bitbucket.migration.Exporter
-
Archive version that this version of the product generates.
- ArchiveSource - Interface in com.atlassian.bitbucket.migration
-
Provides access to an archive within an archive.
- asynchronous() - Method in class com.atlassian.bitbucket.scm.SimpleCommand
- asyncSupported() - Element in annotation interface com.atlassian.bitbucket.hook.repository.SynchronousPreferred
- ATTACHMENT - Static variable in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- AUTHENTICATED - Enum constant in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Indicates that authentication has succeeded.
- AuthenticationResult - Class in com.atlassian.bitbucket.auth
-
Outcome of a successful
authentication
operation. - AuthenticationResult.Builder - Class in com.atlassian.bitbucket.auth
- AuthenticationState - Enum Class in com.atlassian.bitbucket.scm
-
Indicates the result of a user's authentication attempt.
B
- BaseScmHookModuleDescriptor<T> - Class in com.atlassian.bitbucket.hook
-
Base implementation for scm hook module descriptor.
- BaseScmHookModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- BaseWeightedModuleDescriptor<T> - Class in com.atlassian.bitbucket.scm
- BaseWeightedModuleDescriptor(ModuleFactory, int) - Constructor for class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor
- BITBUCKET_REALM - Static variable in interface com.atlassian.bitbucket.scm.http.HttpScmRequest
-
Realm to be used in any Authentication challenges.
- blame(Repository, BlameCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of
Blame
, providing attribution for each line in the specified file, calculated from the specified starting commit. - branches(Repository, BranchesCommandParameters, BranchCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams
branches
in the specified repository to the providedcallback
. - branches(Repository, BranchesCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of
branches
. - build() - Method in class com.atlassian.bitbucket.auth.AuthenticationResult.Builder
- build() - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication.Builder
- build() - Method in class com.atlassian.bitbucket.build.server.operations.BuildStatusActionRequest.Builder
- build() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters.Builder
- build() - Method in class com.atlassian.bitbucket.scm.ForkCommandParameters.Builder
- build() - Method in class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters.Builder
- build() - Method in class com.atlassian.bitbucket.scm.pull.PullRequestDeleteCommandParameters.Builder
- build() - Method in class com.atlassian.bitbucket.scm.pull.UpdatePullRequestRefsCommandParameters.Builder
- build() - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest.Builder
- build() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- build() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext.Builder
- builder(Repository) - Method in interface com.atlassian.bitbucket.scm.PluginCommandBuilderFactory
-
Creates a
ScmCommandBuilder
which can be used to construct free-form commands to interact directly with the underlying SCM implementation and perform custom functions on repositories. - builder(ApplicationUser) - Static method in class com.atlassian.bitbucket.auth.SimpleAuthentication
- Builder() - Constructor for class com.atlassian.bitbucket.scm.DeleteCommandParameters.Builder
- Builder() - Constructor for class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters.Builder
- Builder() - Constructor for class com.atlassian.bitbucket.scm.pull.PullRequestDeleteCommandParameters.Builder
- Builder() - Constructor for class com.atlassian.bitbucket.scm.pull.UpdatePullRequestRefsCommandParameters.Builder
- Builder(BuildStatusAction, RepositoryBuildStatus) - Constructor for class com.atlassian.bitbucket.build.server.operations.BuildStatusActionRequest.Builder
- Builder(Repository) - Constructor for class com.atlassian.bitbucket.scm.ForkCommandParameters.Builder
- Builder(Repository, URI) - Constructor for class com.atlassian.bitbucket.scm.ScmUrlRequest.Builder
- Builder(BulkRescopeCommandParameters) - Constructor for class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters.Builder
- Builder(SshScmRequestContext) - Constructor for class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- Builder(SshCommandContext, ExitCodeCallback) - Constructor for class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- Builder(ApplicationUser) - Constructor for class com.atlassian.bitbucket.auth.AuthenticationResult.Builder
- Builder(ApplicationUser) - Constructor for class com.atlassian.bitbucket.auth.SimpleAuthentication.Builder
- Builder(String, InputStream, OutputStream, OutputStream) - Constructor for class com.atlassian.bitbucket.ssh.command.SshCommandContext.Builder
- Builder(String, InputStream, OutputStream, OutputStream, ExitCodeCallback) - Constructor for class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- BuildOperations - Interface in com.atlassian.bitbucket.build.server.operations
-
Encapsulates the actions that can be taken as well as information about authorization requirements.
- BuildStatusAction - Interface in com.atlassian.bitbucket.build.server.operations
-
An action that can be performed on a build status
- BuildStatusActionRequest - Class in com.atlassian.bitbucket.build.server.operations
-
A request to perform an action on a build status e.g.
- BuildStatusActionRequest.Builder - Class in com.atlassian.bitbucket.build.server.operations
- BuildStatusEnricher - Interface in com.atlassian.bitbucket.build.server
-
A class that is used to add extra details to a
RepositoryBuildStatus
that don't exist in the database. - bulkRescope(BulkRescopeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- BulkRescopeCommandParameters - Class in com.atlassian.bitbucket.scm.pull
- BulkRescopeCommandParameters.Builder - Class in com.atlassian.bitbucket.scm.pull
- BulkRescopeContext - Interface in com.atlassian.bitbucket.scm.pull
-
Provides a context for SCMs to detect
pull request rescopes
when a repository is updated.
C
- cancel() - Method in interface com.atlassian.bitbucket.scm.ssh.SshScmRequest
-
Cancel the command if active.
- cancel() - Method in interface com.atlassian.bitbucket.ssh.command.SshCommand
-
Cancels a running command, usually in response to the SSH client disconnecting.
- CanceledMigrationException - Exception in com.atlassian.bitbucket.migration
-
Thrown during migration operations to signal the caller that the operation has been canceled and that the caller should clean up the state they own and stop any work.
- CanceledMigrationException(KeyedMessage) - Constructor for exception com.atlassian.bitbucket.migration.CanceledMigrationException
- canCollectAnalytics() - Method in interface com.atlassian.bitbucket.plugin.OptionalPluginInformationProvider
-
Determines if the atlassian-analytics plugin is installed and enabled and the privacy policy has been acknowledged.
- CAPTCHA_REQUIRED - Enum constant in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Indicates that the user's account is locked and they must navigate to the Stash Web UI and solve a CAPTCHA test.
- changes(CompareRequest, CompareChangeCommandParameters, ChangeCallback) - Method in interface com.atlassian.bitbucket.scm.compare.PluginCompareCommandFactory
- changes(PullRequest, PullRequestChangesCommandParameters, ChangeCallback) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- changes(Repository, ChangesCommandParameters, ChangeCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams
changes
between two commits to the providedcallback
. - changes(Repository, ChangesCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of
changes
between two commits. - changesets(Repository, ChangesetsCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of
changesets
given a set ofcommit IDs
, where each changeset includes the first page ofchanges
between a requested commit and its first parent. - check(PullRequest) - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequestCheckService
-
Applies all registered and enabled
RepositoryMergeCheck
s to determine if a pull request merge should proceed. - check(ScmRequest) - Method in interface com.atlassian.bitbucket.scm.ScmRequestCheck
- checkActionAllowed(ScmRequest) - Method in interface com.atlassian.bitbucket.scm.ScmRequestCheckService
-
Check whether the supplied
ScmRequest
can proceed within the current request and server context. - checkIntegrity(IntegrityCheckContext, IntegrityCheckCallback) - Method in interface com.atlassian.bitbucket.scm.integrity.PluginIntegrityCheckCommandFactory
-
Instructs an SCM to perform integrity checks.
- clear() - Method in interface com.atlassian.bitbucket.migration.EntityImportMapping
-
Remove all entries from this mapping
- com.atlassian.bitbucket.auth - package com.atlassian.bitbucket.auth
- com.atlassian.bitbucket.build.server - package com.atlassian.bitbucket.build.server
- com.atlassian.bitbucket.build.server.operations - package com.atlassian.bitbucket.build.server.operations
- com.atlassian.bitbucket.comment - package com.atlassian.bitbucket.comment
- com.atlassian.bitbucket.filestore - package com.atlassian.bitbucket.filestore
- com.atlassian.bitbucket.home - package com.atlassian.bitbucket.home
- com.atlassian.bitbucket.hook - package com.atlassian.bitbucket.hook
- com.atlassian.bitbucket.hook.repository - package com.atlassian.bitbucket.hook.repository
- com.atlassian.bitbucket.idx - package com.atlassian.bitbucket.idx
- com.atlassian.bitbucket.io - package com.atlassian.bitbucket.io
- com.atlassian.bitbucket.json - package com.atlassian.bitbucket.json
- com.atlassian.bitbucket.migration - package com.atlassian.bitbucket.migration
- com.atlassian.bitbucket.permission - package com.atlassian.bitbucket.permission
- com.atlassian.bitbucket.plugin - package com.atlassian.bitbucket.plugin
- com.atlassian.bitbucket.pull - package com.atlassian.bitbucket.pull
- com.atlassian.bitbucket.repository - package com.atlassian.bitbucket.repository
- com.atlassian.bitbucket.scm - package com.atlassian.bitbucket.scm
- com.atlassian.bitbucket.scm.bulk - package com.atlassian.bitbucket.scm.bulk
- com.atlassian.bitbucket.scm.compare - package com.atlassian.bitbucket.scm.compare
- com.atlassian.bitbucket.scm.event - package com.atlassian.bitbucket.scm.event
- com.atlassian.bitbucket.scm.http - package com.atlassian.bitbucket.scm.http
- com.atlassian.bitbucket.scm.integrity - package com.atlassian.bitbucket.scm.integrity
- com.atlassian.bitbucket.scm.mirror - package com.atlassian.bitbucket.scm.mirror
- com.atlassian.bitbucket.scm.pull - package com.atlassian.bitbucket.scm.pull
- com.atlassian.bitbucket.scm.ref - package com.atlassian.bitbucket.scm.ref
- com.atlassian.bitbucket.scm.ssh - package com.atlassian.bitbucket.scm.ssh
- com.atlassian.bitbucket.setting - package com.atlassian.bitbucket.setting
- com.atlassian.bitbucket.settingsrestriction - package com.atlassian.bitbucket.settingsrestriction
- com.atlassian.bitbucket.shutdown - package com.atlassian.bitbucket.shutdown
- com.atlassian.bitbucket.ssh.command - package com.atlassian.bitbucket.ssh.command
- com.atlassian.bitbucket.ui - package com.atlassian.bitbucket.ui
- com.atlassian.bitbucket.user - package com.atlassian.bitbucket.user
- com.atlassian.bitbucket.util - package com.atlassian.bitbucket.util
- COMMENT - Static variable in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- CommentPropertyContext - Interface in com.atlassian.bitbucket.comment
-
Allows iterating and adding
properties
on comments. - CommentPropertyProvider - Interface in com.atlassian.bitbucket.comment
-
Provides properties to Stash
comments
. - commit(Repository, CommitCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the requested commit or, if a path was also supplied, retrieves the first commit to modify that path prior to the requested commit.
- CommitAddedDetails - Interface in com.atlassian.bitbucket.hook.repository
- CommitIndexer - Interface in com.atlassian.bitbucket.idx
-
Describes an indexer to be notified when commits are added to or removed from a repository.
- CommitIndexerModuleDescriptor - Class in com.atlassian.bitbucket.idx
- CommitIndexerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.idx.CommitIndexerModuleDescriptor
- CommitPropertyConfiguration - Interface in com.atlassian.bitbucket.idx
-
Property configuration for any commit indexer.
- CommitPropertyConfigurationModuleDescriptor - Class in com.atlassian.bitbucket.idx
- CommitPropertyConfigurationModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.idx.CommitPropertyConfigurationModuleDescriptor
- CommitRemovedDetails - Interface in com.atlassian.bitbucket.hook.repository
- commits(CompareRequest, CommitCallback) - Method in interface com.atlassian.bitbucket.scm.compare.PluginCompareCommandFactory
- commits(PullRequest, PullRequestCommitsCommandParameters, CommitCallback) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- commits(Repository, BulkCommitsCommandParameters, BulkCommitCallback) - Method in interface com.atlassian.bitbucket.scm.bulk.PluginBulkContentCommandFactory
-
Streams commits from one or more repositories, providing a set of matching repositories for each.
- commits(Repository, CommitsCommandParameters, CommitCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams commits which match the provided
paramters
to the provided callback. - commits(Repository, CommitsCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of commits which match the provided
paramters
. - commonAncestor(Repository, CommonAncestorCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the common ancestor for the provided commits
- COMPARABLE - Static variable in interface com.atlassian.bitbucket.util.Weighted
-
Note that this comparator only considers weight.
- compareTo(BaseWeightedModuleDescriptor<T>) - Method in class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- compareTo(BaseWeightedModuleDescriptor<T>) - Method in class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor
- compose(Function<? super V, ? extends T>) - Method in interface com.atlassian.bitbucket.io.IoFunction
-
Returns a composed function that first applies the
before
function to its input, and then applies this function to the result. - contents(Repository, BulkContentCommandParameters, BulkContentCallback) - Method in interface com.atlassian.bitbucket.scm.bulk.PluginBulkContentCommandFactory
- ContextualFormFragment - Interface in com.atlassian.bitbucket.ui
-
Allows the injection of fields into existing forms provided by the host application.
- create(Authentication) - Method in interface com.atlassian.bitbucket.permission.PermissionVoterProvider
- create(Repository, CreateCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Creates and initializes the repository on disk, performing any SCM-specific configuration that is appropriate for new repositories.
- create(SshScmRequestContext) - Method in interface com.atlassian.bitbucket.scm.ssh.SshScmRequestHandler
-
Returns an
SshScmRequest
if this handler can handle the supplied command string, orOptional.empty()
otherwise. - create(SshCommandContext) - Method in interface com.atlassian.bitbucket.ssh.command.SshCommandFactory
- create(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.bitbucket.scm.http.HttpScmRequestHandler
-
Returns an
HttpScmRequest
to service the supplied request, orOptional.empty()
if the request could not be created. - createBranch(Repository, CreateBranchCommandParameters) - Method in interface com.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
- createTag(Repository, CreateTagCommandParameters) - Method in interface com.atlassian.bitbucket.scm.ref.PluginRefCommandFactory
D
- decline(PullRequestRescope) - Method in interface com.atlassian.bitbucket.scm.pull.BulkRescopeContext
-
Marks the rescope as
declining
the associated pull request. - defaultBranch(Repository) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the default
Branch
for the specified repository. - defaultBranch(String) - Method in class com.atlassian.bitbucket.scm.ForkCommandParameters.Builder
-
Specifies the default branch that should be set after the fork is created.
- DefaultCommandExitHandler - Class in com.atlassian.bitbucket.scm
- DefaultCommandExitHandler(I18nService) - Constructor for class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- delete(PullRequest, PullRequestDeleteCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
-
Deletes repository data associated with the specified pull request.
- delete(Repository, long, PullRequestDeleteCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
-
Deletes repository data associated with the specified pull request.
- delete(Repository, DeleteCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Deletes the repository, allowing the underlying SCM to carry out any special processing necessary to clean up repository storage.
- DeleteCommandParameters - Class in com.atlassian.bitbucket.scm
- DeleteCommandParameters.Builder - Class in com.atlassian.bitbucket.scm
- deleteFiles(DeleteFilesRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Delete files from the file store.
- deleteRecursive(DeleteRecursiveRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Delete files from the file store recursively.
- diff(CompareRequest, CompareDiffCommandParameters, DiffContentCallback) - Method in interface com.atlassian.bitbucket.scm.compare.PluginCompareCommandFactory
- diff(PullRequest, PullRequestDiffCommandParameters, DiffContentCallback) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- diff(Repository, DiffCommandParameters, DiffContentCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams the diff between two commits to the provided
callback
. - diff(Repository, DiffCommandParameters, TypeAwareOutputSupplier) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams the raw diff between two commits.
- diffStatsSummary(CompareRequest, CompareDiffStatsSummaryCommandParameters) - Method in interface com.atlassian.bitbucket.scm.compare.PluginCompareCommandFactory
-
Retrieve the diff stats summary for the specified
request
. - diffStatsSummary(PullRequest, PullRequestDiffStatsSummaryCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
-
Retrieves the diff stats summary for the effective diff of the given pull request.
- diffStatsSummary(Repository, DiffStatsSummaryCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the diff stats summary between two commits.
- directory(Repository, DirectoryCommandParameters, ContentTreeCallback, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams a directory listing for the requested path at the specified commit.
- disabled() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationFailureHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationSuccessHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.idx.CommitIndexerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.idx.CommitPropertyConfigurationModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.permission.PermissionVoterProviderModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.scm.ScmModuleDescriptor
-
Clears the cached
Scm
. - disabled() - Method in class com.atlassian.bitbucket.scm.ScmProtocolModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
- disabled() - Method in class com.atlassian.bitbucket.user.UserErasureModuleDescriptor
- doError(Appendable, Map<String, String[]>, Map<String, Collection<String>>, Map<String, Object>) - Method in interface com.atlassian.bitbucket.ui.ContextualFormFragment
-
Render your fields after a validation error has occurred.
- doProvideProperties(CommentPropertyContext) - Method in class com.atlassian.bitbucket.comment.FlatteningCommentPropertyProvider
- doView(Appendable, Map<String, Object>) - Method in interface com.atlassian.bitbucket.ui.ContextualFormFragment
- drain(long, TimeUnit) - Method in interface com.atlassian.bitbucket.util.Drainable
-
Waits for all resources to become free.
- Drainable - Interface in com.atlassian.bitbucket.util
-
Indicates connection pools and similar data structures have a means of waiting for resources to close/clean up.
E
- editFile(Repository, EditFileCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Adds a new file or updates the content of an existing file as described in the
parameters
. - effectiveDiff(PullRequest) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- emptyArchive() - Static method in interface com.atlassian.bitbucket.migration.ExportSection
-
Returns a consumer for
SequentialArchive
that adds no entries to the archive. - emptyEntry() - Static method in interface com.atlassian.bitbucket.migration.ExportSection
-
Returns a consumer for
OutputStream
that does not write any data. - enabled() - Method in class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- enabled() - Method in class com.atlassian.bitbucket.idx.CommitPropertyConfigurationModuleDescriptor
- enabled() - Method in class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
- EntityExportMapping<K> - Interface in com.atlassian.bitbucket.migration
-
Provides the ability to map local IDs to instance agnostic logical IDs during an export.
- EntityImportMapping<K> - Interface in com.atlassian.bitbucket.migration
-
Provides the ability to map generated export IDs to locally created IDs during an import and vice versa.
- EntrySource - Interface in com.atlassian.bitbucket.migration
-
Provides access to a single file within an archive.
- environment(String, String) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- environment(String, String) - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext.Builder
- environment(Map<String, String>) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- environment(Map<String, String>) - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext.Builder
- equals(Object) - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication
- equals(Object) - Method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- equals(Object) - Method in class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- eraseUser(UserErasureRequest) - Method in interface com.atlassian.bitbucket.user.UserErasureHandler
- ERROR - Enum constant in enum class com.atlassian.bitbucket.build.server.operations.ActionState
-
An error occurred trying to perform the action, such as a connection error or the build server being down.
- execute(Map<String, String[]>) - Method in interface com.atlassian.bitbucket.ui.PluginFormFragments
-
Execute all of the
ContextualFormFragment
s defined for this form. - execute(Map<String, String[]>, Map<String, Object>) - Method in interface com.atlassian.bitbucket.ui.ContextualFormFragment
-
Store the fields supplied by this form and perform any other actions.
- existsForKey(String) - Method in interface com.atlassian.bitbucket.ui.PluginFormFragmentsFactory
-
Checks if any form fragment is associated with a form key.
- exitCodeCallback(ExitCodeCallback) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- ExitCodeCallback - Interface in com.atlassian.bitbucket.scm.ssh
-
Passed to the
SshScmRequestHandler
as a callback to be used when an underlying SSH process completes. - export(ExportContext, Project) - Method in interface com.atlassian.bitbucket.migration.Exporter
-
Called when a project is exported.
- export(ExportContext, PullRequest) - Method in interface com.atlassian.bitbucket.migration.Exporter
-
Called when a pull request is exported.
- export(ExportContext, Repository) - Method in interface com.atlassian.bitbucket.migration.Exporter
-
Called when a repository is exported.
- ExportContext - Interface in com.atlassian.bitbucket.migration
-
Represents the context for the current export job.
- Exporter - Interface in com.atlassian.bitbucket.migration
-
Data Center Migration Exporter SPI
- ExportSection - Interface in com.atlassian.bitbucket.migration
-
Allows addition of entries to the export archive, either from disk or directly from a
stream
. - extractToDisk(Path) - Method in interface com.atlassian.bitbucket.migration.ArchiveSource
-
Extract this contents of this archive to the specified target.
- extractToDisk(Path) - Method in interface com.atlassian.bitbucket.migration.EntrySource
-
Extract this entry to the specified target.
- extractToDisk(Path, Predicate<String>) - Method in interface com.atlassian.bitbucket.migration.ArchiveSource
-
Filter and extract this contents of this archive to the specified target.
F
- FAILED - Enum constant in enum class com.atlassian.bitbucket.build.server.operations.ActionState
-
The action failed to perform.
- file(Repository, FileCommandParameters, FileContentCallback, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams lines from the requested path at the specified commit, for non-binary files.
- fileExists(FileExistsRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Check if a file exists in the file store.
- FileStoreConfigurationException - Exception in com.atlassian.bitbucket.filestore
-
Exception thrown when a file store is misconfigured.
- FileStoreConfigurationException(String) - Constructor for exception com.atlassian.bitbucket.filestore.FileStoreConfigurationException
- FileStoreConfigurationException(String, Throwable) - Constructor for exception com.atlassian.bitbucket.filestore.FileStoreConfigurationException
- finalizeRepositoryImport(ImportContext, Repository) - Method in interface com.atlassian.bitbucket.migration.Importer
-
A callback to indicate a repository and any of its dependent entities have been imported.
- FlatteningCommentPropertyProvider - Class in com.atlassian.bitbucket.comment
-
An implementation of
CommentPropertyProvider
that flattens the list of the comments in thecontext
such that subclasses that overrideFlatteningCommentPropertyProvider.doProvideProperties(CommentPropertyContext)
have instant access to all nested comments without having to go through thereply tree
manually. - FlatteningCommentPropertyProvider() - Constructor for class com.atlassian.bitbucket.comment.FlatteningCommentPropertyProvider
- ForcedDrainable - Interface in com.atlassian.bitbucket.util
-
Indicates connection pools and similar data structures which have a means of waiting for resources to close/clean up and additionally support a more aggressive form of draining which attempts to forcibly release the underlying resources.
- forceDrain(long, TimeUnit) - Method in interface com.atlassian.bitbucket.util.ForcedDrainable
-
A more aggressive form of
Drainable.drain(long, java.util.concurrent.TimeUnit)
. - fork(Repository, ForkCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Creates a fork of
repository
, stored in thespecified fork
. - ForkCommandParameters - Class in com.atlassian.bitbucket.scm
-
Describes the fork being created.
- ForkCommandParameters.Builder - Class in com.atlassian.bitbucket.scm
- forKey(String, Map<String, Object>) - Method in interface com.atlassian.bitbucket.ui.PluginFormFragmentsFactory
-
Gets the form fragments associated with a form key.
- forkIds(Iterable<Integer>) - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters.Builder
- format(ScmUrlRequest) - Method in interface com.atlassian.bitbucket.scm.ScmUrlFormatter
- fromKeyAndSlug(String, String) - Static method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- fromPathInfo(String) - Static method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
-
Extracts the repository URL fragment from the given path info.
- fromRepository(Repository) - Static method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- fromString(String) - Static method in enum class com.atlassian.bitbucket.build.server.operations.ActionState
G
- generateGetUrl(GenerateGetUrlRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Get a URL to "GET" a file from the file store.
- generatePutUrl(GeneratePutUrlRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Get a URL to "PUT" a file to the file store.
- get() - Method in interface com.atlassian.bitbucket.io.IoSupplier
-
Gets a result.
- get(String) - Method in interface com.atlassian.bitbucket.idx.IndexingContext
-
Retrieve an object from the context.
- getAction(RepositoryBuildStatus, String) - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
Get and action by ID.
- getActions() - Method in interface com.atlassian.bitbucket.build.server.operations.BuildOperations
-
The
BuildStatusAction
s available for the currently authenticated user on this build status. - getArtifactLink(RepositoryBuildStatus) - Method in interface com.atlassian.bitbucket.build.server.BuildStatusEnricher
- getAttributeMap() - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Returns the
AttributeMap
object for this context. - getAttributeMap() - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Returns the
AttributeMap
object for this context. - getAuthenticationException() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationFailureContext
- getAuthenticationException() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationFailureContext
- getAuthenticationState() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationFailureContext
- getAuthenticationState() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationFailureContext
- getAuthorizationUrl() - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
The URI that can be used for the current user to authorize Bitbucket to act with the requested build server on their behalf.
- getAuthorizationUrl(URI) - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
The URI that can be used for the current user to authorize Bitbucket to act with the requested build server on their behalf.
- getBaseRef() - Method in interface com.atlassian.bitbucket.repository.RefMetadataContext
- getBaseUrl() - Method in interface com.atlassian.bitbucket.scm.ScmProtocol
- getBaseUrl() - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest
- getBuildAction() - Method in class com.atlassian.bitbucket.build.server.operations.BuildStatusActionRequest
- getBuildServer(String) - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServerProvider
-
Get the
PluginBuildServer
for the given ID. - getBuildServer(HttpServletRequest, Map<String, Object>) - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServerProvider
-
Given a request, identify the build server that made the request.
- getBuildStatus() - Method in class com.atlassian.bitbucket.build.server.operations.BuildStatusActionRequest
- getBuildStatusEnricher() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
- getBulkContentCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginBulkContentCommandFactory
, used to createcommands
tailored for getting content from a repository in bulk. - getClient() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
- getCloneUrl(Repository, ApplicationUser) - Method in interface com.atlassian.bitbucket.scm.ScmProtocol
-
Retrieves the clone URL specific to this protocol for the supplied
repository
and, if appropriate, tailored to thesupplied user
. - getCommand() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationSuccessContext
- getCommand() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getCommand() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext
- getCommandBuilderFactory() - Method in class com.atlassian.bitbucket.scm.AbstractScm
- getCommandBuilderFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginCommandBuilderFactory
, used to createcommand builders
for custom SCM commands. - getCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginCommandFactory
, used to createcommands
for performing standard SCM operations such as retrieving commits and viewing diffs. - getCommit() - Method in interface com.atlassian.bitbucket.hook.repository.CommitAddedDetails
- getCommit() - Method in interface com.atlassian.bitbucket.hook.repository.CommitRemovedDetails
- getCompareCommandFactory() - Method in class com.atlassian.bitbucket.scm.AbstractScm
- getCompareCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginCompareCommandFactory
, used to createcommands
tailored for comparing refs. - getContentType() - Method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- getContext() - Method in interface com.atlassian.bitbucket.repository.RefMetadataContext
- getCredentials() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getCurrentHierarchyId() - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Returns the current hierarchy ID the importer is importing.
- getDefaultBranch() - Method in class com.atlassian.bitbucket.scm.ForkCommandParameters
-
Retrieves the default branch that should be set for the fork after it's created.
- getDefaultBranch(Repository) - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves the configured default branch for the specified repository.
- getDescriptionKey() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategy
-
A short, descriptive summary of what the strategy does, suitable for display in a space-constrained UI.
- getEntityMapping(MigrationEntityType<T>) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Returns the
EntityExportMapping
of theMigrationEntityType
for this context. - getEntityMapping(MigrationEntityType<T>) - Method in interface com.atlassian.bitbucket.migration.ImportContext
-
Returns the
EntityImportMapping
of theMigrationEntityType
for this context. - getEnvironment() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getEnvironment() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext
- getErrorHtml(Map<String, String[]>, Map<String, Collection<String>>) - Method in interface com.atlassian.bitbucket.ui.PluginFormFragments
- getExitCodeCallback() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getExporter() - Method in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- getExportId(K) - Method in interface com.atlassian.bitbucket.migration.EntityExportMapping
-
Given a local ID, calculate its corresponding export ID.
- getExportId(K) - Method in interface com.atlassian.bitbucket.migration.EntityImportMapping
-
Given a
localId
, return its correspondingexportId
. - getExtendedCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves an
optional command factory
, which enables additional system features for SCMs which implement its commands. - getFeatureKey() - Method in interface com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessor
-
The feature key of the
SettingsKey
that this processor is registered to. - getFeatures() - Method in class com.atlassian.bitbucket.scm.AbstractScm
- getFeatures() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves the
features
that are supported by this SCM. - getFilterChain() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getFlag() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategy
-
Retrieves a flag, or series of flags, which would be familiar to users of the SCM to help identify what the strategy does by relating it to well-known command line functionality.
- getFork() - Method in class com.atlassian.bitbucket.scm.ForkCommandParameters
-
Retrieves the fork repository, which is expected to have already been created in the database and have a valid
ID
. - getForkIds() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters
-
Provides the
IDs
of all repositories that were forked from the repository being deleted which have not, themselves, been deleted. - getFreeSpace() - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Returns the number of bytes of free space available in the file store.
- getFromRef() - Method in interface com.atlassian.bitbucket.scm.pull.MinimalPullRequest
-
Retrieves the
ref
that has been requested to be merged. - getFromRepository() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getHeader(String) - Method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- getHelpTopic() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategies
-
Retrieves a help topic, which is used to
look up a URL
for additional documentation about the available merge strategies. - getId() - Method in interface com.atlassian.bitbucket.build.server.operations.BuildStatusAction
-
The identifier for this action.
- getId() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
-
Identifier that uniquely identifies this build server.
- getId() - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
- getId() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategy
-
Retrieves an SCM-unique identifier for the merge strategy.
- getId() - Method in interface com.atlassian.bitbucket.scm.pull.MinimalPullRequest
-
Retrieves the pull request's ID, relative to the
target
repository
. - getId() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a unique identifier for the SCM that is provided by the plugin.
- getImporter() - Method in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- getIntegrityCheckCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginIntegrityCheckCommandFactory
, used to createcommands
that perform integrity checks on SCMs. - getLatestPullRequestId(Repository) - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckContext
-
Allows SCMs to obtain the highest / latest pull request found in the database
- getLocalId(String) - Method in interface com.atlassian.bitbucket.migration.EntityImportMapping
-
Given an
exportId
, return its correspondinglocalId
. - getLogLink(RepositoryBuildStatus) - Method in interface com.atlassian.bitbucket.build.server.BuildStatusEnricher
- getMaxCommitIds() - Method in interface com.atlassian.bitbucket.scm.pull.BulkRescopeContext
- getMergeRequest() - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryMergeRequestCheckContext
- getMergeStrategies() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a set of
merge strategies
supported by the SCM. - getMessage() - Method in interface com.atlassian.bitbucket.build.server.operations.ActionResult
-
Optional additional message relating to the action invocation.
- getMessage() - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequest
-
Retrieves the proposed commit message, if one was provided.
- getMessage() - Method in interface com.atlassian.bitbucket.scm.ScmStatus
-
Retrieves a message describing the SCM's status.
- getMetadata(RefMetadataContext) - Method in interface com.atlassian.bitbucket.repository.RefMetadataProvider
- getMethod() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getMethod() - Method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- getMirrorCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginMirrorCommandFactory
, used to createcommands
tailored for mirroring repositories. - getModule() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationFailureHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.auth.SshAuthenticationSuccessHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.build.server.PluginBuildServerProviderModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.filestore.PluginFileStoreModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.home.HomeUpdateHandlerModuleDescriptor
-
Retrieves the
HomeUpdateHandler
for this descriptor. - getModule() - Method in class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.idx.CommitIndexerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.idx.CommitPropertyConfigurationModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.permission.PermissionVoterProviderModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.scm.ScmModuleDescriptor
-
Retrieves the
Scm
instance for this descriptor. - getModule() - Method in class com.atlassian.bitbucket.scm.ScmProtocolModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.scm.ScmRequestCheckModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.scm.ScmUrlFormatterModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
-
Retrieve the
module
for this descriptor. - getModule() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandFactoryModuleDescriptor
- getModule() - Method in class com.atlassian.bitbucket.user.UserErasureModuleDescriptor
- getName() - Method in interface com.atlassian.bitbucket.build.server.operations.BuildStatusAction
-
The user readable name of the action, to display in the UI.
- getName() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
- getName() - Method in interface com.atlassian.bitbucket.migration.MigrationEntityType
- getName() - Method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- getName() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a well-known name for the SCM that is provided by the plugin.
- getName() - Method in interface com.atlassian.bitbucket.scm.ScmProtocol
- getNameKey() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategy
-
A short, human-readable name for the strategy, like "Fast-forward", suitable for display in a space- constrained UI.
- getNamespace() - Method in interface com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessor
-
The namespace of the
SettingsKey
that this processor is registered to. - getNewDir() - Method in interface com.atlassian.bitbucket.home.HomeUpdate
-
The absolute path to where the home directory currently is.
- getNewFromHash() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getNewToHash() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getOldDir() - Method in interface com.atlassian.bitbucket.home.HomeUpdate
-
The absolute path to where the home directory used to be.
- getOldFromHash() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getOldToHash() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getOperations(RepositoryBuildStatus) - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
A collection containing the actions that can be performed by the currently authenticated user.
- getParameter(String) - Method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- getPath() - Method in interface com.atlassian.bitbucket.migration.ArchiveSource
-
Get the path of this archive source.
- getPath() - Method in interface com.atlassian.bitbucket.migration.EntrySource
- getPathInfo() - Method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- getPathSuffix() - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- getPermission() - Method in interface com.atlassian.bitbucket.permission.PermissionCheck
- getPreviousStatus() - Method in class com.atlassian.bitbucket.scm.event.ScmStatusChangedEvent
- getProjectKey() - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- getProperties() - Method in class com.atlassian.bitbucket.auth.AuthenticationResult
- getProperties() - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication
- getPropertiesToPreload(Repository) - Method in interface com.atlassian.bitbucket.idx.CommitPropertyConfiguration
- getPublicKey() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationContext
- getPullRequest() - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequest
- getPullRequestCommandFactory() - Method in class com.atlassian.bitbucket.scm.AbstractScm
- getPullRequestCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginPullRequestCommandFactory
, used to createcommands
tailored for use supporting pull requests. - getPullRequestId() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getPullRequests() - Method in class com.atlassian.bitbucket.scm.pull.UpdatePullRequestRefsCommandParameters
- getRef() - Method in interface com.atlassian.bitbucket.hook.repository.CommitAddedDetails
- getRef() - Method in interface com.atlassian.bitbucket.hook.repository.CommitRemovedDetails
- getRefCommandFactory() - Method in class com.atlassian.bitbucket.scm.AbstractScm
- getRefCommandFactory() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a
PluginRefCommandFactory
, used to createcommands
tailored for creatingbranches
andtags
. - getRefs() - Method in interface com.atlassian.bitbucket.repository.RefMetadataContext
- getRepositories() - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckContext
-
Allows SCMs to request a
stream
of repositories to check for consistency. - getRepositories() - Method in class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- getRepository() - Method in interface com.atlassian.bitbucket.idx.IndexingContext
- getRepository() - Method in interface com.atlassian.bitbucket.repository.RefMetadataContext
- getRepository() - Method in class com.atlassian.bitbucket.scm.AbstractRepositoryScmRequest
- getRepository() - Method in class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters
- getRepository() - Method in interface com.atlassian.bitbucket.scm.ScmRequest
- getRepository() - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest
- getRepositorySlug() - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- getRequest() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getRescopeContext() - Method in class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters
- getResource() - Method in interface com.atlassian.bitbucket.permission.PermissionCheck
-
The resource that the permission check applies to.
- getResponse() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getResult() - Method in interface com.atlassian.bitbucket.hook.repository.PreRepositoryHookCommitCallback
-
Returns the outcome of the callback's processing of commits.
- getResult() - Method in interface com.atlassian.bitbucket.permission.PermissionCheck
- getRpcUrl() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
- getScm() - Method in class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
-
Retrieves the
ID
of the SCM this handler adds support for, ornull
if this handler does not, of itself, add support for any specific SCM. - getScm() - Method in class com.atlassian.bitbucket.scm.event.ScmEvent
-
Retrieves the
Scm
raising the event. - getSettings() - Method in class com.atlassian.bitbucket.hook.repository.RepositoryHookContext
- getSettings() - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryMergeRequestCheckContext
- getSettingsKey() - Method in class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- getState() - Method in interface com.atlassian.bitbucket.build.server.operations.ActionResult
-
Returns the state of the action.
- getStatus() - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves the current
status
for the SCM. - getStatus() - Method in interface com.atlassian.bitbucket.shutdown.ShutdownHook
- getStderr() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getStderr() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext
- getStdin() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getStdin() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext
- getStdout() - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- getStdout() - Method in class com.atlassian.bitbucket.ssh.command.SshCommandContext
- getStrategies() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategies
-
Retrieves the set of supported
merge strategies
. - getToRef() - Method in interface com.atlassian.bitbucket.scm.pull.MinimalPullRequest
-
Retrieves the
ref
targeted for the merge, if the pull request is accepted. - getToRepository() - Method in interface com.atlassian.bitbucket.scm.pull.PullRequestRescope
- getTypeId() - Method in interface com.atlassian.bitbucket.build.server.PluginBuildServer
-
Identifier of the type of the build server.
- getURI() - Method in interface com.atlassian.bitbucket.build.server.operations.ActionResult
-
Optional URI that can contain more information about the request.
- getUrlFormatter() - Method in class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
-
Retrieves the
ScmUrlFormatter
which should be used to format clone URLs targeting this handler. - getUser() - Method in class com.atlassian.bitbucket.auth.AuthenticationResult
- getUser() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationSuccessContext
- getUser() - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication
- getUser() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationSuccessContext
- getUser() - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest
- getUsername() - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
- getUsername() - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationContext
- getVersion() - Method in interface com.atlassian.bitbucket.scm.pull.MinimalPullRequest
-
Retrieves the pull request's current version.
- getViewHtml() - Method in interface com.atlassian.bitbucket.ui.PluginFormFragments
- getWeight() - Method in class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor
- getWeight() - Method in interface com.atlassian.bitbucket.util.Weighted
- GRANT - Enum constant in enum class com.atlassian.bitbucket.permission.PermissionVote
H
- handleRequest() - Method in interface com.atlassian.bitbucket.scm.ScmRequest
-
Performs whatever logic is necessary to handle the request.
- hasErrors() - Method in interface com.atlassian.bitbucket.migration.ExportContext
- hasErrors() - Method in interface com.atlassian.bitbucket.migration.ImportContext
- hasForks() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters
-
Retrieves a flag indicating whether the deleted repository has
forks
. - hashCode() - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication
- hashCode() - Method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- hashCode() - Method in class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- hasSection(Path) - Method in interface com.atlassian.bitbucket.migration.ExportContext
-
Does this
export context
contain asection
with the given path - hasUser() - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest
- HomeUpdate - Interface in com.atlassian.bitbucket.home
- HomeUpdateHandler - Interface in com.atlassian.bitbucket.home
-
Invoked when the
shared home directory
is updated. - HomeUpdateHandlerModuleDescriptor - Class in com.atlassian.bitbucket.home
- HomeUpdateHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.home.HomeUpdateHandlerModuleDescriptor
- HomeUpdateHandlerModuleDescriptor(ModuleFactory, int) - Constructor for class com.atlassian.bitbucket.home.HomeUpdateHandlerModuleDescriptor
- HttpAuthenticationContext - Interface in com.atlassian.bitbucket.auth
-
Context class holding all details relevant for authentication processing by
HttpAuthenticationHandler
modules. - HttpAuthenticationFailureContext - Interface in com.atlassian.bitbucket.auth
-
Context class holding all details relevant for authentication failure processing by
HttpAuthenticationFailureHandler
modules. - HttpAuthenticationFailureHandler - Interface in com.atlassian.bitbucket.auth
-
Handler for authentication failure over HTTP.
- HttpAuthenticationFailureHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
- HttpAuthenticationFailureHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandlerModuleDescriptor
- HttpAuthenticationHandler - Interface in com.atlassian.bitbucket.auth
-
Implementations may also implement
HttpLogoutHandler
, in which case they'll get a callback when the user logs out. - HttpAuthenticationHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
- HttpAuthenticationHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- HttpAuthenticationSuccessContext - Interface in com.atlassian.bitbucket.auth
-
Context class holding all details relevant for authentication success processing by
HttpAuthenticationSuccessHandler
modules. - HttpAuthenticationSuccessHandler - Interface in com.atlassian.bitbucket.auth
-
Handler that is called when a user successfully authenticates with the system over HTTP.
- HttpAuthenticationSuccessHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
- HttpAuthenticationSuccessHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandlerModuleDescriptor
- HttpLogoutHandler - Interface in com.atlassian.bitbucket.auth
-
Interface that
http-auth-handler
modules can optionally implement to receive callbacks on logout. - HttpRequestDetails - Class in com.atlassian.bitbucket.scm.http
-
Details about the HTTP request to be serviced.
- HttpScmProtocol - Interface in com.atlassian.bitbucket.scm.http
- HttpScmRequest - Interface in com.atlassian.bitbucket.scm.http
-
Handles an HTTP request from an SCM client (e.g.
- HttpScmRequestHandler - Interface in com.atlassian.bitbucket.scm.http
-
Plugin point for providing handlers for HTTP requests for SCM hosting operations.
- HttpScmRequestHandlerModuleDescriptor - Class in com.atlassian.bitbucket.scm.http
-
Module descriptor for providing
HttpScmRequestHandler
implementations. - HttpScmRequestHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.http.HttpScmRequestHandlerModuleDescriptor
I
- i18nService - Variable in class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- identity() - Static method in interface com.atlassian.bitbucket.io.IoFunction
-
Returns a function that always returns its input argument.
- IDLE - Enum constant in enum class com.atlassian.bitbucket.shutdown.ShutdownHookStatus
-
Indicates that the component does not have any currently running tasks and hence safe to terminate.
- ImportContext - Interface in com.atlassian.bitbucket.migration
-
Allows the consumption of entries contained in an import archive.
- Importer - Interface in com.atlassian.bitbucket.migration
-
Data Center Migration Importer SPI
- IndexingContext - Interface in com.atlassian.bitbucket.idx
-
Used to by
CommitIndexer
s to store state during the indexing process. - init(Plugin, Element) - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- init(Plugin, Element) - Method in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- init(Plugin, Element) - Method in class com.atlassian.bitbucket.permission.PermissionVoterProviderModuleDescriptor
- init(Plugin, Element) - Method in class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
- init(Plugin, Element) - Method in class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor
- InsufficientDiskSpaceException - Exception in com.atlassian.bitbucket.migration
-
Thrown when performing a migration of a repository and there is not enough disk space.
- InsufficientDiskSpaceException(KeyedMessage) - Constructor for exception com.atlassian.bitbucket.migration.InsufficientDiskSpaceException
- IntegrityCheckCallback - Interface in com.atlassian.bitbucket.scm.integrity
-
Used by an SCM to report integrity check results as they become available.
- IntegrityCheckContext - Interface in com.atlassian.bitbucket.scm.integrity
-
Allows an SCM to obtain additional information required to perform integrity checks
- IoBiConsumer<T,
U> - Interface in com.atlassian.bitbucket.io - IoConsumer<T> - Interface in com.atlassian.bitbucket.io
- IoFunction<T,
R> - Interface in com.atlassian.bitbucket.io - IoSupplier<T> - Interface in com.atlassian.bitbucket.io
- isAddedToRepository() - Method in interface com.atlassian.bitbucket.hook.repository.CommitAddedDetails
- isAsyncSupported() - Method in interface com.atlassian.bitbucket.scm.http.HttpScmRequest
-
Allows requests to indicate whether they support using Servlet 3's
asynchronous execution
. - isAuthorizationRequired() - Method in interface com.atlassian.bitbucket.build.server.operations.BuildOperations
-
Indicated whether or not the currently authenticated user has authorized Bitbucket to act on their behalf with this build server.
- isAuthorizationRequired() - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
Check whether or not Bitbucket has been authorized to act on this build server on the current user's behalf.
- isAvailable() - Method in interface com.atlassian.bitbucket.scm.ScmStatus
-
Retrieves a flag indicating whether the SCM is available to process requests.
- isCaptchaSupported() - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- isDefault() - Method in interface com.atlassian.bitbucket.scm.PluginMergeStrategy
-
Retrieves a flag indicating whether this strategy is the SCM's default, the strategy it will use if no explicit strategy is requested.
- isDryRun() - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequest
-
Retrieves a flag indicating whether this request is for a
canMerge
check or a realmerge
. - isEmpty(Repository) - Method in interface com.atlassian.bitbucket.scm.Scm
-
Retrieves a flag indicating whether the specified
Repository
is empty, from the perspective of the SCM implementation. - isEnabledForRepository(Repository) - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
- isError(String, int, String, Throwable) - Method in class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- isLastForkOfOrigin() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters
-
Returns whether the repository that is being deleted was the last fork of the origin repository.
- isLastInHierarchy() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters
-
Retrieves a flag indicating whether this repository was the last in its
hierarchy
, allowing the SCM to perform any additional cleanup that is necessary when an entire hierarchy is deleted. - isRemovedFromRepository() - Method in interface com.atlassian.bitbucket.hook.repository.CommitRemovedDetails
- isSynchronous() - Method in class com.atlassian.bitbucket.hook.repository.PostRepositoryHookContext
- isVetoed() - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequest
- isWrite() - Method in class com.atlassian.bitbucket.scm.AbstractRepositoryScmRequest
- isWrite() - Method in interface com.atlassian.bitbucket.scm.ScmRequest
J
- JsonRenderer - Interface in com.atlassian.bitbucket.json
-
Renders an object to a JSON string.
L
- lastForkOfOrigin() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters.Builder
- lastInHierarchy() - Method in class com.atlassian.bitbucket.scm.DeleteCommandParameters.Builder
- lastModified(Repository, LastModifiedCommandParameters, LastModifiedCallback) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Streams the latest commit to modify each file in the specified
path
, using the providedcommit
as the starting point for the traversal. - logout(ApplicationUser, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.bitbucket.auth.HttpLogoutHandler
-
Implementations should clean up external resources if they need to.
M
- merge(PullRequest, PullRequestMergeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
- merge(Repository, MergeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Merges the specified
{@link MergeCommandParameters#getFromCommitId() fromCommitId}
into the specified{@link MergeCommandParameters#getToBranch() toBranch}
. - merge(PullRequestRescope, String) - Method in interface com.atlassian.bitbucket.scm.pull.BulkRescopeContext
-
Marks the rescope as
remotely merging
the associated pull request. - MergeRequest - Interface in com.atlassian.bitbucket.scm.pull
-
Represents a request to merge a pull request, intended to allow
RepositoryMergeCheck
s to validate the intended merge and, potentially,MergeRequest.veto(java.lang.String, java.lang.String)
it. - MergeRequestCheckService - Interface in com.atlassian.bitbucket.scm.pull
-
A service that checks preconditions for pull request merges by applying
RepositoryMergeCheck
s, which can be supplied by plugins, to determine whether merges should performed. - METHOD_BASIC - Static variable in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
-
BASIC authentication.
- METHOD_FORM - Static variable in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
-
FORM-based authentication.
- METHOD_TOKEN - Static variable in interface com.atlassian.bitbucket.auth.HttpAuthenticationContext
-
Authentication based on some kind of token (not username/password based).
- MigrationEntityType<K> - Interface in com.atlassian.bitbucket.migration
-
Represents an entity type that can be exported by the
exporter
SPI. - MigrationHandlerModuleDescriptor - Class in com.atlassian.bitbucket.migration
- MigrationHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- MinimalPullRequest - Interface in com.atlassian.bitbucket.scm.pull
-
Describes a minimal
pull request
, providing only the ID, version andrefs
. - module - Variable in class com.atlassian.bitbucket.hook.BaseScmHookModuleDescriptor
- ModuleDescriptorUtils - Class in com.atlassian.bitbucket.util
-
Utility methods for working with plugin
ModuleDescriptors
.
N
- NOT_AUTHENTICATED - Enum constant in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Indicates that authentication failed or no attempt to authenticate was made.
O
- ofName(String) - Static method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- ofScope(Scope) - Static method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- ofServletRequest(HttpServletRequest) - Static method in class com.atlassian.bitbucket.scm.http.HttpRequestDetails
- onAfterIndexing(IndexingContext) - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
-
Called after the last commit has been processed to allow the indexer to perform any cleanup it needs.
- onArchiveEntry(ImportContext, ArchiveSource) - Method in interface com.atlassian.bitbucket.migration.Importer
-
Called when an archive entry is encountered within an archive.
- onAuthenticationFailure(HttpAuthenticationFailureContext) - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandler
-
Callback method that is called by the system on authentication failure.
- onAuthenticationFailure(SshAuthenticationFailureContext) - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationFailureHandler
-
A method called back on SSH authentication failure.
- onAuthenticationSuccess(HttpAuthenticationSuccessContext) - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandler
-
Callback method that is called by the system on authentication success over HTTP.
- onAuthenticationSuccess(SshAuthenticationSuccessContext) - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationSuccessHandler
-
Callback method that is called by the system on authentication success over SSH.
- onBeforeIndexing(IndexingContext) - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
-
Called before the first commit is processed to allow the indexer to perform any setup it needs.
- onCancel(String, int, String, Throwable) - Method in class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- onCommitAdded(Commit, IndexingContext) - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
-
Called for each new commit that is added to the repository.
- onCommitAdded(CommitAddedDetails) - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryHookCommitCallback
- onCommitRemoved(Commit, IndexingContext) - Method in interface com.atlassian.bitbucket.idx.CommitIndexer
-
Called for each existing commit that is removed from the repository.
- onCommitRemoved(CommitRemovedDetails) - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryHookCommitCallback
- onEnd() - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryHookCommitCallback
-
Callback method that is called after all commits have been offered to the callback.
- onEnd(PreRepositoryHookContext, T, RepositoryHookResult) - Method in interface com.atlassian.bitbucket.hook.repository.PreRepositoryHook
-
Callback method that is called after all registered and enabled hooks have been called
- onEnd(ExportContext) - Method in interface com.atlassian.bitbucket.migration.Exporter
-
Called after the export is finished.
- onEnd(ImportContext) - Method in interface com.atlassian.bitbucket.migration.Importer
-
Called after the import has finished.
- onEntry(ImportContext, EntrySource) - Method in interface com.atlassian.bitbucket.migration.Importer
- onError(KeyedMessage) - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckCallback
-
Called when the SCM encounters a problem that cannot be expressed in terms of pull requests or repositories.
- onError(Repository, KeyedMessage) - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckCallback
-
Called when the SCM encounters a problem while checking the integrity of a specific repository.
- onError(String, int, String, Throwable) - Method in class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- onExit(int) - Method in interface com.atlassian.bitbucket.scm.ssh.ExitCodeCallback
- onExit(int) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext
- onExit(String, int, String, Throwable) - Method in class com.atlassian.bitbucket.scm.DefaultCommandExitHandler
- onExtraPullRequest(Repository, long) - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckCallback
-
Invoked when the SCM encounters a pull request that does not exist according to the host application.
- onMissingPullRequest(Repository, long) - Method in interface com.atlassian.bitbucket.scm.integrity.IntegrityCheckCallback
-
Invoked when the required SCM-level data for a pull request is missing.
- onStart() - Method in interface com.atlassian.bitbucket.hook.repository.RepositoryHookCommitCallback
-
Callback method that is called before the commits details are provided to
RepositoryHookCommitCallback.onCommitAdded(CommitAddedDetails)
andRepositoryHookCommitCallback.onCommitRemoved(CommitRemovedDetails)
- onStart(ExportContext) - Method in interface com.atlassian.bitbucket.migration.Exporter
-
Called before the export is started.
- onStart(ImportContext) - Method in interface com.atlassian.bitbucket.migration.Importer
-
Called after the export is started.
- OptionalPluginInformationProvider - Interface in com.atlassian.bitbucket.plugin
-
Allows stash core to query the state of optional plugins.
P
- patch(Repository, PatchCommandParameters, TypeAwareOutputSupplier) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Streams a patch of the specified repository for a given commit or commit range.
- performAction(BuildStatusActionRequest) - Method in interface com.atlassian.bitbucket.build.server.operations.PluginBuildServerClient
-
Start the action.
- performAuthentication(HttpAuthenticationContext) - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationHandler
-
Invoked by the system when authentication is attempted over HTTP.
- performAuthentication(SshAuthenticationContext) - Method in interface com.atlassian.bitbucket.auth.SshAuthenticationHandler
-
Invoked by the system when authentication is attempted over SSH.
- PermissionCheck - Interface in com.atlassian.bitbucket.permission
-
The permission to check and optionally the resource on which to check it.
- PermissionVote - Enum Class in com.atlassian.bitbucket.permission
- PermissionVoter - Interface in com.atlassian.bitbucket.permission
-
A
PermissionVoter
may be used to determine access restrictions for application resources. - PermissionVoterProvider - Interface in com.atlassian.bitbucket.permission
-
Provides
PermissionVoter
for aauthentication
in addition to those already granted to them through direct grant, group membership and default permissions. - PermissionVoterProviderModuleDescriptor - Class in com.atlassian.bitbucket.permission
-
Module descriptor for providing
PermissionVoterProvider
implementations. - PermissionVoterProviderModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.permission.PermissionVoterProviderModuleDescriptor
- PluginBuildServer - Interface in com.atlassian.bitbucket.build.server
-
An abstraction describing a specific instance of a CI server and methods for Bitbucket Server to interact with it.
- PluginBuildServerClient - Interface in com.atlassian.bitbucket.build.server.operations
-
An interface for Bitbucket to interact with the remote CI tool in order to perform actions (e.g.
- PluginBuildServerProvider - Interface in com.atlassian.bitbucket.build.server
-
Build Server Provider SPI.
- PluginBuildServerProviderModuleDescriptor - Class in com.atlassian.bitbucket.build.server
-
Module descriptor for providing
PluginBuildServerProvider
implementations. - PluginBuildServerProviderModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.build.server.PluginBuildServerProviderModuleDescriptor
- PluginBulkContentCommandFactory - Interface in com.atlassian.bitbucket.scm.bulk
-
A factory for creating commands which operate on bulk content.
- PluginCommandBuilderFactory - Interface in com.atlassian.bitbucket.scm
-
When implemented by an
SCM
, allows theScmService
to provide anScmCommandBuilder
that can be used to build custom commands for advanced functionality. - PluginCommandFactory - Interface in com.atlassian.bitbucket.scm
-
Provides backing functionality for the
ScmCommandFactory
. - PluginCompareCommandFactory - Interface in com.atlassian.bitbucket.scm.compare
-
Specialized command factory to compare two refs.
- PluginExtendedCommandFactory - Interface in com.atlassian.bitbucket.scm
-
Provides backing functionality for the
ScmExtendedCommandFactory
. - PluginFileStore - Interface in com.atlassian.bitbucket.filestore
-
A service provider interface (SPI) that allows plugins to provide their own implementation of a file store for Bitbucket Data Center to use.
- PluginFileStoreModuleDescriptor - Class in com.atlassian.bitbucket.filestore
-
Module descriptor for providing
PluginFileStore
implementations. - PluginFileStoreModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.filestore.PluginFileStoreModuleDescriptor
- PluginFormFragments - Interface in com.atlassian.bitbucket.ui
-
Collates a collection of enabled
ContextualFormFragment
s plugin modules defined for a particular form. - PluginFormFragmentsFactory - Interface in com.atlassian.bitbucket.ui
-
Factory for
PluginFormFragments
. - PluginIntegrityCheckCommandFactory - Interface in com.atlassian.bitbucket.scm.integrity
-
A Command factory for SCM integrity checks.
- PluginMergeStrategies - Interface in com.atlassian.bitbucket.scm
-
Describes an SPI for allowing SCMs to expose user-selectable merge strategies.
- PluginMergeStrategy - Interface in com.atlassian.bitbucket.scm
-
Describes a single merge strategy, which controls how commits from one line of development are applied to another.
- PluginMirrorCommandFactory - Interface in com.atlassian.bitbucket.scm.mirror
- PluginPullRequestCommandFactory - Interface in com.atlassian.bitbucket.scm.pull
- PluginRefCommandFactory - Interface in com.atlassian.bitbucket.scm.ref
-
Specialized command factory for dealing with
refs
. - PostRepositoryHook<T extends com.atlassian.bitbucket.hook.repository.RepositoryHookRequest> - Interface in com.atlassian.bitbucket.hook.repository
-
Hook that is called after changes to 1 or more refs have been made.
- PostRepositoryHookContext - Class in com.atlassian.bitbucket.hook.repository
-
RepositoryHookContext
specialization that is provided toPostRepositoryHook
hooks - PostRepositoryHookContext(Settings, boolean) - Constructor for class com.atlassian.bitbucket.hook.repository.PostRepositoryHookContext
- postUpdate(PostRepositoryHookContext, T) - Method in interface com.atlassian.bitbucket.hook.repository.PostRepositoryHook
-
Callback method that is called after a request to update one or more
refs
is completed. - PreRepositoryHook<T extends com.atlassian.bitbucket.hook.repository.RepositoryHookRequest> - Interface in com.atlassian.bitbucket.hook.repository
-
Hook that is called for all veto-able changes to 1 or more Refs.
- PreRepositoryHookCommitCallback - Interface in com.atlassian.bitbucket.hook.repository
- PreRepositoryHookContext - Class in com.atlassian.bitbucket.hook.repository
-
RepositoryHookContext
specialization that is provided toPreRepositoryHook
hooks - PreRepositoryHookContext(Settings) - Constructor for class com.atlassian.bitbucket.hook.repository.PreRepositoryHookContext
- preUpdate(PreRepositoryHookContext, T) - Method in interface com.atlassian.bitbucket.hook.repository.PreRepositoryHook
-
Callback method that is called just before a request to update one or more
refs
is completed. - process(RestrictionProcessingRequest) - Method in interface com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessor
-
Performs post-processing for
ProjectSettingsRestriction
s after they are created. - processProperties(Map<String, Map<String, Object>>) - Method in interface com.atlassian.bitbucket.idx.CommitPropertyConfiguration
-
Go through the provided
commitIdToProperties
and process each of the commit ID's properties that are supplied. - PROJECT - Static variable in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- ProjectSettingsRestrictionProcessor - Interface in com.atlassian.bitbucket.settingsrestriction
-
Post processing functionality for
ProjectSettingsRestriction
s. - ProjectSettingsRestrictionProcessorModuleDescriptor - Class in com.atlassian.bitbucket.settingsrestriction
-
Module descriptor for providing
ProjectSettingsRestrictionProcessor
implementations. - ProjectSettingsRestrictionProcessorModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
- properties(Map<String, Serializable>) - Method in class com.atlassian.bitbucket.auth.AuthenticationResult.Builder
- properties(Map<String, Serializable>) - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication.Builder
- property(String, Serializable) - Method in class com.atlassian.bitbucket.auth.AuthenticationResult.Builder
- property(String, Serializable) - Method in class com.atlassian.bitbucket.auth.SimpleAuthentication.Builder
- PROTOCOL - Static variable in interface com.atlassian.bitbucket.scm.http.HttpScmProtocol
-
Protocol name used predominantly for descriptive purposes in logging and analytics.
- PROTOCOL - Static variable in interface com.atlassian.bitbucket.scm.ssh.SshScmProtocol
-
Protocol name used predominantly for descriptive purposes in logging and analytics.
- provideProperties(CommentPropertyContext) - Method in interface com.atlassian.bitbucket.comment.CommentPropertyProvider
-
Provide properties to the given
context
. - provideProperties(CommentPropertyContext) - Method in class com.atlassian.bitbucket.comment.FlatteningCommentPropertyProvider
- provideProperties(PullRequestPropertyContext) - Method in interface com.atlassian.bitbucket.pull.PullRequestPropertyProvider
-
Provide properties to the given
context
. - provideProperties(PullRequest, PullRequestMergeability) - Method in interface com.atlassian.bitbucket.pull.PullRequestMergeabilityPropertyProvider
-
Provide properties for the provided pull request and mergeability.
- PullRequestDeleteCommandParameters - Class in com.atlassian.bitbucket.scm.pull
- PullRequestDeleteCommandParameters.Builder - Class in com.atlassian.bitbucket.scm.pull
- PullRequestMergeabilityPropertyProvider - Interface in com.atlassian.bitbucket.pull
-
Provides properties to
PullRequestMergeability
. - PullRequestPropertyContext - Interface in com.atlassian.bitbucket.pull
-
Allows iterating and adding
properties
to pull requests. - PullRequestPropertyProvider - Interface in com.atlassian.bitbucket.pull
-
Provides properties to Stash
pull requests
. - PullRequestRescope - Interface in com.atlassian.bitbucket.scm.pull
-
Describes how a
pull request
is going to be rescoped. - pullRequests(PullRequest, PullRequest...) - Method in class com.atlassian.bitbucket.scm.pull.UpdatePullRequestRefsCommandParameters.Builder
- pullRequests(Iterable<PullRequest>) - Method in class com.atlassian.bitbucket.scm.pull.UpdatePullRequestRefsCommandParameters.Builder
- push(Repository, PushCommandParameters, PushCallback) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Pushes the repository to the
URL specified in the parameters
. - put(String, Object) - Method in interface com.atlassian.bitbucket.idx.IndexingContext
-
Sets a key-value pair in the context.
R
- rawFile(Repository, RawFileCommandParameters, TypeAwareOutputSupplier) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams the raw bytes for the requested file at the specified commit to
OutputStream
returned by the providedsupplier
. - read(IoConsumer<EntrySource>) - Method in interface com.atlassian.bitbucket.migration.ArchiveSource
-
Filter and read each file in the archive.
- read(IoConsumer<EntrySource>, Predicate<String>) - Method in interface com.atlassian.bitbucket.migration.ArchiveSource
-
Filter and read each file in the archive.
- read(IoConsumer<InputStream>) - Method in interface com.atlassian.bitbucket.migration.EntrySource
-
Read the file represented by this entry.
- readFile(ReadFileRequest) - Method in interface com.atlassian.bitbucket.filestore.PluginFileStore
-
Read a file from the file store.
- RefMetadataContext - Interface in com.atlassian.bitbucket.repository
-
The context in which the metadata is being retrieved for a given collection of
refs
- RefMetadataProvider<T> - Interface in com.atlassian.bitbucket.repository
-
A plugin point for associating arbitrary metadata with a
Ref
. - refs(Repository, RefsCommandParameters, RefCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams all of the refs in the specified repository.
- registerCommitCallback(PreRepositoryHookCommitCallback, RepositoryHookCommitFilter, RepositoryHookCommitFilter...) - Method in class com.atlassian.bitbucket.hook.repository.PreRepositoryHookContext
-
Registers a callback to receive more information about commits added or removed.
- registerCommitCallback(RepositoryHookCommitCallback, RepositoryHookCommitFilter, RepositoryHookCommitFilter...) - Method in class com.atlassian.bitbucket.hook.repository.PostRepositoryHookContext
-
Registers a callback to receive more information about commits added or removed.
- remove(String) - Method in interface com.atlassian.bitbucket.idx.IndexingContext
-
Removes a key-value pair from the context.
- REMOVED_FROM_ANY_REF - Enum constant in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Any commit removed from any ref.
- REMOVED_FROM_REPOSITORY - Enum constant in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Any commit that is removed from the branch or tag and no longer referenced in the repository.
- render(Object, Map<String, Object>) - Method in interface com.atlassian.bitbucket.json.JsonRenderer
-
Renders an object to JSON given any supplied options.
- repository - Variable in class com.atlassian.bitbucket.scm.AbstractRepositoryScmRequest
- repository(Repository) - Method in class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters.Builder
- REPOSITORY - Static variable in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- RepositoryHookCommitCallback - Interface in com.atlassian.bitbucket.hook.repository
-
A callback to receive more information about commits added or removed in a
RepositoryHookRequest
. - RepositoryHookCommitFilter - Enum Class in com.atlassian.bitbucket.hook.repository
-
Describes the type of commit details a repository-hook
callback
is interested in. - RepositoryHookContext - Class in com.atlassian.bitbucket.hook.repository
- RepositoryHookContext(Settings) - Constructor for class com.atlassian.bitbucket.hook.repository.RepositoryHookContext
- RepositoryMergeCheck - Interface in com.atlassian.bitbucket.hook.repository
-
Used to enforce a specific precondition for a pull request merge operation.
- RepositoryMergeRequestCheckContext - Interface in com.atlassian.bitbucket.hook.repository
-
In addition to the normal
MergeRequest
parameters, will have additional settings which can be configured per-repository. - repositorySize(Repository, RepositorySizeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Calculates the
size
for the specified repository. - RepositoryUrlFragment - Class in com.atlassian.bitbucket.scm.http
-
Utility class for parsing project keys and repository slugs from scm urls - HTTP and SSH.
- rescopeContext(BulkRescopeContext) - Method in class com.atlassian.bitbucket.scm.pull.BulkRescopeCommandParameters.Builder
- resolveCommits(Repository, ResolveCommitsCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Resolves revisions provided on
parameters
to the referenced commit ID. - resolveRef(Repository, ResolveRefCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Resolves the specified
refId
, which may be a:branch name
tag name
commit hash
If a name is provided, it must be considered as either an ID or a display ID. - resolveRefs(Repository, ResolveRefsCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Resolves one or more branches, tags and/or refs.
- RestrictionProcessingRequest - Class in com.atlassian.bitbucket.settingsrestriction
-
Request object for a batch of repositories to be processed with an associated restriction.
- RestrictionProcessingRequest(Set<Repository>, SettingsKey) - Constructor for class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- resultOf(PermissionVote...) - Static method in enum class com.atlassian.bitbucket.permission.PermissionVote
- revert(Repository, RevertCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Reverts the specified commit on a given branch as described by the
parameters
. - rollback(HomeUpdate) - Method in class com.atlassian.bitbucket.home.AbstractHomeUpdateHandler
-
Provides a default no-op implementation to facilitate building handlers with no explicit rollback mechanism.
- rollback(HomeUpdate) - Method in interface com.atlassian.bitbucket.home.HomeUpdateHandler
-
Rolls back the
applied
changes, restoring references to the old shared home directory location. - run() - Method in interface com.atlassian.bitbucket.ssh.command.SshCommand
-
Runs the command, returning its exit code.
S
- Scm - Interface in com.atlassian.bitbucket.scm
-
Describes a pluggable extension point for implementing custom SCMs.
- ScmEvent - Class in com.atlassian.bitbucket.scm.event
-
Common base for all events raised by
SCM
implementations. - ScmEvent(Object, Scm) - Constructor for class com.atlassian.bitbucket.scm.event.ScmEvent
-
Constructs a new
ScmEvent
, initialising the event'ssource
and setting theScm
from which the event is being raised. - ScmModuleDescriptor - Class in com.atlassian.bitbucket.scm
-
ModuleDescriptor
which interprets<scm/>
tags inatlassian-plugin.xml
. - ScmModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.ScmModuleDescriptor
- ScmProtocol - Interface in com.atlassian.bitbucket.scm
-
An extension point for declaring an
Scm's
support for a protocol and for generating protocol-specific clone URLs forrepositories
of thatkind
. - ScmProtocolModuleDescriptor - Class in com.atlassian.bitbucket.scm
-
Provides an
ScmProtocol
implementation used in connection with one or moreScms
. - ScmProtocolModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.ScmProtocolModuleDescriptor
- ScmRequest - Interface in com.atlassian.bitbucket.scm
-
A read or write request targeting a Stash repository.
- ScmRequestCheck - Interface in com.atlassian.bitbucket.scm
-
Used to enforce a specific precondition for a repository hosting operation, such as a push or pull.
- ScmRequestCheckModuleDescriptor - Class in com.atlassian.bitbucket.scm
-
Provides an
ScmRequestCheck
implementation used by theScmRequestCheckService
. - ScmRequestCheckModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.ScmRequestCheckModuleDescriptor
- ScmRequestCheckService - Interface in com.atlassian.bitbucket.scm
-
Used to validate read and write operations on repositories managed by Stash.
- ScmStatus - Interface in com.atlassian.bitbucket.scm
- ScmStatusChangedEvent - Class in com.atlassian.bitbucket.scm.event
- ScmStatusChangedEvent(Object, Scm, ScmStatus) - Constructor for class com.atlassian.bitbucket.scm.event.ScmStatusChangedEvent
- ScmUrlFormatter - Interface in com.atlassian.bitbucket.scm
-
Formats an appropriate URL for a given
repository
. - ScmUrlFormatterModuleDescriptor - Class in com.atlassian.bitbucket.scm
-
Parses the nested
url-formatter
element, when present, to produce anScmUrlFormatter
. - ScmUrlFormatterModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.ScmUrlFormatterModuleDescriptor
- ScmUrlRequest - Class in com.atlassian.bitbucket.scm
- ScmUrlRequest.Builder - Class in com.atlassian.bitbucket.scm
- sendAuthenticationError(AuthenticationState, String, String, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.bitbucket.scm.http.HttpScmRequestHandler
- sendError(String, String) - Method in interface com.atlassian.bitbucket.scm.ScmRequest
-
Sends the provided error details to the client, using SCM- and RPC-specific techniques as necessary.
- sendError(String, String, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.bitbucket.scm.http.HttpScmRequestHandler
- SequentialArchive - Interface in com.atlassian.bitbucket.migration
- setExecutionTimeout(long) - Method in class com.atlassian.bitbucket.scm.SimpleCommand
-
Throws an
UnsupportedOperationException
to indicate that an execution timeout cannot be configured. - setIdleTimeout(long) - Method in class com.atlassian.bitbucket.scm.SimpleCommand
-
Throws an
UnsupportedOperationException
to indicate that an idle timeout cannot be configured. - setProperty(Comment, String, Object) - Method in interface com.atlassian.bitbucket.comment.CommentPropertyContext
-
Adds a property to the
comment
. - setProperty(PullRequest, String, Object) - Method in interface com.atlassian.bitbucket.pull.PullRequestPropertyContext
-
Adds a property to the
pullRequest
. - SettingsValidationErrors - Interface in com.atlassian.bitbucket.setting
-
Used by
SettingsValidator
to report validation errors. - SettingsValidator - Interface in com.atlassian.bitbucket.setting
-
Handles validation of hook settings before they are persisted.
- ShutdownHook - Interface in com.atlassian.bitbucket.shutdown
-
Interface to be implemented by components who need to be informed about shutdown as soon as it is initiated.
- ShutdownHookStatus - Enum Class in com.atlassian.bitbucket.shutdown
-
Represents the status of component implementing
ShutdownHook
. - shutdownNow() - Method in interface com.atlassian.bitbucket.shutdown.ShutdownHook
-
Indicates that component should shutdown immediately as grace period for shutting down is over.
- signedObjects(Repository, SignedObjectsParameters, SignedObjectCallback) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Retrieves requested objects and if the object is signed, provides the signature and signed content to the callback.
- SimpleAuthentication - Class in com.atlassian.bitbucket.auth
- SimpleAuthentication.Builder - Class in com.atlassian.bitbucket.auth
- SimpleCommand<T> - Class in com.atlassian.bitbucket.scm
-
Implementation of the
Command
interface that provides empty implementations for all methods exceptCommand.call()
. - SimpleCommand() - Constructor for class com.atlassian.bitbucket.scm.SimpleCommand
- size(Repository, SizeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the size of the file at the requested path at the specified commit.
- SshAuthenticationContext - Interface in com.atlassian.bitbucket.auth
-
The authentication context for SSH connections
- SshAuthenticationFailureContext - Interface in com.atlassian.bitbucket.auth
-
Context class holding all details relevant for authentication failure processing by
SshAuthenticationFailureHandler
modules. - SshAuthenticationFailureHandler - Interface in com.atlassian.bitbucket.auth
-
Handler for authentication failure over SSH.
- SshAuthenticationFailureHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
- SshAuthenticationFailureHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.SshAuthenticationFailureHandlerModuleDescriptor
- SshAuthenticationHandler - Interface in com.atlassian.bitbucket.auth
-
Implementations should be stateless and thread-safe, as a single instance will be used to service all authentication requests.
- SshAuthenticationHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
-
Module descriptor for custom ssh key authenticators.
- SshAuthenticationHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.SshAuthenticationHandlerModuleDescriptor
- SshAuthenticationSuccessContext - Interface in com.atlassian.bitbucket.auth
-
Context class holding all details relevant for authentication success processing by
SshAuthenticationSuccessHandler
modules. - SshAuthenticationSuccessHandler - Interface in com.atlassian.bitbucket.auth
-
Handler that is called when a user successfully authenticates with the system over SSH.
- SshAuthenticationSuccessHandlerModuleDescriptor - Class in com.atlassian.bitbucket.auth
- SshAuthenticationSuccessHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.auth.SshAuthenticationSuccessHandlerModuleDescriptor
- SshCommand - Interface in com.atlassian.bitbucket.ssh.command
-
Describes an SSH command, which can be run or canceled.
- SshCommandContext - Class in com.atlassian.bitbucket.ssh.command
- SshCommandContext.Builder - Class in com.atlassian.bitbucket.ssh.command
- SshCommandFactory - Interface in com.atlassian.bitbucket.ssh.command
-
Describes a factory for parsing commands and creating
SshCommand
instances to run them. - SshCommandFactoryModuleDescriptor - Class in com.atlassian.bitbucket.ssh.command
-
Module descriptor for providing
SshCommandFactory
implementations. - SshCommandFactoryModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.ssh.command.SshCommandFactoryModuleDescriptor
- SshScmProtocol - Interface in com.atlassian.bitbucket.scm.ssh
- SshScmRequest - Interface in com.atlassian.bitbucket.scm.ssh
-
Handles an SCM SSH command from a remote client.
- SshScmRequestContext - Class in com.atlassian.bitbucket.scm.ssh
- SshScmRequestContext.Builder - Class in com.atlassian.bitbucket.scm.ssh
- SshScmRequestHandler - Interface in com.atlassian.bitbucket.scm.ssh
-
Plugin point for handling
SshScmRequest
s. - SshScmRequestHandlerModuleDescriptor - Class in com.atlassian.bitbucket.scm.ssh
-
Module descriptor for providing
SshScmRequestHandler
implementations. - SshScmRequestHandlerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.scm.ssh.SshScmRequestHandlerModuleDescriptor
- StandardMigrationEntityType<K> - Class in com.atlassian.bitbucket.migration
- startShutdown(Duration) - Method in interface com.atlassian.bitbucket.shutdown.ShutdownHook
-
Indicates that component should start shutdown process such that it stops performing new tasks, but leave currently running tasks uninterrupted until asked to shutdown immediately.
- stderr(OutputStream) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- stdin(InputStream) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- stdout(OutputStream) - Method in class com.atlassian.bitbucket.scm.ssh.SshScmRequestContext.Builder
- SUCCESSFUL - Enum constant in enum class com.atlassian.bitbucket.build.server.operations.ActionState
-
The action was performed successfully.
- SUPPORTED_ARCHIVE_VERSIONS - Static variable in interface com.atlassian.bitbucket.migration.Importer
-
Set of archive versions that are supported by this version of the product.
- supports(HttpRequestDetails) - Method in interface com.atlassian.bitbucket.scm.http.HttpScmRequestHandler
-
Returns whether the handler can service the supplied request.
- supports(Scm) - Method in interface com.atlassian.bitbucket.scm.ScmProtocol
-
Determines if this protocol supports the specified
SCM
. - supports(String) - Method in interface com.atlassian.bitbucket.scm.ScmProtocol
- supports(String) - Method in interface com.atlassian.bitbucket.scm.ssh.SshScmRequestHandler
- supports(String) - Method in interface com.atlassian.bitbucket.ssh.command.SshCommandFactory
- synchronize(Repository, MirrorSyncCommandParameters, MirrorSyncCallback) - Method in interface com.atlassian.bitbucket.scm.mirror.PluginMirrorCommandFactory
- SynchronousPreferred - Annotation Interface in com.atlassian.bitbucket.hook.repository
-
Annotation to be used with
PostRepositoryHook
instances to signal that the hook prefers to be called synchronously, which allows the hook to write to the SCM client error and output streams directly forpushes
to the repository.
T
- tags(Repository, TagsCommandParameters, TagCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams
tags
in the specified repository to the providedcallback
. - tags(Repository, TagsCommandParameters, PageRequest) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves a page of
tags
. - toModule() - Static method in class com.atlassian.bitbucket.util.ModuleDescriptorUtils
- toModules(Collection<M>) - Static method in class com.atlassian.bitbucket.util.ModuleDescriptorUtils
-
Convert an
Iterable
ofModuleDescriptor
into aStream
ofModuleDescriptorUtils
, where T is the type returned byModuleDescriptor.getModule()
. - toModules(Stream<M>) - Static method in class com.atlassian.bitbucket.util.ModuleDescriptorUtils
-
Convert a
Stream
ofModuleDescriptor
into aStream
ofModuleDescriptorUtils
, where T is the type returned byModuleDescriptor.getModule()
. - toPath(String) - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
-
Formats this fragment as a path suitable for use with a
URI
, such as withURI.resolve(String)
, optionally pre-pending a provided base path. - toPath(String, boolean) - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
-
Formats this fragment as a path suitable for use with a
URI
, such as withURI.resolve(String)
, optionally pre-pending a provided base path. - toSortedModules(Collection<M>) - Static method in class com.atlassian.bitbucket.util.ModuleDescriptorUtils
-
Convert a
Collection
ofBaseWeightedModuleDescriptor
into aStream
ofModuleDescriptorUtils
(sorted byBaseWeightedModuleDescriptor's
weight), where T is the type returned byModuleDescriptor.getModule()
. - toSortedModules(Stream<M>) - Static method in class com.atlassian.bitbucket.util.ModuleDescriptorUtils
-
Convert a
Stream
ofBaseWeightedModuleDescriptor
into aStream
ofModuleDescriptorUtils
(sorted byBaseWeightedModuleDescriptor's
weight), where T is the type returned byModuleDescriptor.getModule()
. - toString() - Method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- toString() - Method in class com.atlassian.bitbucket.scm.http.RepositoryUrlFragment
- toString() - Method in class com.atlassian.bitbucket.settingsrestriction.RestrictionProcessingRequest
- traverseCommits(Repository, TraversalCallback) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Streams all of the commits in the repository reachable from any branch or tag in topological order.
- traverseCommits(Repository, BulkTraverseCommitsCommandParameters, BulkTraversalCallback) - Method in interface com.atlassian.bitbucket.scm.bulk.PluginBulkContentCommandFactory
-
Stream commits from one or more repositories, in topological order.
- tryMerge(PullRequest) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
-
Attempt to merge the pull request to determine what the expected result of actually merging it would be.
- type(Repository, TypeCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginCommandFactory
-
Retrieves the
type
for the requested path at the specified commit.
U
- UNLICENSED - Enum constant in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Indicates that authentication succeeded but the user account is not licensed to use Stash.
- update(PullRequestRescope, RescopeDetails, RescopeDetails) - Method in interface com.atlassian.bitbucket.scm.pull.BulkRescopeContext
-
Marks the rescope as updating one or both of the associated pull request's
from
andto
refs. - updateDefaultBranch(Repository, UpdateDefaultBranchCommandParameters) - Method in interface com.atlassian.bitbucket.scm.PluginExtendedCommandFactory
-
Sets the default branch for the repository to the
named branch
. - UpdatePullRequestRefsCommandParameters - Class in com.atlassian.bitbucket.scm.pull
- UpdatePullRequestRefsCommandParameters.Builder - Class in com.atlassian.bitbucket.scm.pull
- updateRefs(Repository, MirrorUpdateRefsCommandParameters) - Method in interface com.atlassian.bitbucket.scm.mirror.PluginMirrorCommandFactory
-
Applies the provided
ref changes
in the repository. - updateRefs(UpdatePullRequestRefsCommandParameters) - Method in interface com.atlassian.bitbucket.scm.pull.PluginPullRequestCommandFactory
-
Implementors: The default implementation of this method will be removed in 9.0.
- user(ApplicationUser) - Method in class com.atlassian.bitbucket.scm.ScmUrlRequest.Builder
- USER - Static variable in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- UserErasureHandler - Interface in com.atlassian.bitbucket.user
-
User Anonymization SPI
- UserErasureModuleDescriptor - Class in com.atlassian.bitbucket.user
-
Module Descriptor for providing
user erasure handlers
. - UserErasureModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.bitbucket.user.UserErasureModuleDescriptor
V
- validate(Settings, SettingsValidationErrors, Scope) - Method in interface com.atlassian.bitbucket.setting.SettingsValidator
-
Validate the given
settings
before they are persisted. - validate(Element) - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandlerModuleDescriptor
- validate(Element) - Method in class com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandlerModuleDescriptor
- validate(Element) - Method in class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor
- validate(Element) - Method in class com.atlassian.bitbucket.scm.ScmRequestCheckModuleDescriptor
- validate(Element) - Method in class com.atlassian.bitbucket.scm.ScmUrlFormatterModuleDescriptor
- validate(Element) - Method in class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
- validate(Map<String, String[]>, ValidationErrors) - Method in interface com.atlassian.bitbucket.ui.PluginFormFragments
-
Validate all
ContextualFormFragment
s defined for this form. - validate(Map<String, String[]>, ValidationErrors, Map<String, Object>) - Method in interface com.atlassian.bitbucket.ui.ContextualFormFragment
-
Validate the fields supplied by this form fragment.
- validateAuthentication(HttpAuthenticationContext) - Method in interface com.atlassian.bitbucket.auth.HttpAuthenticationHandler
-
Invoked by the system on requests that have an authenticated user.
- ValidationErrors - Interface in com.atlassian.bitbucket.ui
-
Used by
ContextualFormFragment
to report field validation errors. - valueOf(String) - Static method in enum class com.atlassian.bitbucket.build.server.operations.ActionState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.bitbucket.permission.PermissionVote
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.bitbucket.shutdown.ShutdownHookStatus
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.atlassian.bitbucket.build.server.operations.ActionState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.bitbucket.hook.repository.RepositoryHookCommitFilter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in class com.atlassian.bitbucket.migration.StandardMigrationEntityType
- values() - Static method in enum class com.atlassian.bitbucket.permission.PermissionVote
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.bitbucket.scm.AuthenticationState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.bitbucket.shutdown.ShutdownHookStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- veto(String, String) - Method in interface com.atlassian.bitbucket.scm.pull.MergeRequest
-
If called, signifies that the calling check wishes to veto the merge.
- VETO - Enum constant in enum class com.atlassian.bitbucket.permission.PermissionVote
- vote(PermissionCheck) - Method in interface com.atlassian.bitbucket.permission.PermissionVoter
W
- Weighted - Interface in com.atlassian.bitbucket.util
-
An interface for objects that have a weight associated with them used for sorting.
- write - Variable in class com.atlassian.bitbucket.scm.AbstractRepositoryScmRequest
X
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.HttpAuthenticationFailureHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.HttpAuthenticationHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.HttpAuthenticationSuccessHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.SshAuthenticationFailureHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.SshAuthenticationHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.auth.SshAuthenticationSuccessHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.build.server.PluginBuildServerProviderModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.filestore.PluginFileStoreModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.home.HomeUpdateHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.idx.CommitIndexerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.idx.CommitPropertyConfigurationModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.migration.MigrationHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.permission.PermissionVoterProviderModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.scm.http.HttpScmRequestHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.scm.ScmModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.scm.ScmProtocolModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.scm.ScmRequestCheckModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.scm.ssh.SshScmRequestHandlerModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.settingsrestriction.ProjectSettingsRestrictionProcessorModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.ssh.command.SshCommandFactoryModuleDescriptor
- XML_ELEMENT_NAME - Static variable in class com.atlassian.bitbucket.user.UserErasureModuleDescriptor
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form