All Classes and Interfaces
Class
Description
Component for looking up application properties specific to their web interface
Allows the host application to communicate about when authentication should be performed
and users allowed to login.
Allows the underlying framework to take some actions on authentication events.
Authenticates requests
Encapsulates the results of an authentication attempt.
Exception that is thrown by one of the enforce methods in
PermissionEnforcer when the current user does not
have the required level of access.Common license properties that appear in all the different kind of Product Licenses that may occur in Atlassian
applications.
Unified interface to access components via their interface.
Callback to be executed by
TransactionalExecutor.execute(ConnectionCallback)A parameterised plugin module condition for enabling modules in the presence of a dark feature.
Provides a cross-product method for determining whether a dark feature is enabled.
Default immutable implementation of HelpPath.
Represents a set of enabled features.
The scope of an enabled feature key.
Link to product specific help displayed in the UI.
Help path resolver used to retrieve product specific help.
Provides access to the key objects provided by the servlet API when processing an HTTP request.
This interface is responsible for resolving a message or key/argument pairs to
their internationalized message.
Thrown if the application decides that the attempted operation is not allowed for some reason.
This event gets thrown whenever the host application license changes.
All error types of the license verification's result.
Interface into the license system for the underlying application.
The license validation error details.
The outcome of a license validation check for each product key.
The license validation warning details.
All warning types of the license verification's result.
Marker interface that indicates a component wishes to execute some code after application startup.
Triggers lifecycle events on
LifecycleAware components.This interface is responsible for resolving the current locale.
Provides the
URI to redirect users to for them to login before they can
authorize consumer requests to access their data.The REST plugin provides an implementation that allows marshalling of entities.
Encapsulates a message before it has been resolved via an I18N resolver
A collection of messages that haven't been resolved
The outcome of validating multiple licenses.
Provides access to the one or more individual
products that may
appear in a single license.HttpClientRequestFactory implements this interface.Exception that is thrown by one of the enforce methods in
PermissionEnforcer when the current user does not
have the required level of access because the user is not authenticated.Used to store whether a request has successfully passed through the OAuth filter in some way.
Util class for creating empty enum set, parsing string and valueOf function
Login page capabilities, implementation should provide a page which matches behavior/look requirements from those capabilities.
Allows clients to easily verify that the caller has sufficient permission to access the resource.
Deprecated.
in 3.0 for removal in 4.0.
Deprecated.
in 3.0 for removal in 4.0.
Provides access to settings globally or per project/space/repository/build-plan
Factory for mutable, non-threadsafe PluginSettings objects.
Upgrades plugins using their defined build number.
A task that needs to be executed to upgrade the existing data
Represents license information for an individual role-based "Product" that lives on a platform.
Interface to managing and getting information about "projects".
A raw product license, the product license detail in a string format.
This exception is thrown by
com.atlassian.sal.api.rdbms implementations
in cases when interaction with a database failsInterface Request represents a request to retrieve data.
Represents type of network request
Factory to create
Requests.Defines the more information about the search resource (ie.
Represents the response when calling
Request.execute(ResponseHandler)Thrown by
Request methods to indicate that the request failed because a
connection could not be established within the timeout interval.This exception is thrown by
Request.execute() and ResponseHandler.handle(Response).Callback interface used by
Request.execute(ResponseHandler) method.Thrown by
Request methods to indicate that the request failed because the
server did not comply with the request protocol.Thrown by
Request methods to indicate that the request failed because the
server did not respond within the timeout interval after a connection was made.Thrown by
Request.execute() to indicate that the request was unsuccessful
based on the response's status code.Thrown by
Request methods to indicate that the request failed because the
server did not response in time.Thrown by
Request methods to indicate that the request failed because of an I/O error in the
underlying protocol.Callback interface used by the
Request.executeAndReturn(ReturningResponseHandler)
method.A single match for a query (i.e.
Allows to specify additional properties for a search in terms of string value pairs.
Allows for simple string based searches in an application.
Utility class to help with creating a query string for the
SearchProvider.search(String, String) method.Parses a query string created by a
SearchQuery to allow easy access to the various aspects of the queryProvides searchresults for a query.
Represents an event published when a http session is created.
Represents an event published when a http session is destroyed.
A "view" on top of a license that is in the context of a single given product.
Persist site wide dark feature keys.
Manager for retrieving and storing a single object which represents all thread local state.
Factory to create
Executor instances that delegate to a specific Executor and ensure the executed code runs
in the same thread local context.Interface allowing the user to execute a callback with a
Connection, in the context of a transaction.Provided by the host application for creating
TransactionalExecutor.A simple callback that needs to be provided with an action to run in the doInTransaction method.
This allows applications greater control over the transaction in which operations may be executed.
The kind of URL to return from methods that accept this as a parameter.
Represents an identifier that uniquely identifies a user for the duration of its existence.
A JAXB
XmlAdapter which converts to and from UserKey objects.Interface providing user based operations across various apps.
Interface encapsulating a user's profile information.
Thrown if there is a problem when trying to resolve a username to a user, such as a failure in accessing an external
user store.
Enforce certain level of privileges on log in page
An immutable container of user-specific settings.
A builder for
UserSettingsService for getting and updating immutable UserSettings objects stored against a user name
UserSettings can be used to store values of type String, Boolean and Long - nothing more.
The outcome of a validation check.
A given string represents a valid feature key if the following conditions are satisfied:
Contains alphanumeric characters including the dot (.), dash (,) and underscore (_) only
The minimal size is at least one character, while the upper limit is not restricted
Allows the client to request WebSudo protection from the host application.
Any Element marked with this annotation will bypass the WebSudo protection.
Elements marked with this annotation will require WebSudo protection.
Thrown if there is a problem with the WebSudo session (missing or expired) for a request that requires WebSudo.
Provides an implementation of checking if a request or a header value
contains a valid
XsrfHeaderValidator.TOKEN_HEADER header.An interface which can be implemented to check if a request
contains either a valid csrf token or a
valid csrf header
XsrfHeaderValidator.TOKEN_HEADER.Gives access to the applications XSRF tokens
Verifies that a submitted token is valid.