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

A

AbstractSessionEvent - Class in com.atlassian.sal.api.events

AbstractSessionEvent(String, String) - Constructor for class com.atlassian.sal.api.events.AbstractSessionEvent

AbstractSessionEvent.Builder - Class in com.atlassian.sal.api.events

AbstractSessionEvent.Builder() - Constructor for class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

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

Adds all messages to the collection

addBasicAuthentication(String, 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

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

Adds the given product license to the host application.

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

Sets parameters of 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

apply(FeatureKeyScope) - Method in class com.atlassian.sal.api.features.FeatureKeyScopePredicate

apply(String) - Method in enum com.atlassian.sal.api.features.ValidFeatureKeyPredicate

Verify that the given string represents a valid feature key.

ATLASSIAN_DARKFEATURE_PREFIX - Static variable in interface com.atlassian.sal.api.features.DarkFeatureManager

Prefix for all dark feature specified as system property.

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 username & 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.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

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

Common license properties that appear in all the different kind of Product Licenses that may occur in Atlassian applications.

build() - Method in class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

build() - Method in class com.atlassian.sal.api.events.SessionCreatedEvent.Builder

build() - Method in class com.atlassian.sal.api.events.SessionDestroyedEvent.Builder

build() - Method in class com.atlassian.sal.api.features.EnabledDarkFeaturesBuilder

build() - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

builder() - Static method in class com.atlassian.sal.api.events.SessionCreatedEvent

builder() - Static method in class com.atlassian.sal.api.events.SessionDestroyedEvent

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

canExecuteRequest(HttpServletRequest) - Method in interface com.atlassian.sal.api.websudo.WebSudoManager

Check whether this request can be executed.

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.

canManageFeaturesForAllUsers() - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Returns true if the current acting user has permission to change dark features for all users.

checkFeatureKey(String) - Static method in enum com.atlassian.sal.api.features.ValidFeatureKeyPredicate

Ensure that the given input string is a valid feature key.

clear() - Method in interface com.atlassian.sal.api.auth.OAuthRequestVerifier

clearThreadLocalContext() - Method in interface com.atlassian.sal.api.executor.ThreadLocalContextManager

Clear the thread local context on the current thread.

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.events - package com.atlassian.sal.api.events

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

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

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

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.page - package com.atlassian.sal.api.page

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.rdbms - package com.atlassian.sal.api.rdbms

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.timezone - package com.atlassian.sal.api.timezone

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

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

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

com.atlassian.sal.api.web.context - package com.atlassian.sal.api.web.context

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

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

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

ConnectionCallback<A> - Interface in com.atlassian.sal.api.rdbms

Callback to be executed by TransactionalExecutor.execute(ConnectionCallback)

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.

createExecutor() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutorFactory

Create a transactional executor with readOnly set and requiresNew not set

createExecutor(boolean, boolean) - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutorFactory

Create a transactional executor

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

DarkFeatureEnabledCondition - Class in com.atlassian.sal.api.features

A parameterised plugin module condition for enabling modules in the presence of a dark feature.

DarkFeatureEnabledCondition(DarkFeatureManager) - Constructor for class com.atlassian.sal.api.features.DarkFeatureEnabledCondition

DarkFeatureManager - Interface in com.atlassian.sal.api.features

Provides a cross-product method for determining whether a dark feature is enabled.

DARKFEATURES_PROPERTIES_FILE_PROPERTY - Static variable in interface com.atlassian.sal.api.features.DarkFeatureManager

System property for overriding location of dark features property file.

DARKFEATURES_PROPERTIES_FILE_PROPERTY_DEFAULT - Static variable in interface com.atlassian.sal.api.features.DarkFeatureManager

Default properties file name.

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

Decodes a Platform Product License from the raw license String.

DefaultHelpPath - Class in com.atlassian.sal.api.message

Default immutable implementation of HelpPath.

DefaultHelpPath(String, String, String, String, boolean) - Constructor for class com.atlassian.sal.api.message.DefaultHelpPath

disable(String) - Method in interface com.atlassian.sal.api.features.SiteDarkFeaturesStorage

Disable the given dark feature key site wide.

DISABLE_ALL_DARKFEATURES_PROPERTY - Static variable in interface com.atlassian.sal.api.features.DarkFeatureManager

System property for disabling all dark features.

disableFeatureForAllUsers(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Disable the given dark feature for all users.

disableFeatureForCurrentUser(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Disable a dark feature for the current user only.

disableFeatureForUser(UserKey, String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Disable a dark feature for the given user only.

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

empty() - Static method in class com.atlassian.sal.api.page.PageCapabilities

enable(String) - Method in interface com.atlassian.sal.api.features.SiteDarkFeaturesStorage

Enable the given dark feature key site wide.

EnabledDarkFeatures - Class in com.atlassian.sal.api.features

Represents a set of enabled features.

EnabledDarkFeatures(ImmutableMap<FeatureKeyScope, ImmutableSet<String>>) - Constructor for class com.atlassian.sal.api.features.EnabledDarkFeatures

Create an instance of enabled features based on the given map.

EnabledDarkFeaturesBuilder - Class in com.atlassian.sal.api.features

EnabledDarkFeaturesBuilder() - Constructor for class com.atlassian.sal.api.features.EnabledDarkFeaturesBuilder

enableFeatureForAllUsers(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Enable the given dark feature all users.

enableFeatureForCurrentUser(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Enable a dark feature for the current user only.

enableFeatureForUser(UserKey, String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Enable a dark feature for the given user only.

enforceWebSudoProtection(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.sal.api.websudo.WebSudoManager

Ensure that the current request is protected by a WebSudo session.

equals(Object) - Method in class com.atlassian.sal.api.user.UserKey

execute(ResponseHandler<? super RESP>) - 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(Connection) - Method in interface com.atlassian.sal.api.rdbms.ConnectionCallback

Execute a method that uses the connection passed.

execute(ConnectionCallback<A>) - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Execute a callback which is supplied a Connection, within a transaction.

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

Deprecated.

Execute this job

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

Executes the callback, returning the object returned.

executeAndReturn(ReturningResponseHandler<? super RESP, RET>) - Method in interface com.atlassian.sal.api.net.Request

Executes the request and returns a result value.

existingTransaction() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Alter this executor so that the connection executes within an existing transaction or creates a new one if one is not present

F

FeatureKeyScope - Enum in com.atlassian.sal.api.features

The scope of an enabled feature key.

FeatureKeyScopePredicate - Class in com.atlassian.sal.api.features

FeatureKeyScopePredicate(FeatureKeyScope) - Constructor for class com.atlassian.sal.api.features.FeatureKeyScopePredicate

featuresEnabledForAllUsers(Set<String>) - Method in class com.atlassian.sal.api.features.EnabledDarkFeaturesBuilder

Set features enabled for all users which can be changed during runtime.

featuresEnabledForCurrentUser(Set<String>) - Method in class com.atlassian.sal.api.features.EnabledDarkFeaturesBuilder

Set features enabled for the current user only.

filterBy(FeatureKeyScope) - Static method in class com.atlassian.sal.api.features.FeatureKeyScopePredicate

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

Returns a list of group names.

fromLong(long) - Static method in class com.atlassian.sal.api.user.UserKey

Builds a UserKey object from a long id.

G

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

Gets a setting value.

get(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

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

Returns all the product licenses on a platform.

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

Get all project keys.

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

Gets the Support Entitlement Numbers (SENs) for all licenses in the currently running application.

getAllTranslationsForPrefix(String) - 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, using the default locale.

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.

getAlt() - Method in class com.atlassian.sal.api.message.DefaultHelpPath

getAlt() - Method in interface com.atlassian.sal.api.message.HelpPath

Alternate text for the help icon.

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

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

Deprecated.

since 2.10. This implementation is application-specific, and unreliable for a cross product plugin. Use ApplicationProperties.getBaseUrl(UrlMode) instead.

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

Get the base URL of the current application, with respect to the given UrlMode.

getBoolean(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettings

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

getContentType() - Method in class com.atlassian.sal.api.net.RequestFilePart

getDefaultTimeZone() - Method in interface com.atlassian.sal.api.timezone.TimeZoneManager

Returns the default time zone for the application.

getDescription() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the description that appears in the license.

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

Returns the display name for this application.

getEmail() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns the email address of the user associated with this profile

getEmbeddedLicenses() - Method in interface com.atlassian.sal.api.license.MultiProductLicenseDetails

Returns ProductLicenses for all products in this license that are not for this host product, and/or are not considered to be sub-products by the host product/platform.

getEnabledDarkFeatures() - Method in interface com.atlassian.sal.api.features.SiteDarkFeaturesStorage

getEntity(Class<T>) - Method in interface com.atlassian.sal.api.net.Response

Unmarshall the response body as the specified type

getErrorMessages() - Method in class com.atlassian.sal.api.validate.ValidationResult

Returns error messages.

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.

getFeatureKeys() - Method in class com.atlassian.sal.api.features.EnabledDarkFeatures

Return all enabled feature keys.

getFeatureKeys(Predicate<FeatureKeyScope>) - Method in class com.atlassian.sal.api.features.EnabledDarkFeatures

Returns all enabled feature keys matching the given criteria.

getFeaturesEnabledForAllUsers() - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

getFeaturesEnabledForCurrentUser() - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Return features enabled for the current user (must be called within the context of a request).

getFeaturesEnabledForUser(UserKey) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Return enabled features for a given user.

getFile() - Method in class com.atlassian.sal.api.net.RequestFilePart

getFileName() - Method in class com.atlassian.sal.api.net.RequestFilePart

getFullName() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns the full name of the user associated with this profile information

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.Request

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

Get a map of all the headers

getHelpPath(String) - Method in interface com.atlassian.sal.api.message.HelpPathResolver

Retrieve the help path for a key.

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

getInstance(ServletRequest) - Method in interface com.atlassian.sal.api.auth.OAuthRequestVerifierFactory

Gets an instance of an OAuthRequestVerifier object that records whether or not the request that is currently being processed has been successfully processed by the OAuth filter.

getKey() - Method in class com.atlassian.sal.api.message.DefaultHelpPath

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

The key to the help item.

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

getKeys() - Method in interface com.atlassian.sal.api.usersettings.UserSettings

getKeys() - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

getLicenseExpiryDate() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the license expiry date.

getLicenseTypeName() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the license type name exactly as it appears in the license.

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.

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

Resolve the Locale that should be used in internationalization and localization.

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

Resolve the Locale that should be used in internationalization and localization.

getLocalizedMessage() - Method in exception com.atlassian.sal.api.i18n.InvalidOperationException

Returns the error message in the locale of the currently logged in user.

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

Returns the URI to redirect users for login.

getLoginUri(URI, EnumSet<PageCapability>) - Method in interface com.atlassian.sal.api.auth.LoginUriProvider

Returns the URI to redirect users for login.

getLoginUriForRole(URI, UserRole) - Method in interface com.atlassian.sal.api.auth.LoginUriProvider

Returns the URI to redirect users for login.

getLoginUriForRole(URI, UserRole, EnumSet<PageCapability>) - Method in interface com.atlassian.sal.api.auth.LoginUriProvider

Returns the URI to redirect users for login.

getLong(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettings

getMaintenanceExpiryDate() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the Maintenance expiry date.

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

getNewLicense() - Method in interface com.atlassian.sal.api.license.LicenseChangedEvent

Returns the newly set license.

getNumberOfUsers() - Method in interface com.atlassian.sal.api.license.ProductLicense

Returns the number of users allowed by the current license.

getOrganisationName() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the Organisation Name.

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.

getParameterName() - Method in class com.atlassian.sal.api.net.RequestFilePart

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

Returns the exact ID of this application/platform, as defined in HAMS and used for licensing purposes.

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

getPreviousLicense() - Method in interface com.atlassian.sal.api.license.LicenseChangedEvent

Returns the previously set license.

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

getProductDisplayName() - Method in interface com.atlassian.sal.api.license.ProductLicense

Returns the "official" product name (e.g.

getProductKey() - Method in interface com.atlassian.sal.api.license.ProductLicense

Returns the canonical product key as defined by the respective source license.

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

Returns the list of currently available products in this host application whether these products are currently licensed or not.

getProductLicense(String) - Method in interface com.atlassian.sal.api.license.MultiProductLicenseDetails

Returns the individual product or embedded license with the given product key.

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

Returns an individual product view of the license details for the product identified by the given product key, or null if the product does not exist in any license.

getProductLicenses() - Method in interface com.atlassian.sal.api.license.MultiProductLicenseDetails

Returns ProductLicenses for the host product license (if relevant) as well as all products in this license that are direct sub-products of the current host product/platform.

getProfilePageUri() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns a URI for the user's profile page.

getProfilePictureUri(int, int) - Method in interface com.atlassian.sal.api.user.UserProfile

Returns a URI for the user's profile picture.

getProfilePictureUri() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns a URI for the user's profile picture.

getProperty(String) - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Retrieves an arbitrary property from the license.

getProperty(String) - Method in interface com.atlassian.sal.api.license.ProductLicense

Returns the license property value for the given property of this product.

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

Deprecated.

As of SAL 2.7.

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

Returns the raw license String for a given product on a platform.

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

Retrieve the unformatted message text associated with this key.

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

Retrieve the unformatted message text associated with this key.

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

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

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

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

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

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

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

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

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

Deprecated.

since 2.10, use UserManager.getRemoteUser() or UserManager.getRemoteUserKey() instead

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

Deprecated.

since 2.10, use UserManager.getRemoteUser(javax.servlet.http.HttpServletRequest) instead.

getRequest() - Method in interface com.atlassian.sal.api.web.context.HttpContext

Returns the active HTTP request or null if one cannot be found.

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

Contains more information about the source of this match.

getResponse() - Method in exception com.atlassian.sal.api.net.ResponseStatusException

Returns the actual response, allowing further inspection of the status code and error message.

getResponse() - Method in interface com.atlassian.sal.api.web.context.HttpContext

Returns the active HTTP response or null if one cannot be found.

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

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

getSchemaName() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Returns the configured schema name (if any), for connections provided during TransactionalExecutor.execute(ConnectionCallback).

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

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

getServerId() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the Server-ID as it appears in this license.

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

Gets the server ID of the currently running application.

getSession(boolean) - Method in interface com.atlassian.sal.api.web.context.HttpContext

Returns the session associated with the active request or, if there is no current session and create is true, returns a new session.

getSessionId() - Method in class com.atlassian.sal.api.events.AbstractSessionEvent

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

getString(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettings

getStringValue() - Method in class com.atlassian.sal.api.user.UserKey

Returns a string representation of the current key.

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

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

getSupportEntitlementNumber() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns the Support Entitlement Number (SEN) for this license.

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

Deprecated.

Get the license details and call BaseLicenseDetails.getSupportEntitlementNumber(). Since 3.0.

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 formatted with the arguments if the key can be resolved. otherwise, the key itself will be returned (after formatting). Arguments may also be of the form Message which means they will be resolved as well before being included as an argument.

getText(Locale, 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 formatted with the arguments if the key can be resolved. otherwise, the key itself will be returned (after formatting). Arguments may also be of the form Message which means they will be resolved as well before being included as an argument.

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(Locale, String) - Method in interface com.atlassian.sal.api.message.I18nResolver

Does the same as I18nResolver.getText(Locale, 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 formatted with the message arguments if the message key can be resolved. Otherwise, returns the message key (formatted with the message arguments). Uses the default locale.

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

Given a Message this method: returns the i18ned text formatted with the message arguments if the message key can be resolved. Otherwise, returns the message key (formatted with the message arguments).

getThreadLocalContext() - Method in interface com.atlassian.sal.api.executor.ThreadLocalContextManager

Get the thread local context of the current thread.

getTitle() - Method in class com.atlassian.sal.api.message.DefaultHelpPath

getTitle() - Method in interface com.atlassian.sal.api.message.HelpPath

Title attribute on the help link (the tooltip).

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 class com.atlassian.sal.api.message.DefaultHelpPath

getUrl() - Method in interface com.atlassian.sal.api.message.HelpPath

The full URL to the help content for this link.

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.

getUserKey() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns the key of the user associated with this profile information.

getUserName() - Method in class com.atlassian.sal.api.events.AbstractSessionEvent

getUsername() - Method in interface com.atlassian.sal.api.user.UserProfile

Returns the username of the user associated with this profile information.

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

Returns a UserProfile object for the specified user or null if no user can be found

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

Returns a UserProfile object for the specified user or null if no user can be found

getUserSettings(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsService

Deprecated.

since 2.10, use UserSettingsService.getUserSettings(com.atlassian.sal.api.user.UserKey) instead

getUserSettings(UserKey) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsService

Gets the UserSettings for the given user.

getUserTimeZone() - Method in interface com.atlassian.sal.api.timezone.TimeZoneManager

Returns the time zone of the logged in user.

getUserTimeZone(UserKey) - Method in interface com.atlassian.sal.api.timezone.TimeZoneManager

Returns the time zone of the given user.

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

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

getWarningMessages() - Method in class com.atlassian.sal.api.validate.ValidationResult

Returns warnings messages.

getXsrfParameterName() - Method in interface com.atlassian.sal.api.xsrf.XsrfTokenValidator

Returns the name of the http parameter name that is used to store the xsrf token in the form.

getXsrfToken(HttpServletRequest, HttpServletResponse, boolean) - Method in interface com.atlassian.sal.api.xsrf.XsrfTokenAccessor

Get the persistent token for the given request, that is, the token stored in the users session or in a cookie, not the token submitted as part of a form.

H

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

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

handle(T) - Method in interface com.atlassian.sal.api.net.ReturningResponseHandler

Triggered when response from Request.executeAndReturn(ReturningResponseHandler) method becomes available.

hasErrors() - Method in class com.atlassian.sal.api.validate.ValidationResult

Return true if the validation added error messages.

hashCode() - Method in class com.atlassian.sal.api.user.UserKey

hasWarnings() - Method in class com.atlassian.sal.api.validate.ValidationResult

Return true if the validation added warning messages.

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

Link to product specific help displayed in the UI.

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

Help path resolver.

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

Returns true if it is possible to add custom products on top of this platform.

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

Use this to figure out if this host application uses a single global license, or if it is a platform that can take multiple Product licenses.

HttpContext - Interface in com.atlassian.sal.api.web.context

Provides access to the key objects provided by the servlet API when processing an HTTP request.

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.

init(Map<String, String>) - Method in class com.atlassian.sal.api.features.DarkFeatureEnabledCondition

InvalidFeatureKeyException - Exception in com.atlassian.sal.api.features

InvalidFeatureKeyException(String) - Constructor for exception com.atlassian.sal.api.features.InvalidFeatureKeyException

InvalidOperationException - Exception in com.atlassian.sal.api.i18n

Thrown if the application decides that the attempted operation is not allowed for some reason.

InvalidOperationException(String, String) - Constructor for exception com.atlassian.sal.api.i18n.InvalidOperationException

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

Deprecated.

since 2.10, use UserManager.isAdmin(UserKey) instead

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

Returns true or false depending on whether a user has been granted the administrator permission.

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

isDataCenter() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns true if this is a "Data Center" license.

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

isEnterpriseLicensingAgreement() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns true if this is an "Enterprise Licensing Agreement" license.

isEvaluationLicense() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns true if this is an evaluation license.

isFeatureEnabled(String) - Method in class com.atlassian.sal.api.features.EnabledDarkFeatures

Check that the given feature is enabled

isFeatureEnabledForAllUsers(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Checks if a dark feature is enabled for all users, regardless whether the feature can be changed during runtime or not.

isFeatureEnabledForCurrentUser(String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Checks if a dark feature is enabled for all users or for the current user only (must be called within the context of a request).

isFeatureEnabledForUser(UserKey, String) - Method in interface com.atlassian.sal.api.features.DarkFeatureManager

Checks if a dark feature is enabled for all users or just for the given user.

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

isLocal() - Method in class com.atlassian.sal.api.message.DefaultHelpPath

isLocal() - Method in interface com.atlassian.sal.api.message.HelpPath

Flag to indicate this is a local URL, A local path is within the application context.

isPerpetualLicense() - Method in interface com.atlassian.sal.api.license.BaseLicenseDetails

Returns true if this license never expires.

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

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

Deprecated.

since 2.10, use UserManager.isSystemAdmin(UserKey) instead

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

Returns true or false depending on whether a user has been granted the system administrator permission.

isUnlimitedNumberOfUsers() - Method in interface com.atlassian.sal.api.license.ProductLicense

Returns true if this license authorises an unlimited number of users.

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

Deprecated.

since 2.10, use UserManager.isUserInGroup(UserKey, String) instead

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

Returns whether the given user is in the given group

isValid() - Method in class com.atlassian.sal.api.validate.ValidationResult

Return true if the validation passed, false if there were errors.

isValidFeatureKey(String) - Static method in enum com.atlassian.sal.api.features.ValidFeatureKeyPredicate

Verify that the given string represents a valid feature key.

isValidHeaderValue(String) - Method in class com.atlassian.sal.api.xsrf.XsrfHeaderValidator

Returns true if the given header value is valid for the TOKEN_HEADER header.

isVerified() - Method in interface com.atlassian.sal.api.auth.OAuthRequestVerifier

L

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

This event gets thrown whenever the host application license changes.

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

Interface into the license system for the underlying application.

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

Marker interface that indicates a component wishes to execute some code after application startup.

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

Triggers lifecycle events on LifecycleAware components.

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

marshal(UserKey) - Method in class com.atlassian.sal.api.user.UserKeyXmlAdapter

MAX_KEY_LENGTH - Static variable in interface com.atlassian.sal.api.usersettings.UserSettingsService

Key length is limited by DB constraints.

MAX_STRING_VALUE_LENGTH - Static variable in interface com.atlassian.sal.api.usersettings.UserSettingsService

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

MissingPermissionException - Exception in com.atlassian.sal.api.features

MissingPermissionException(String) - Constructor for exception com.atlassian.sal.api.features.MissingPermissionException

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

Provides access to the one or more individual products that may appear in a single license.

N

newTransaction() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Alter this executor so that it executes in a new transaction, regardless of any existing

NONE - Static variable in class com.atlassian.sal.api.features.EnabledDarkFeatures

Shorthand in case there are no enabled dark features or they are disabled

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

HttpClientRequestFactory implements this interface.

O

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

Used to store whether a request has successfully passed through the OAuth filter in some way.

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

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

Notification that the plugin is enabled and the application is started, including after being restored from backup.

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

Notification that the plugin is going to be stopped.

P

PageCapabilities - Class in com.atlassian.sal.api.page

Util class for creating empty enum set, parsing string and valueOf function

PageCapabilities() - Constructor for class com.atlassian.sal.api.page.PageCapabilities

PageCapability - Enum in com.atlassian.sal.api.page

Login page capabilities, implementation should provide a page which matches behavior/look requirements from those capabilities.

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.

PLATFORM_BAMBOO - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_BITBUCKET - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_CONFLUENCE - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_CROWD - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_FECRU - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_JIRA - Static variable in interface com.atlassian.sal.api.ApplicationProperties

PLATFORM_STASH - Static variable in interface com.atlassian.sal.api.ApplicationProperties

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

Deprecated.

in 3.0 for removal in 4.0. Use Atlassian Scheduler instead

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

Deprecated.

in 3.0 for removal in 4.0. Use Atlassian Scheduler instead

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

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

Represents license information for an individual role-based "Product" that lives on a platform.

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.

put(String, String) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

put(String, boolean) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

put(String, long) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

R

RdbmsException - Exception in com.atlassian.sal.api.rdbms

This exception is thrown by com.atlassian.sal.api.rdbms implementations in cases when interaction with a database fails

RdbmsException(String) - Constructor for exception com.atlassian.sal.api.rdbms.RdbmsException

RdbmsException(String, Throwable) - Constructor for exception com.atlassian.sal.api.rdbms.RdbmsException

RdbmsException(Throwable) - Constructor for exception com.atlassian.sal.api.rdbms.RdbmsException

readOnly() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Alter this executor so that the connection is read-only

readWrite() - Method in interface com.atlassian.sal.api.rdbms.TransactionalExecutor

Alter this executor so that the connection is read-write

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

Removes a setting value

remove(String) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsBuilder

remove an entry from the builder

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

Removes the product license for the given productKey.

Request<T extends Request<?,?>,RESP extends Response> - 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.

RequestFilePart - Class in com.atlassian.sal.api.net

RequestFilePart(String, String, File, String) - Constructor for class com.atlassian.sal.api.net.RequestFilePart

RequestFilePart(File, String) - Constructor for class com.atlassian.sal.api.net.RequestFilePart

requestHasValidXsrfHeader(HttpServletRequest) - Method in class com.atlassian.sal.api.xsrf.XsrfHeaderValidator

Returns true if the given HttpServletRequest contains a valid TOKEN_HEADER header.

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)

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

Thrown by Request methods to indicate that the request failed because a connection could not be established within the timeout interval.

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

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

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

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

This 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<T extends Response> - Interface in com.atlassian.sal.api.net

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

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

Thrown by Request methods to indicate that the request failed because the server did not comply with the request protocol.

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

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

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

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

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.

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

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

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

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

Thrown by Request.execute() to indicate that the request was unsuccessful based on the response's status code.

ResponseStatusException(String, Response) - Constructor for exception com.atlassian.sal.api.net.ResponseStatusException

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

Thrown by Request methods to indicate that the request failed because the server did not response in time.

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

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

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

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

Thrown by Request methods to indicate that the request failed because of an I/O error in the underlying protocol.

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

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

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

ReturningResponseHandler<T extends Response,R> - Interface in com.atlassian.sal.api.net

Callback interface used by the Request.executeAndReturn(ReturningResponseHandler) method.

S

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

Deprecated.

Schedule the given job.

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

Deprecated.

since 2.10, use SearchProvider.search(com.atlassian.sal.api.user.UserKey, String) instead.

search(UserKey, 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

SEPARATOR - Static variable in class com.atlassian.sal.api.page.PageCapabilities

SessionCreatedEvent - Class in com.atlassian.sal.api.events

Represents an event published when a http session is created.

SessionCreatedEvent.Builder - Class in com.atlassian.sal.api.events

SessionDestroyedEvent - Class in com.atlassian.sal.api.events

Represents an event published when a http session is destroyed.

SessionDestroyedEvent.Builder - Class in com.atlassian.sal.api.events

sessionId - Variable in class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

sessionId(String) - Method in class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

sessionId - Variable in class com.atlassian.sal.api.events.AbstractSessionEvent

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.

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

Set an entity as the request body

setFiles(List<RequestFilePart>) - Method in interface com.atlassian.sal.api.net.Request

Sets file parts of the request.

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

Sets whether the request should transparently follow a redirect from the server.

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

Deprecated.

Use LicenseHandler.addProductLicense(String, String) instead. Since 3.0.

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.

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

Sets the body of the request.

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

Setting socket timeout in milliseconds.

setThreadLocalContext(C) - Method in interface com.atlassian.sal.api.executor.ThreadLocalContextManager

Set the thread local context on the current thread.

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

setVerified(boolean) - Method in interface com.atlassian.sal.api.auth.OAuthRequestVerifier

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

Check whether or not authentication should be tried.

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.sal.api.features.DarkFeatureEnabledCondition

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

A "view" on top of a license that is in the context of a single given product.

SiteDarkFeaturesStorage - Interface in com.atlassian.sal.api.features

Persist site wide dark feature keys.

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

Triggers LifecycleAware.onStart() on all enabled LifecycleAware components.

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

Indicates whether the requests can support headers

T

ThreadLocalContextManager<C> - Interface in com.atlassian.sal.api.executor

Manager for retrieving and storing a single object which represents all thread local state.

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.

TimeZoneManager - Interface in com.atlassian.sal.api.timezone

TOKEN_HEADER - Static variable in class com.atlassian.sal.api.xsrf.XsrfHeaderValidator

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

toString() - Method in class com.atlassian.sal.api.features.EnabledDarkFeatures

toString(EnumSet<PageCapability>) - Static method in class com.atlassian.sal.api.page.PageCapabilities

toString() - Method in class com.atlassian.sal.api.user.UserKey

TransactionalExecutor - Interface in com.atlassian.sal.api.rdbms

Interface allowing the user to execute a callback with a Connection, in the context of a transaction.

TransactionalExecutorFactory - Interface in com.atlassian.sal.api.rdbms

Provided by the host application for creating TransactionalExecutor.

TransactionCallback<T> - 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

UNLIMITED_USER_COUNT - Static variable in interface com.atlassian.sal.api.license.ProductLicense

unmarshal(String) - Method in class com.atlassian.sal.api.user.UserKeyXmlAdapter

unmodifiableFeaturesEnabledForAllUsers(Set<String>) - Method in class com.atlassian.sal.api.features.EnabledDarkFeaturesBuilder

Set features enabled for all users which cannot be changed during runtime.

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

Deprecated.

Unschedule the given job.

updateUserSettings(String, Function<UserSettingsBuilder, UserSettings>) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsService

Deprecated.

since 2.10, use UserSettingsService.updateUserSettings(com.atlassian.sal.api.user.UserKey, com.google.common.base.Function) instead

updateUserSettings(UserKey, Function<UserSettingsBuilder, UserSettings>) - Method in interface com.atlassian.sal.api.usersettings.UserSettingsService

Updates the UserSettings stored for this user.

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

Finds and upgrades all plugins, that implement PluginUpgradeTask

UrlMode - Enum in com.atlassian.sal.api

The kind of URL to return from methods that accept this as a parameter.

USER_SETTINGS_PREFIX - Static variable in interface com.atlassian.sal.api.usersettings.UserSettingsService

UserKey - Class in com.atlassian.sal.api.user

Represents an identifier that uniquely identifies a user for the duration of its existence.

UserKey(String) - Constructor for class com.atlassian.sal.api.user.UserKey

Default constructor: builds a UserKey from its string representation.

UserKeyXmlAdapter - Class in com.atlassian.sal.api.user

A JAXB XmlAdapter which converts to and from UserKey objects.

UserKeyXmlAdapter() - Constructor for class com.atlassian.sal.api.user.UserKeyXmlAdapter

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

Interface providing user based operations across various apps.

userName - Variable in class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

userName(String) - Method in class com.atlassian.sal.api.events.AbstractSessionEvent.Builder

userName - Variable in class com.atlassian.sal.api.events.AbstractSessionEvent

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

Interface encapsulating a user's profile information.

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

UserRole - Enum in com.atlassian.sal.api.user

Enforce certain level of privileges on log in page

UserSettings - Interface in com.atlassian.sal.api.usersettings

An immutable container of user-specific settings.

UserSettingsBuilder - Interface in com.atlassian.sal.api.usersettings

A builder for UserSettings

UserSettingsService - Interface in com.atlassian.sal.api.usersettings

Service 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.

V

valid() - Static method in class com.atlassian.sal.api.validate.ValidationResult

validateFormEncodedToken(HttpServletRequest) - Method in interface com.atlassian.sal.api.xsrf.XsrfTokenValidator

Validate a form encoded token.

validateProductLicense(String, String, Locale) - Method in interface com.atlassian.sal.api.license.LicenseHandler

Validates that the given license is valid to add for the given product.

validateRequestPassesXsrfChecks(HttpServletRequest) - Method in interface com.atlassian.sal.api.xsrf.XsrfRequestValidator

Returns true iff the given request has a valid csrf token or a valid csrf header.

ValidationResult - Class in com.atlassian.sal.api.validate

ValidFeatureKeyPredicate - Enum in com.atlassian.sal.api.features

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

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.features.FeatureKeyScope

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

valueOf(String) - Static method in enum com.atlassian.sal.api.features.ValidFeatureKeyPredicate

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.

valueOf(String) - Static method in class com.atlassian.sal.api.page.PageCapabilities

valueOf(String) - Static method in enum com.atlassian.sal.api.page.PageCapability

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

valueOf(String) - Static method in enum com.atlassian.sal.api.UrlMode

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

valueOf(String) - Static method in enum com.atlassian.sal.api.user.UserRole

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 are declared.

values() - Static method in enum com.atlassian.sal.api.features.FeatureKeyScope

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

values() - Static method in enum com.atlassian.sal.api.features.ValidFeatureKeyPredicate

Returns an array containing the constants of this enum type, in the order they are 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 are declared.

values() - Static method in enum com.atlassian.sal.api.page.PageCapability

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

values() - Static method in enum com.atlassian.sal.api.UrlMode

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

values() - Static method in enum com.atlassian.sal.api.user.UserRole

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

W

WebSudoManager - Interface in com.atlassian.sal.api.websudo

Allows the client to request WebSudo protection from the host application.

WebSudoNotRequired - Annotation Type in com.atlassian.sal.api.websudo

Any Element marked with this annotation will bypass the WebSudo protection.

WebSudoRequired - Annotation Type in com.atlassian.sal.api.websudo

Elements marked with this annotation will require WebSudo protection.

WebSudoSessionException - Exception in com.atlassian.sal.api.websudo

Thrown if there is a problem with the WebSudo session (missing or expired) for a request that requires WebSudo.

WebSudoSessionException() - Constructor for exception com.atlassian.sal.api.websudo.WebSudoSessionException

WebSudoSessionException(String) - Constructor for exception com.atlassian.sal.api.websudo.WebSudoSessionException

WebSudoSessionException(String, Throwable) - Constructor for exception com.atlassian.sal.api.websudo.WebSudoSessionException

willExecuteWebSudoRequest(HttpServletRequest) - Method in interface com.atlassian.sal.api.websudo.WebSudoManager

Mark the current request as a request for a WebSudo protected resource.

withErrorAndWarningMessages(Iterable<String>, Iterable<String>) - Static method in class com.atlassian.sal.api.validate.ValidationResult

withErrorMessages(Iterable<String>) - Static method in class com.atlassian.sal.api.validate.ValidationResult

withWarningMessages(Iterable<String>) - Static method in class com.atlassian.sal.api.validate.ValidationResult

X

XsrfHeaderValidator - Class in com.atlassian.sal.api.xsrf

Provides an implementation of checking if a request or a header value contains a valid TOKEN_HEADER header.

XsrfHeaderValidator() - Constructor for class com.atlassian.sal.api.xsrf.XsrfHeaderValidator

XsrfRequestValidator - Interface in com.atlassian.sal.api.xsrf

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.

XsrfTokenAccessor - Interface in com.atlassian.sal.api.xsrf

Gives access to the applications XSRF tokens

XsrfTokenValidator - Interface in com.atlassian.sal.api.xsrf

Verifies that a submitted token is valid.

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