A B C D E G H I L M O P R S T U V

A

addAll(List<Message>) - Method in interface com.atlassian.sal.api.message.MessageCollection

Adds all messages to the collection

addAuthentication(Authenticator) - Method in interface com.atlassian.sal.api.net.Request

Adds generic Authenticator to the request.

addBasicAuthentication(String, String) - Method in interface com.atlassian.sal.api.net.Request

Adds basic authentication to the request.

addHeader(String, String) - Method in interface com.atlassian.sal.api.net.Request

Adds the specified header to the request, not overwriting any previous value.

addMessage(String, Serializable...) - Method in interface com.atlassian.sal.api.message.MessageCollection

Adds a message to the collection

addMessage(Message) - Method in interface com.atlassian.sal.api.message.MessageCollection

Adds a message to the collection

addRequestParameters(String...) - Method in interface com.atlassian.sal.api.net.Request

Sets parameters of the request.

addSeraphAuthentication(String, String) - Method in interface com.atlassian.sal.api.net.Request

Adds seraph authentication to the request.

addTrustedTokenAuthentication() - Method in interface com.atlassian.sal.api.net.Request

Adds TrustedTokenAuthentication to the request.

addTrustedTokenAuthentication(String) - Method in interface com.atlassian.sal.api.net.Request

Adds TrustedTokenAuthentication to the request.

append(String) - Method in interface com.atlassian.sal.api.search.query.SearchQuery

Appends string query to current query object.

APPLICATION - Static variable in interface com.atlassian.sal.api.search.parameter.SearchParameter

The parameter for the application name to search

ApplicationProperties - Interface in com.atlassian.sal.api

Component for looking up application properties specific to their web interface

authenticate(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.auth.Authenticator

Authenticates a request

authenticate(String, String) - Method in interface com.atlassian.sal.api.user.UserManager

Given a usernamen & password, this method checks, whether or not the provided user can be authenticated

AuthenticationController - Interface in com.atlassian.sal.api.auth

Allows the host application to communicate about when authentication should be performed and users allowed to login.

authenticationError(Authenticator.Result, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.auth.AuthenticationListener

Called when there is a failure in trying to process the request, such as an IO failure.

authenticationFailure(Authenticator.Result, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.auth.AuthenticationListener

Called when the signature cannot be validated or the user cannot be resolved or does not have permission to access the resource.

AuthenticationListener - Interface in com.atlassian.sal.api.auth

Allows the underlying framework to take some actions on authentication events.

authenticationNotAttempted(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.auth.AuthenticationListener

Called if it was determined that authentication should not be attempted, usually because the AuthenticationController.shouldAttemptAuthentication(HttpServletRequest) returned false.

authenticationSuccess(Authenticator.Result, HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.auth.AuthenticationListener

Called when the signature is validated and the user is resolved and permissions are verified.

Authenticator - Interface in com.atlassian.sal.api.auth

Authenticates requests

Authenticator - Interface in com.atlassian.sal.api.net.auth

Marker interface for an authenticator.

Authenticator.Result - Class in com.atlassian.sal.api.auth

Encapsulates the results of an authentication attempt.

Authenticator.Result.Error - Class in com.atlassian.sal.api.auth

Authenticator.Result.Error(Message) - Constructor for class com.atlassian.sal.api.auth.Authenticator.Result.Error

Authenticator.Result.Failure - Class in com.atlassian.sal.api.auth

Authenticator.Result.Failure(Message) - Constructor for class com.atlassian.sal.api.auth.Authenticator.Result.Failure

Authenticator.Result.NoAttempt - Class in com.atlassian.sal.api.auth

Authenticator.Result.NoAttempt() - Constructor for class com.atlassian.sal.api.auth.Authenticator.Result.NoAttempt

Authenticator.Result.Status - Enum in com.atlassian.sal.api.auth

Authenticator.Result.Success - Class in com.atlassian.sal.api.auth

Authenticator.Result.Success(Principal) - Constructor for class com.atlassian.sal.api.auth.Authenticator.Result.Success

Deprecated. since 2.0.10, use Success#Success(Message, Principal)

Authenticator.Result.Success(Message, Principal) - Constructor for class com.atlassian.sal.api.auth.Authenticator.Result.Success

Construct a success result for a particular principal with a result message.

B

buildQueryString() - Method in interface com.atlassian.sal.api.search.parameter.SearchParameter

Converts the parameter into a queryString suitable for a URL.

buildQueryString() - Method in interface com.atlassian.sal.api.search.query.SearchQuery

Builds a url-encoded queryString to use with the SearchProvider.search(String,String) method.

C

canLogin(Principal, HttpServletRequest) - Method in interface com.atlassian.sal.api.auth.AuthenticationController

Check whether the given principal can log into the application for the current request.

com.atlassian.sal.api - package com.atlassian.sal.api

com.atlassian.sal.api.auth - package com.atlassian.sal.api.auth

com.atlassian.sal.api.component - package com.atlassian.sal.api.component

com.atlassian.sal.api.executor - package com.atlassian.sal.api.executor

com.atlassian.sal.api.license - package com.atlassian.sal.api.license

com.atlassian.sal.api.lifecycle - package com.atlassian.sal.api.lifecycle

com.atlassian.sal.api.message - package com.atlassian.sal.api.message

com.atlassian.sal.api.net - package com.atlassian.sal.api.net

com.atlassian.sal.api.net.auth - package com.atlassian.sal.api.net.auth

com.atlassian.sal.api.pluginsettings - package com.atlassian.sal.api.pluginsettings

com.atlassian.sal.api.project - package com.atlassian.sal.api.project

com.atlassian.sal.api.scheduling - package com.atlassian.sal.api.scheduling

com.atlassian.sal.api.search - package com.atlassian.sal.api.search

com.atlassian.sal.api.search.parameter - package com.atlassian.sal.api.search.parameter

com.atlassian.sal.api.search.query - package com.atlassian.sal.api.search.query

com.atlassian.sal.api.transaction - package com.atlassian.sal.api.transaction

com.atlassian.sal.api.upgrade - package com.atlassian.sal.api.upgrade

com.atlassian.sal.api.user - package com.atlassian.sal.api.user

ComponentLocator - Class in com.atlassian.sal.api.component

Unified interface to access components via their interface.

ComponentLocator() - Constructor for class com.atlassian.sal.api.component.ComponentLocator

convertClassToName(Class) - Method in class com.atlassian.sal.api.component.ComponentLocator

Converts the interface name into a String key

createCallable(Callable<T>) - Method in interface com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory

Creates a callable that ensures the executed runnable instance runs in the same thread local context as the calling code.

createExecutor(Executor) - Method in interface com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory

Creates an executor that ensures the executed delegate instance runs in the same thread local context as the calling code.

createExecutorService(ExecutorService) - Method in interface com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory

Creates an executor service that ensures the executed delegate instance runs in the same thread local context as the calling code.

createGlobalSettings() - Method in interface com.atlassian.sal.api.pluginsettings.PluginSettingsFactory

Gets all global settings.

createMessage(String, Serializable...) - Method in interface com.atlassian.sal.api.message.I18nResolver

Creates an instance of Message.

createMessageCollection() - Method in interface com.atlassian.sal.api.message.I18nResolver

createRequest(Request.MethodType, String) - Method in interface com.atlassian.sal.api.net.RequestFactory

Creates a request of given Request.MethodType to given url

createRunnable(Runnable) - Method in interface com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory

Creates a runnable that ensures the executed runnable instance runs in the same thread local context as the calling code

createScheduledExecutorService(ScheduledExecutorService) - Method in interface com.atlassian.sal.api.executor.ThreadLocalDelegateExecutorFactory

Creates a scheduled executor service that ensures the executed delegate instance runs in the same thread local context as the calling code.

createSettingsForKey(String) - Method in interface com.atlassian.sal.api.pluginsettings.PluginSettingsFactory

Gets all settings for a key, for which valid values are application-specific (Confluence maps this to space keys, JIRA to project keys, and FishEye to repository keys, for example).

D

doInTransaction() - Method in interface com.atlassian.sal.api.transaction.TransactionCallback

Runs an action in a transaction and returns a optional value.

doUpgrade() - Method in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

Perform the upgrade task.

E

execute(ResponseHandler) - Method in interface com.atlassian.sal.api.net.Request

Executes the request.

execute() - Method in interface com.atlassian.sal.api.net.Request

Executes a request and if response is successful, returns response as a string.

execute(Map<String, Object>) - Method in interface com.atlassian.sal.api.scheduling.PluginJob

Execute this job

execute(TransactionCallback) - Method in interface com.atlassian.sal.api.transaction.TransactionTemplate

Executes the callback, returning the object returned.

G

get(String) - Method in interface com.atlassian.sal.api.pluginsettings.PluginSettings

Gets a setting value.

getAllProjectKeys() - Method in interface com.atlassian.sal.api.project.ProjectManager

Get all project keys.

getAllTranslationsForPrefix(String, Locale) - Method in interface com.atlassian.sal.api.message.I18nResolver

Given a prefix, this method will return all translations where the key starts with the given prefix as key -> value mappings.

getArguments() - Method in interface com.atlassian.sal.api.message.Message

getBaseUrl() - Method in interface com.atlassian.sal.api.ApplicationProperties

Get the base URL of the current application.

getBuildDate() - Method in interface com.atlassian.sal.api.ApplicationProperties

getBuildNumber() - Method in interface com.atlassian.sal.api.ApplicationProperties

getBuildNumber() - Method in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

getComponent(Class<T>) - Static method in class com.atlassian.sal.api.component.ComponentLocator

Gets a component by its interface.

getComponent(Class<T>, String) - Static method in class com.atlassian.sal.api.component.ComponentLocator

Gets a component by its interface and its Id.

getComponentInternal(Class<T>) - Method in class com.atlassian.sal.api.component.ComponentLocator

Gets the requested component, to be overridden for each application

getComponentInternal(Class<T>, String) - Method in class com.atlassian.sal.api.component.ComponentLocator

Gets the requested component, to be overridden for each application

getComponents(Class<T>) - Static method in class com.atlassian.sal.api.component.ComponentLocator

Gets a components by interface.

getComponentsInternal(Class<T>) - Method in class com.atlassian.sal.api.component.ComponentLocator

getDisplayName() - Method in interface com.atlassian.sal.api.ApplicationProperties

getErrors() - Method in class com.atlassian.sal.api.search.SearchResults

getExcerpt() - Method in interface com.atlassian.sal.api.search.SearchMatch

An excerpt of the search match.

getHeader(String) - Method in interface com.atlassian.sal.api.net.Response

Get's the header by the given name

getHeaders() - Method in interface com.atlassian.sal.api.net.Response

Get a map of all the headers

getHomeDirectory() - Method in interface com.atlassian.sal.api.ApplicationProperties

getKey() - Method in interface com.atlassian.sal.api.message.Message

getLocale(HttpServletRequest) - Method in interface com.atlassian.sal.api.message.LocaleResolver

Given a request, resolve the Locale that should be used in internationalization and localization.

getLoginUri(URI) - Method in interface com.atlassian.sal.api.auth.LoginUriProvider

Returns the URI to redirect users for login.

getMatches() - Method in class com.atlassian.sal.api.search.SearchResults

getMessage() - Method in class com.atlassian.sal.api.auth.Authenticator.Result

getMessages() - Method in interface com.atlassian.sal.api.message.MessageCollection

getName() - Method in interface com.atlassian.sal.api.search.parameter.SearchParameter

getName() - Method in interface com.atlassian.sal.api.search.ResourceType

getParameter(String) - Method in interface com.atlassian.sal.api.search.query.SearchQuery

Returns value of the parameter

getParameter(String, int) - Method in interface com.atlassian.sal.api.search.query.SearchQuery

Convenient method to return integer value of parameter.

getPluginKey() - Method in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

getPrincipal() - Method in class com.atlassian.sal.api.auth.Authenticator.Result

getRemoteUsername() - Method in interface com.atlassian.sal.api.user.UserManager

Returns the username of the currently logged in user or null if no user can be found.

getRemoteUsername(HttpServletRequest) - Method in interface com.atlassian.sal.api.user.UserManager

Returns the username of the currently logged in user or null if no user can be found.

getResourceType() - Method in interface com.atlassian.sal.api.search.SearchMatch

Contains more information about the source of this match.

getResponseBodyAsStream() - Method in interface com.atlassian.sal.api.net.Response

getResponseBodyAsString() - Method in interface com.atlassian.sal.api.net.Response

getSearchString() - Method in interface com.atlassian.sal.api.search.query.SearchQuery

getSearchTime() - Method in class com.atlassian.sal.api.search.SearchResults

getShortDescription() - Method in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

getStatus() - Method in class com.atlassian.sal.api.auth.Authenticator.Result

getStatusCode() - Method in interface com.atlassian.sal.api.net.Response

getStatusText() - Method in interface com.atlassian.sal.api.net.Response

getSupportedLocales() - Method in interface com.atlassian.sal.api.message.LocaleResolver

Returns a set of all the supported locales by the host application.

getText(String, Serializable...) - Method in interface com.atlassian.sal.api.message.I18nResolver

Given a key and a list of arguments this method returns the i18ned text if it can be resolved.

getText(String) - Method in interface com.atlassian.sal.api.message.I18nResolver

Does the same as I18nResolver.getText(String, java.io.Serializable[]) however it is needed for velocity.

getText(Message) - Method in interface com.atlassian.sal.api.message.I18nResolver

Given a Message this method returns the i18ned text if it can be resolved.

getTitle() - Method in interface com.atlassian.sal.api.search.SearchMatch

Title of the search match

getTotalResults() - Method in class com.atlassian.sal.api.search.SearchResults

getType() - Method in interface com.atlassian.sal.api.search.ResourceType

getUrl() - Method in interface com.atlassian.sal.api.search.ResourceType

getUrl() - Method in interface com.atlassian.sal.api.search.SearchMatch

Absolute URL to reach this search match.

getValue() - Method in interface com.atlassian.sal.api.search.parameter.SearchParameter

getVersion() - Method in interface com.atlassian.sal.api.ApplicationProperties

H

handle(Response) - Method in interface com.atlassian.sal.api.net.ResponseHandler

Triggered when response from Request.execute(ResponseHandler) method becomes available.

I

I18nResolver - Interface in com.atlassian.sal.api.message

This interface is responsible for resolving a message or key/argument pairs to their internationalized message.

isApplicationSetUp() - Method in interface com.atlassian.sal.api.lifecycle.LifecycleManager

isEmpty() - Method in interface com.atlassian.sal.api.message.MessageCollection

isInitialized() - Static method in class com.atlassian.sal.api.component.ComponentLocator

isSuccessful() - Method in interface com.atlassian.sal.api.net.Response

isSystemAdmin(String) - Method in interface com.atlassian.sal.api.user.UserManager

Returns true or false depending on if a user has been granted the system admin permission.

isUserInGroup(String, String) - Method in interface com.atlassian.sal.api.user.UserManager

Returns whether the user is in the specify group

L

LicenseHandler - Interface in com.atlassian.sal.api.license

Interface into the license system for the individual application

LifecycleAware - Interface in com.atlassian.sal.api.lifecycle

Marks a class that wants to execute code on certain application-level lifecycle stages This only works on public components.

LifecycleManager - Interface in com.atlassian.sal.api.lifecycle

Interface to be used to trigger lifecycle events

LocaleResolver - Interface in com.atlassian.sal.api.message

This interface is responsible for resolving the current locale.

LoginUriProvider - Interface in com.atlassian.sal.api.auth

Provides the URI to redirect users to for them to login before they can authorize consumer requests to access their data.

M

MAXHITS - Static variable in interface com.atlassian.sal.api.search.parameter.SearchParameter

The parameter for the maximum number of hits to return

Message - Interface in com.atlassian.sal.api.message

Encapsulates a message before it has been resolved via an I18N resolver

MessageCollection - Interface in com.atlassian.sal.api.message

A collection of messages that haven't been resolved

O

onStart() - Method in interface com.atlassian.sal.api.lifecycle.LifecycleAware

Called when the application has started or has been restored from backup

P

PARAMETER_SEPARATOR - Static variable in interface com.atlassian.sal.api.search.query.SearchQuery

The parameter separator value

parse(String) - Method in interface com.atlassian.sal.api.search.query.SearchQueryParser

Query string submitted should already be url-encoded.

PluginJob - Interface in com.atlassian.sal.api.scheduling

A job to be executed by the PluginScheduler.

PluginScheduler - Interface in com.atlassian.sal.api.scheduling

Interface for scheduling jobs

PluginSettings - Interface in com.atlassian.sal.api.pluginsettings

Provides access to settings globally or per project/space/repository/build-plan

The following types are supported: java.lang.String java.util.List java.util.Properties java.util.Map List and Map types must contain only String.

PluginSettingsFactory - Interface in com.atlassian.sal.api.pluginsettings

Factory for mutable, non-threadsafe PluginSettings objects.

PluginUpgradeManager - Interface in com.atlassian.sal.api.upgrade

Upgrades plugins using their defined build number

PluginUpgradeTask - Interface in com.atlassian.sal.api.upgrade

A task that needs to be executed to upgrade the existing data

PROJECT - Static variable in interface com.atlassian.sal.api.search.parameter.SearchParameter

The parameter for the project name to search

ProjectManager - Interface in com.atlassian.sal.api.project

Interface to managing and getting information about "projects".

put(String, Object) - Method in interface com.atlassian.sal.api.pluginsettings.PluginSettings

Puts a setting value.

R

remove(String) - Method in interface com.atlassian.sal.api.pluginsettings.PluginSettings

Removes a setting value

Request<T extends Request<?>> - Interface in com.atlassian.sal.api.net

Interface Request represents a request to retrieve data.

Request.MethodType - Enum in com.atlassian.sal.api.net

Represents type of network request

RequestFactory<T extends Request<?>> - Interface in com.atlassian.sal.api.net

Factory to create Requests.

resolve(String) - Method in interface com.atlassian.sal.api.user.UserManager

Returns the user that made this request or null if this application does not have such a user.

ResourceType - Interface in com.atlassian.sal.api.search

Defines the more information about the search resource (ie.

Response - Interface in com.atlassian.sal.api.net

Represents the response when calling Request.execute(ResponseHandler)

ResponseException - Exception in com.atlassian.sal.api.net

This is exception is thrown by Request.execute() and ResponseHandler.handle(Response).

ResponseException() - Constructor for exception com.atlassian.sal.api.net.ResponseException

ResponseException(String, Throwable) - Constructor for exception com.atlassian.sal.api.net.ResponseException

ResponseException(String) - Constructor for exception com.atlassian.sal.api.net.ResponseException

ResponseException(Throwable) - Constructor for exception com.atlassian.sal.api.net.ResponseException

ResponseHandler - Interface in com.atlassian.sal.api.net

Callback interface used by Request.execute(ResponseHandler) method.

S

scheduleJob(String, Class<? extends PluginJob>, Map<String, Object>, Date, long) - Method in interface com.atlassian.sal.api.scheduling.PluginScheduler

Schedule the given job.

search(String, String) - Method in interface com.atlassian.sal.api.search.SearchProvider

Runs the a search given a query and returns a searchResult.

SearchMatch - Interface in com.atlassian.sal.api.search

A single match for a query (i.e.

SearchParameter - Interface in com.atlassian.sal.api.search.parameter

Allows to specify additional properties for a search in terms of string value pairs.

SearchProvider - Interface in com.atlassian.sal.api.search

Allows for simple string based searches in an application.

SearchQuery - Interface in com.atlassian.sal.api.search.query

Utility class to help with creating a query string for the SearchProvider.search(String,String) method.

SearchQueryParser - Interface in com.atlassian.sal.api.search.query

Parses a query string created by a SearchQuery to allow easy access to the various aspects of the query

SearchResults - Class in com.atlassian.sal.api.search

Provides searchresults for a query.

SearchResults(List<Message>) - Constructor for class com.atlassian.sal.api.search.SearchResults

Constructs search results that contained errors

SearchResults(List<SearchMatch>, int, long) - Constructor for class com.atlassian.sal.api.search.SearchResults

Constructs search results with successful matches

setComponentLocator(ComponentLocator) - Static method in class com.atlassian.sal.api.component.ComponentLocator

Sets the component locator to use.

setConnectionTimeout(int) - Method in interface com.atlassian.sal.api.net.Request

Setting connection timeout in milliseconds.

setHeader(String, String) - Method in interface com.atlassian.sal.api.net.Request

Sets the specified header to the request, overwriting any previous value.

setLicense(String) - Method in interface com.atlassian.sal.api.license.LicenseHandler

Sets the license string for the currently running application

setParameter(String, String) - Method in interface com.atlassian.sal.api.search.query.SearchQuery

Sets an arbitrary search parameter to the query string.

setRequestBody(String) - Method in interface com.atlassian.sal.api.net.Request

Sets the body of the request.

setRequestContentType(String) - Method in interface com.atlassian.sal.api.net.Request

Sets Content-Type of the body of the request.

setSoTimeout(int) - Method in interface com.atlassian.sal.api.net.Request

Setting socket timeout in milliseconds.

setUrl(String) - Method in interface com.atlassian.sal.api.net.Request

shouldAttemptAuthentication(HttpServletRequest) - Method in interface com.atlassian.sal.api.auth.AuthenticationController

Check whether or not authentication should be tried.

start() - Method in interface com.atlassian.sal.api.lifecycle.LifecycleManager

Triggers a start lifecycle event once and only once.

supportsHeader() - Method in interface com.atlassian.sal.api.net.RequestFactory

Indicates whether the requests can support headers

T

ThreadLocalDelegateExecutorFactory - Interface in com.atlassian.sal.api.executor

Factory to create Executor instances that delegate to a specific Executor and ensure the executed code runs in the same thread local context.

toString() - Method in enum com.atlassian.sal.api.auth.Authenticator.Result.Status

TransactionCallback - Interface in com.atlassian.sal.api.transaction

A simple callback that needs to be provided with an action to run in the doInTransaction method.

TransactionTemplate - Interface in com.atlassian.sal.api.transaction

This allows applications greater control over the transaction in which operations may be executed.

U

unscheduleJob(String) - Method in interface com.atlassian.sal.api.scheduling.PluginScheduler

Unschedule the given job

upgrade() - Method in interface com.atlassian.sal.api.upgrade.PluginUpgradeManager

Finds and upgrades all plugins, that implement PluginUpgradeTask

UserManager - Interface in com.atlassian.sal.api.user

Interface providing user based operations across various apps.

UserResolutionException - Exception in com.atlassian.sal.api.user

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.

UserResolutionException(String, Throwable) - Constructor for exception com.atlassian.sal.api.user.UserResolutionException

UserResolutionException(Throwable) - Constructor for exception com.atlassian.sal.api.user.UserResolutionException

UserResolutionException(String) - Constructor for exception com.atlassian.sal.api.user.UserResolutionException

V

valueOf(String) - Static method in enum com.atlassian.sal.api.auth.Authenticator.Result.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.sal.api.net.Request.MethodType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.sal.api.auth.Authenticator.Result.Status

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.atlassian.sal.api.net.Request.MethodType

Returns an array containing the constants of this enum type, in the order they're declared.

A B C D E G H I L M O P R S T U V