Class Index

A B C D E F H I J M N O P R S T V W

A

AbstractCommandBuilder<B extends CommandBuilder<B>> Provides a basic implementation of most CommandBuilder functionality, to simplify creating builders. 
AbstractCommitDiscussionCommentNotification  
AbstractCommitDiscussionNotification  
AbstractHomeUpdateHandler Provides a base class for implementing HomeUpdateHandlers. 
AbstractNotification  
AbstractPullRequestNotification  
AbstractRepositoryNotification  
AbstractRepositoryScmRequest Extends AbstractScmRequest and adds properties to facilitate implementing SCM requests which interact with a repository, to read or write
AbstractScm Convenience implementation of Scm that returns null for all of the optional contract members. 
AbstractScmCommandBuilder<B extends ScmCommandBuilder<B>> Extends AbstractCommandBuilder and provides a basic implementation of ScmCommandBuilder. 
AbstractScmRequest A simple base class to facilitate implementing SCM requests
AbstractScmRequestHandlerModuleDescriptor<T> A base class for constructing module descriptors for ScmRequest handlers. 
ArchiveSource Provides access to an archive within an archive. 
AsyncPostReceiveRepositoryHook This interface is deprecated. in 5.0 for removal in 6.0. Implement PostRepositoryHook instead.  
AuthenticationResult Outcome of a successful authentication operation. 
AuthenticationResult.Builder  
AuthenticationState Indicates the result of a user's authentication attempt when messaging the client using ScmRequest#sendAuthenticationError. 

B

BaseCommand<T> Wrapper around Atlassian's process utils. 
BaseScmHookModuleDescriptor<T> Base implementation for scm hook module descriptor. 
BaseWeightedModuleDescriptor<T>  
BuiltinHookHandlerFactory Factory for HookHandler that Bitbucket ships with. 
BulkRescopeCommandParameters  
BulkRescopeCommandParameters.Builder  
BulkRescopeContext Provides a context for SCMs to detect pull request rescopes when a repository is updated. 

C

CanceledMigrationException 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. 
CommentAddedPullRequestNotification  
CommentPropertyContext Allows iterating and adding PropertyMap properties on comments. 
CommentPropertyProvider Provides properties to Stash Comment comments. 
CommentRepliedPullRequestNotification  
CommitAddedDetails Describes a commit that was added / is about to be added to a ref
CommitDiscussionCommentAddedNotification  
CommitDiscussionCommentNotification  
CommitDiscussionCommentRepliedNotification  
CommitDiscussionNotification  
CommitIndexer Describes an indexer to be notified when commits are added to or removed from a repository. 
CommitIndexerModuleDescriptor  
CommitPropertyConfiguration Property configuration for any commit indexer. 
CommitPropertyConfigurationModuleDescriptor  
CommitRemovedDetails Describes a commit that was removed / is about to be removed from a ref
ContextualFormFragment Allows the injection of fields into existing forms provided by the host application. 

D

DefaultCommandExitHandler  
DeleteCommandParameters  
DeleteCommandParameters.Builder  
Drainable Indicates connection pools and similar data structures have a means of waiting for resources to close/clean up. 

E

EffectivePermissionsChangedEvent This class is deprecated. in 5.5 for removal without replacement in 6.0.  
EffectivePermissionsProvider This interface is deprecated. in 5.5 for removal in 6.0. Use PermissionVoterProvider instead.  
EntityExportMapping<K> Provides the ability to map local IDs to instance agnostic logical IDs during an export. 
EntityImportMapping<K> Provides the ability to map generated export IDs to locally created IDs during an import and vice versa. 
EntrySource Provides access to a single file within an archive. 
ExitCodeCallback Passed to the SshScmRequestHandler as a callback to be used when an underlying SSH process completes. 
ExportContext Represents the context for the current export job. 
Exporter

Instance Migration Exporter SPI

Implement this interface to export data so that it can be imported by an Importer

ExportSection Allows addition of entries to the export archive, either from disk or directly from a OutputStream stream. 

F

FlatteningCommentPropertyProvider An implementation of CommentPropertyProvider that flattens the list of the comments in the context such that subclasses that override doProvideProperties(CommentPropertyContext) have instant access to all nested comments without having to go through the Comment#getComments() reply tree manually. 
ForcedDrainable 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. 
ForkCommandParameters Describes the fork being created. 
ForkCommandParameters.Builder  

H

HomeUpdate Describes the old and new absolute paths for the home directory. 
HomeUpdateHandler Invoked when the com.atlassian.bitbucket.server.StorageService#getSharedHomeDir() shared home directory is updated. 
HomeUpdateHandlerModuleDescriptor  
HookRequestHandle A handle on the hook request which provides the required information to make a successful callback to Stash via their hook callback socket  
HookService A service which handles the management of hook requests. 
HookUtils Utility methods for configuring processes, whether using Java's ProcessBuilder or Atlassian Process Utils, to execute pre-receive and post-receive hooks. 
HttpAuthenticationContext Context class holding all details relevant for authentication processing by HttpAuthenticationHandler modules. 
HttpAuthenticationFailureContext Context class holding all details relevant for authentication failure processing by HttpAuthenticationFailureHandler modules. 
HttpAuthenticationFailureHandler Handler for authentication failure over HTTP. 
HttpAuthenticationFailureHandlerModuleDescriptor  
HttpAuthenticationHandler Implementations may also implement HttpLogoutHandler, in which case they'll get a callback when the user logs out. 
HttpAuthenticationHandlerModuleDescriptor  
HttpAuthenticationSuccessContext Context class holding all details relevant for authentication success processing by HttpAuthenticationSuccessHandler modules. 
HttpAuthenticationSuccessHandler Handler that is called when a user successfully authenticates with the system over HTTP. 
HttpAuthenticationSuccessHandlerModuleDescriptor  
HttpLogoutHandler Interface that http-auth-handler modules can optionally implement to receive callbacks on logout. 
HttpRequestDetails Details about the HTTP request to be serviced. 
HttpScmProtocol  
HttpScmRequest Handles an HTTP request from an SCM client (e.g. 
HttpScmRequestHandler Plugin point for providing handlers for HTTP requests for SCM hosting operations. 
HttpScmRequestHandlerModuleDescriptor Module descriptor for providing HttpScmRequestHandler implementations. 

I

ImportContext Allows the consumption of entries contained in an import archive. 
Importer Instance Migration Importer SPI

Implement this interface to import data that has been exported by an Exporter

IndexingContext Used to by CommitIndexers to store state during the indexing process. 
IntegrityCheckCallback Used by an SCM to report integrity check results as they become available. 
IntegrityCheckContext Allows an SCM to obtain additional information required to perform integrity checks 
IoConsumer<T>  
IoFunction<T, R>  

J

JsonRenderer Renders an object to a JSON string. 

M

MergeRequest Represents a request to merge a pull request, intended to allow MergeRequestChecks to validate the intended merge and, potentially, veto(String, String) it. 
MergeRequestCheck This interface is deprecated. in 5.0 for removal in 6.0. Use a repository-merge-check module and implement RepositoryMergeCheck instead. Set configurable="false" on the module to create a hook that is enabled for all repositories.  
MergeRequestCheckService A service that checks preconditions for pull request merges by applying MergeRequestChecks, which can be supplied by plugins, to determine whether merges should performed. 
MigrationEntityType<K> Represents an entity type that can be exported by the exporter SPI. 
MigrationHandlerModuleDescriptor Module descriptor for providing Exporter and Importer implementations. 
MinimalPullRequest Describes a minimal PullRequest pull request, providing only the ID, version and PullRequestRef refs. 
ModuleDescriptorUtils Utility methods for working with plugin ModuleDescriptor ModuleDescriptors. 

N

Notification A single Notification within the system  
NotificationHandler<T extends Notification> Notification Handler takes a Notification and pushes it to a channel 

O

OptionalPluginInformationProvider Allows stash core to query the state of optional plugins. 

P

PermissionCheck The permission to check and optionally the resource on which to check it. 
PermissionVote  
PermissionVoter A PermissionVoter may be used to determine access restrictions for application resources. 
PermissionVoterProvider Provides PermissionVoter for a Authentication authentication in addition to those already granted to them through direct grant, group membership and default permissions. 
PermissionVoterProviderModuleDescriptor Module descriptor for providing PermissionVoterProvider implementations. 
PluginBulkContentCommandFactory A factory for creating commands which operate on bulk content. 
PluginCommandBuilderFactory When implemented by an SCM, allows the ScmService to provide an ScmCommandBuilder that can be used to build custom commands for advanced functionality. 
PluginCommandFactory Provides backing functionality for the ScmCommandFactory. 
PluginCompareCommandFactory Specialized command factory to compare two refs. 
PluginExtendedCommandFactory Provides backing functionality for the ScmExtendedCommandFactory. 
PluginFormFragments Collates a collection of enabled ContextualFormFragments plugin modules defined for a particular form. 
PluginFormFragmentsFactory Factory for PluginFormFragments
PluginHookHandlerFactory  
PluginIntegrityCheckCommandFactory A Command factory for SCM integrity checks. 
PluginMergeStrategies Describes an SPI for allowing SCMs to expose user-selectable merge strategies. 
PluginMergeStrategy Describes a single merge strategy, which controls how commits from one line of development are applied to another. 
PluginMirrorCommandFactory  
PluginPullRequestCommandFactory  
PluginRefCommandFactory Specialized command factory for dealing with Ref refs. 
PostReceiveHook This interface is deprecated. in 5.0 for removal in 6.0. Use a repository-hook module and implement PostRepositoryHook instead. Set configurable="false" on the module to create a hook that is enabled for all repositories and check the getTrigger() hook trigger} to only respond to pushes. If the hook must be called synchronously, make sure to annotate the implementation class with SynchronousPreferred  
PostRepositoryHook<T extends RepositoryHookRequest> Hook that is called after changes to 1 or more refs have been made. 
PostRepositoryHookContext RepositoryHookContext specialization that is provided to PostRepositoryHook hooks 
PreReceiveHook This interface is deprecated. in 5.0 for removal in 6.0. Use a repository-hook module and implement PreRepositoryHook instead. Set configurable="false" on the module to create a hook that is enabled for all repositories and check the hook trigger to only respond to pushes  
PreReceiveRepositoryHook This interface is deprecated. since 5.0 for removal in 6.0. Implement PreRepositoryHook instead.  
PreRepositoryHook<T extends RepositoryHookRequest> Hook that is called for all veto-able changes to 1 or more Refs. 
PreRepositoryHookCommitCallback Specialized callback that pre-hooks can register to receive commit-level details for the requested change. 
PreRepositoryHookContext RepositoryHookContext specialization that is provided to PreRepositoryHook hooks 
PullRequestActivityNotification Notification for PullRequestActivity and its subtypes. 
PullRequestApprovedNotification  
PullRequestClosedNotification  
PullRequestCommentNotification Represents a PullRequestNotification that also has a comment, such as add/edit/reply. 
PullRequestDeleteCommandParameters  
PullRequestDeleteCommandParameters.Builder  
PullRequestDeletedNotification  
PullRequestFromRefRescopedNotification Notification for when a Pull Request source ref is updated due to a push to the source ref. 
PullRequestMergeabilityPropertyProvider Provides properties to PullRequestMergeability. 
PullRequestMergedNotification  
PullRequestNotification  
PullRequestOpenedNotification  
PullRequestPropertyContext Allows iterating and adding PropertyMap properties to pull requests. 
PullRequestPropertyProvider Provides properties to Stash PullRequest pull requests. 
PullRequestReopenedNotification  
PullRequestRescope Describes how a com.atlassian.bitbucket.pull.PullRequest pull request is going to be rescoped. 
PullRequestReviewedNotification  
PullRequestReviewerAddedNotification  
PullRequestReviewerRemovedNotification  
PullRequestReviewersUpdatedNotification  
PullRequestUnapprovedNotification  
PullRequestUpdatedNotification  

R

RefMetadataContext The context in which the metadata is being retrieved for a given collection of Ref refs 
RefMetadataProvider<T> A plugin point for associating arbitrary metadata with a Ref. 
RepositoryHookCommitCallback A callback to receive more information about commits added or removed in a RepositoryHookRequest. 
RepositoryHookCommitFilter Describes the type of commit details a repository-hook callback is interested in. 
RepositoryHookContext  
RepositoryHookImplementor This interface is deprecated. in 5.0 for removal in 6.0  
RepositoryMergeCheck Used to enforce a specific precondition for a pull request merge operation. 
RepositoryMergeRequestCheck This interface is deprecated. in 5.0 for removal in 6.0. Use a repository-merge-check module and implement RepositoryMergeCheck instead.  
RepositoryMergeRequestCheckContext In addition to the normal MergeRequest parameters, will have additional settings which can be configured per-repository. 
RepositoryNotification  
RepositoryPushNotification  
RepositoryRescopeContext Provides a context for SCMs to perform rescope calculations and update affected pull requests when a repository is updated. 
RepositorySettingsValidator This interface is deprecated. in 5.2 for removal in 6.0. Use SettingsValidator instead.  
RepositoryUrlFragment Utility class for parsing project namespaces, project keys and repository slugs from scm urls - HTTP and SSH. 

S

Scm Describes a pluggable extension point for implementing custom SCMs. 
ScmEvent Common base for all events raised by SCM implementations. 
ScmModuleDescriptor ModuleDescriptor which interprets &lt;scm/&gt; tags in atlassian-plugin.xml
ScmProtocol An extension point for declaring an Scm's support for a protocol and for generating protocol-specific clone URLs for Repository repositories of that kind
ScmProtocolModuleDescriptor Provides an ScmProtocol implementation used in connection with one or more Scms
ScmRequest A read or write request targeting a Stash repository. 
ScmRequestCheck Used to enforce a specific precondition for a repository hosting operation, such as a push or pull. 
ScmRequestCheckModuleDescriptor Provides an ScmRequestCheck implementation used by the ScmRequestCheckService
ScmRequestCheckService Used to validate read and write operations on repositories managed by Stash. 
ScmStatus Describes the current status of an Scm plugin. 
ScmStatusChangedEvent Raised when the status of an SCM changes at runtime. 
ScmUrlFormatter Formats an appropriate URL for a given repository
ScmUrlFormatterModuleDescriptor Parses the nested url-formatter element, when present, to produce an ScmUrlFormatter
ScmUrlRequest Describes a repository and base URL to use when formatting a URL
ScmUrlRequest.Builder  
SequentialArchive  
SettingsValidationErrors Used by SettingsValidator to report validation errors. 
SettingsValidator Handles validation of hook settings before they are persisted. 
SimpleAuthentication  
SimpleAuthentication.Builder  
SimpleCommand<T> Implementation of the Command interface that provides empty implementations for all methods except call()
SimpleEffectiveGlobalPermission This class is deprecated. in 5.5 for removal in 6.0 without replacement  
SimpleEffectivePermissionBase This class is deprecated. in 5.5 for removal in 6.0 without replacement  
SimpleEffectiveProjectPermission This class is deprecated. in 5.5 for removal in 6.0 without replacement  
SimpleEffectiveRepositoryPermission This class is deprecated. in 5.5 for removal in 6.0 without replacement  
SimpleEffectiveResourcePermissionBase This class is deprecated. in 5.5 for removal in 6.0 without replacement  
SshAuthenticationContext The authentication context for SSH connections 
SshAuthenticationFailureContext Context class holding all details relevant for authentication failure processing by SshAuthenticationFailureHandler modules. 
SshAuthenticationFailureHandler Handler for authentication failure over SSH. 
SshAuthenticationFailureHandlerModuleDescriptor  
SshAuthenticationHandler Implementations should be stateless and thread-safe, as a single instance will be used to service all authentication requests. 
SshAuthenticationHandlerModuleDescriptor Module descriptor for custom ssh key authenticators. 
SshAuthenticationSuccessContext Context class holding all details relevant for authentication success processing by SshAuthenticationSuccessHandler modules. 
SshAuthenticationSuccessHandler Handler that is called when a user successfully authenticates with the system over SSH. 
SshAuthenticationSuccessHandlerModuleDescriptor  
SshCommand Describes an SSH command, which can be run or canceled. 
SshCommandContext  
SshCommandContext.Builder  
SshCommandFactory Describes a factory for parsing commands and creating SshCommand instances to run them. 
SshCommandFactoryModuleDescriptor Module descriptor for providing SshCommandFactory implementations. 
SshScmProtocol  
SshScmRequest Handles an SCM SSH command from a remote client. 
SshScmRequestContext  
SshScmRequestContext.Builder  
SshScmRequestHandler Plugin point for handling SshScmRequests. 
SshScmRequestHandlerModuleDescriptor Module descriptor for providing SshScmRequestHandler implementations. 
StandardMigrationEntityType<K>  
SynchronousPreferred 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 StandardRepositoryHookTrigger#REPO_PUSH pushes to the repository. 

T

ThrottledScmRequestFactory Helper for SCM implementation providers to decorate HttpScmRequest and SshScmRequest instances with ThrottleService throttling. 

V

ValidationErrors Used by ContextualFormFragment to report field validation errors. 

W

Weighted An interface for objects that have a weight associated with them used for sorting.