All Classes and Interfaces
Class
Description
Provides a base class for implementing
HomeUpdateHandler
s.Extends
AbstractScmRequest
and adds properties to facilitate implementing SCM requests
which interact with a repository, to read or write
.Convenience implementation of
Scm
that returns null
for all of the optional contract members.A simple base class to facilitate implementing
SCM requests
.A base class for constructing module descriptors for
ScmRequest
handlers.The result of a request from Bitbucket to a CI system to perform a certain action.
The final state of the request to perform an action.
Provides access to an archive within an archive.
Outcome of a successful
authentication
operation.Indicates the result of a user's authentication attempt.
Base implementation for scm hook module descriptor.
Encapsulates the actions that can be taken as well as information about authorization requirements.
An action that can be performed on a build status
A request to perform an action on a build status e.g.
A class that is used to add extra details to a
RepositoryBuildStatus
that don't exist in the database.Provides a context for SCMs to detect
pull request rescopes
when a repository is updated.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.
Allows iterating and adding
properties
on comments.Provides properties to Stash
comments
.Describes an indexer to be notified when commits are added to or removed from a repository.
Property configuration for any commit indexer.
Allows the injection of fields into existing forms provided by the host application.
Indicates connection pools and similar data structures have a means of waiting for resources to close/clean up.
Provides the ability to map local IDs to instance agnostic logical IDs during an export.
Provides the ability to map generated export IDs to locally created IDs during an import and vice versa.
Provides access to a single file within an archive.
Passed to the
SshScmRequestHandler
as a callback to be used when an underlying SSH process completes.Represents the context for the current export job.
Data Center Migration Exporter SPI
Allows addition of entries to the export archive, either from disk or directly from a
stream
.Exception thrown when a file store is misconfigured.
An implementation of
CommentPropertyProvider
that flattens the list of the comments in the
context
such that subclasses that override
FlatteningCommentPropertyProvider.doProvideProperties(CommentPropertyContext)
have instant access to all nested comments without having
to go through the reply tree
manually.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.
Describes the fork being created.
Invoked when the
shared home directory
is updated.Context class holding all details relevant for authentication processing by
HttpAuthenticationHandler
modules.Context class holding all details relevant for authentication failure processing by
HttpAuthenticationFailureHandler
modules.Handler for authentication failure over HTTP.
Implementations may also implement
HttpLogoutHandler
, in which case they'll get a callback when the user
logs out.Context class holding all details relevant for authentication success processing by
HttpAuthenticationSuccessHandler
modules.Handler that is called when a user successfully authenticates with the system over HTTP.
Interface that
http-auth-handler
modules can optionally implement to receive callbacks on logout.Details about the HTTP request to be serviced.
Handles an HTTP request from an SCM client (e.g.
Plugin point for providing handlers for HTTP requests for SCM hosting operations.
Module descriptor for providing
HttpScmRequestHandler
implementations.Allows the consumption of entries contained in an import archive.
Data Center Migration Importer SPI
Used to by
CommitIndexer
s to store state during the indexing process.Thrown when performing a migration of a repository and there is not enough disk space.
Used by an SCM to report integrity check results as they become available.
Allows an SCM to obtain additional information required to perform integrity checks
Renders an object to a JSON string.
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.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.Represents an entity type that can be exported by the
exporter
SPI.Describes a minimal
pull request
, providing only the ID, version and
refs
.Utility methods for working with plugin
ModuleDescriptors
.Allows stash core to query the state of optional plugins.
The permission to check and optionally the resource on which to check it.
A
PermissionVoter
may be used to determine access restrictions for application resources.Provides
PermissionVoter
for a authentication
in addition to those already
granted to them through direct grant, group membership and default permissions.Module descriptor for providing
PermissionVoterProvider
implementations.An abstraction describing a specific instance of a CI server and methods for Bitbucket Server to interact with it.
An interface for Bitbucket to interact with the remote CI tool in order to perform actions (e.g.
Build Server Provider SPI.
Module descriptor for providing
PluginBuildServerProvider
implementations.A factory for creating commands which operate on bulk content.
When implemented by an
SCM
, allows the ScmService
to provide an ScmCommandBuilder
that
can be used to build custom commands for advanced functionality.Provides backing functionality for the
ScmCommandFactory
.Specialized command factory to compare two refs.
Provides backing functionality for the
ScmExtendedCommandFactory
.A service provider interface (SPI) that allows plugins to provide their own implementation of a file store for
Bitbucket Data Center to use.
Module descriptor for providing
PluginFileStore
implementations.Collates a collection of enabled
ContextualFormFragment
s plugin modules defined for a particular form.Factory for
PluginFormFragments
.A Command factory for SCM integrity checks.
Describes an SPI for allowing SCMs to expose user-selectable merge strategies.
Describes a single merge strategy, which controls how commits from one line of development are applied to another.
Specialized command factory for dealing with
refs
.PostRepositoryHook<T extends com.atlassian.bitbucket.hook.repository.RepositoryHookRequest>
Hook that is called after changes to 1 or more refs have been made.
RepositoryHookContext
specialization that is provided to PostRepositoryHook
hooksPreRepositoryHook<T extends com.atlassian.bitbucket.hook.repository.RepositoryHookRequest>
Hook that is called for all veto-able changes to 1 or more Refs.
RepositoryHookContext
specialization that is provided to PreRepositoryHook
hooksPost processing functionality for
ProjectSettingsRestriction
s.Module descriptor for providing
ProjectSettingsRestrictionProcessor
implementations.Provides properties to
PullRequestMergeability
.Allows iterating and adding
properties
to pull requests.Provides properties to Stash
pull requests
.Describes how a
pull request
is going to be rescoped.The context in which the metadata is being retrieved for a given collection of
refs
A plugin point for associating arbitrary metadata with a
Ref
.A callback to receive more information about commits added or removed in a
RepositoryHookRequest
.Describes the type of commit details a repository-hook
callback
is interested
in.Used to enforce a specific precondition for a pull request merge operation.
In addition to the normal
MergeRequest
parameters, will have additional settings which can be configured
per-repository.Utility class for parsing project keys and repository slugs from scm urls - HTTP and SSH.
Request object for a batch of repositories to be processed with an associated restriction.
Describes a pluggable extension point for implementing custom SCMs.
Common base for all events raised by
SCM
implementations.ModuleDescriptor
which interprets <scm/>
tags in atlassian-plugin.xml
.An extension point for declaring an
Scm's
support for a protocol and for generating protocol-specific
clone URLs for repositories
of that kind
.Provides an
ScmProtocol
implementation used in connection with one or more Scms
.A read or write request targeting a Stash repository.
Used to enforce a specific precondition for a repository hosting operation, such as a push or pull.
Provides an
ScmRequestCheck
implementation used by the ScmRequestCheckService
.Used to validate read and write operations on repositories managed by Stash.
Formats an appropriate URL for a given
repository
.Parses the nested
url-formatter
element, when present, to produce an ScmUrlFormatter
.Used by
SettingsValidator
to report validation errors.Handles validation of hook settings before they are persisted.
Interface to be implemented by components who need to be informed about shutdown as soon as it is initiated.
Represents the status of component implementing
ShutdownHook
.Implementation of the
Command
interface that provides empty implementations for all methods
except Command.call()
.The authentication context for SSH connections
Context class holding all details relevant for authentication failure processing by
SshAuthenticationFailureHandler
modules.Handler for authentication failure over SSH.
Implementations should be stateless and thread-safe, as a single instance will be used to service all authentication
requests.
Module descriptor for custom ssh key authenticators.
Context class holding all details relevant for authentication success processing by
SshAuthenticationSuccessHandler
modules.Handler that is called when a user successfully authenticates with the system over SSH.
Describes an SSH command, which can be run or canceled.
Describes a factory for parsing commands and creating
SshCommand
instances to run them.Module descriptor for providing
SshCommandFactory
implementations.Handles an SCM SSH command from a remote client.
Plugin point for handling
SshScmRequest
s.Module descriptor for providing
SshScmRequestHandler
implementations.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 for
pushes
to the repository.User Anonymization SPI
Module Descriptor for providing
user erasure handlers
.Used by
ContextualFormFragment
to report field validation errors.An interface for objects that have a weight associated with them used for sorting.