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

A

accept(ApplicationTypeVisitor<T>) - Method in interface com.atlassian.applinks.api.ApplicationType

Accepts a visitor of the type ApplicationTypeVisitor.

Anonymous - Class in com.atlassian.applinks.api.auth

This provider performs no authentication.

Anonymous() - Constructor for class com.atlassian.applinks.api.auth.Anonymous

ApplicationId - Class in com.atlassian.applinks.api

The unique ID of an ApplicationLink.

ApplicationId(String) - Constructor for class com.atlassian.applinks.api.ApplicationId

Creates a new ApplicationId.

ApplicationLink - Interface in com.atlassian.applinks.api

Represents a link to a remote application-level entity (JIRA, Confluence, Bamboo, etc).

applicationLink - Variable in class com.atlassian.applinks.api.event.ApplicationLinkEvent

ApplicationLinkAddedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an application link is added and the new primary optionally set.

ApplicationLinkAddedEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkAddedEvent

ApplicationLinkAuthConfigChangedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after the authentication configuration of an application link has changed.

ApplicationLinkAuthConfigChangedEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkAuthConfigChangedEvent

ApplicationLinkDeletedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an application link is deleted and the new primary optionally set.

ApplicationLinkDeletedEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkDeletedEvent

ApplicationLinkDetailsChangedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an application link's details (e.g., name or display URL) have changed.

ApplicationLinkDetailsChangedEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkDetailsChangedEvent

ApplicationLinkEvent - Class in com.atlassian.applinks.api.event

Base class for events emitted when an ApplicationLink is modified.

ApplicationLinkEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkEvent

ApplicationLinkMadePrimaryEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an application link has been made a primary application link.

ApplicationLinkMadePrimaryEvent(ApplicationLink) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinkMadePrimaryEvent

ApplicationLinkRequest - Interface in com.atlassian.applinks.api

A request object preconfigured with authentication information for the Application Link it was created for.

ApplicationLinkRequestFactory - Interface in com.atlassian.applinks.api

Provides authenticated ApplicationLinkRequest objects.

ApplicationLinkResponseHandler<R> - Interface in com.atlassian.applinks.api

Callback interface used by ApplicationLinkRequest.execute(ApplicationLinkResponseHandler) method.

ApplicationLinkService - Interface in com.atlassian.applinks.api

Provides methods for retrieving ApplicationLinks representing linked applications (e.g.

ApplicationLinksIDChangedEvent - Class in com.atlassian.applinks.api.event

This event is emitted by the even system when an Application Link's unique ID changed.

ApplicationLinksIDChangedEvent(ApplicationLink, ApplicationId) - Constructor for class com.atlassian.applinks.api.event.ApplicationLinksIDChangedEvent

ApplicationLinkUIService - Interface in com.atlassian.applinks.api

Generates HTML fragments to support a standardized UX for displaying and controlling application link status.

ApplicationLinkUIService.MessageBuilder - Interface in com.atlassian.applinks.api

An HTML fragment builder returned by ApplicationLinkUIService.authorisationRequest(ApplicationLink).

ApplicationLinkUIService.MessageFormat - Enum in com.atlassian.applinks.api

Constants to use in MessageBuilder#format(MessageFormat).

ApplicationType - Interface in com.atlassian.applinks.api

Represents the type of an ApplicationLink.

ApplicationTypeVisitor<T> - Interface in com.atlassian.applinks.api

Implements the visitor pattern for types.

AuthenticationConsumer - Interface in com.atlassian.applinks.api.auth

Represents the consuming end of an Authentication mechanism

AuthenticationProvider - Interface in com.atlassian.applinks.api.auth

Marker interface for all Application Links authentication providers.

AuthorisationAdminURIGenerator - Interface in com.atlassian.applinks.api

Used to generate URIs for users to view or revoke their credentials for an authorised application link.

authorisationRequest(ApplicationLink) - Method in interface com.atlassian.applinks.api.ApplicationLinkUIService

Returns a ApplicationLinkUIService.MessageBuilder to construct an HTML fragment with a "please authenticate with [application]" message, and a link that lets the user begin authentication.

AuthorisationURIGenerator - Interface in com.atlassian.applinks.api

Used to generate URIs for users to supply credentials to AuthenticationProviders.

B

BambooApplicationType - Interface in com.atlassian.applinks.api.application.bamboo

BambooProjectEntityType - Interface in com.atlassian.applinks.api.application.bamboo

BasicAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

TODO: Document this class / interface here

BitbucketApplicationType - Interface in com.atlassian.applinks.api.application.bitbucket

BitbucketProjectEntityType - Interface in com.atlassian.applinks.api.application.bitbucket

C

com.atlassian.applinks.api - package com.atlassian.applinks.api

API classes and components for interacting with the AppLinks plugin.

com.atlassian.applinks.api.application - package com.atlassian.applinks.api.application

The standard ApplicationType and EntityType classes that are bundled with the AppLinks plugin.

com.atlassian.applinks.api.application.bamboo - package com.atlassian.applinks.api.application.bamboo

com.atlassian.applinks.api.application.bitbucket - package com.atlassian.applinks.api.application.bitbucket

com.atlassian.applinks.api.application.confluence - package com.atlassian.applinks.api.application.confluence

com.atlassian.applinks.api.application.crowd - package com.atlassian.applinks.api.application.crowd

com.atlassian.applinks.api.application.fecru - package com.atlassian.applinks.api.application.fecru

com.atlassian.applinks.api.application.generic - package com.atlassian.applinks.api.application.generic

com.atlassian.applinks.api.application.jira - package com.atlassian.applinks.api.application.jira

com.atlassian.applinks.api.application.refapp - package com.atlassian.applinks.api.application.refapp

com.atlassian.applinks.api.application.stash - package com.atlassian.applinks.api.application.stash

com.atlassian.applinks.api.auth - package com.atlassian.applinks.api.auth

com.atlassian.applinks.api.auth.oauth - package com.atlassian.applinks.api.auth.oauth

com.atlassian.applinks.api.auth.types - package com.atlassian.applinks.api.auth.types

com.atlassian.applinks.api.event - package com.atlassian.applinks.api.event

Events fired from applinks to indicate key changes.

ConfluenceApplicationType - Interface in com.atlassian.applinks.api.application.confluence

ConfluenceSpaceEntityType - Interface in com.atlassian.applinks.api.application.confluence

ConsumerTokenService - Interface in com.atlassian.applinks.api.auth.oauth

Service to deal with OAuth consumer tokens

contentHtml(String) - Method in interface com.atlassian.applinks.api.ApplicationLinkUIService.MessageBuilder

Adds custom content to the message.

CorsAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

createAnonymousRequest(ApplicationLink, Request.MethodType, String) - Static method in class com.atlassian.applinks.api.auth.Anonymous

This is a convenience method for creating anonymous (unauthenticated) requests without having to catch the CredentialsRequiredException declared on the ApplicationLinkRequestFactory interface

createAuthenticatedRequestFactory() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

The ApplicationLinkRequestFactory returned by this method will choose a single AuthenticationProvider for automatically authenticating created Request objects.

createAuthenticatedRequestFactory(Class<? extends AuthenticationProvider>) - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

This method returns a ApplicationLinkRequestFactory initialised by the specified AuthenticationProvider.

createImpersonatingAuthenticatedRequestFactory() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

Creates a request factory for impersonating requests (see ImpersonatingAuthenticationProvider).

createNonImpersonatingAuthenticatedRequestFactory() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

Creates a request factory for non-impersonating requests (see NonImpersonatingAuthenticationProvider).

createRequest(Request.MethodType, String) - Method in interface com.atlassian.applinks.api.ApplicationLinkRequestFactory

Creates a request of the given method type to the given url.

credentialsRequired(Response) - Method in interface com.atlassian.applinks.api.ApplicationLinkResponseHandler

Triggered when a call to a remote server failed because the caller does not have an established session with the server and will need to authorize requests first by visiting the authorization URL provided by AuthorisationURIGenerator.

CredentialsRequiredException - Exception in com.atlassian.applinks.api

Thrown by ApplicationLinkRequestFactory.createRequest(com.atlassian.sal.api.net.Request.MethodType, java.lang.String) when the endpoint requires authentication, but no credentials are available.

CredentialsRequiredException(AuthorisationURIGenerator, String) - Constructor for exception com.atlassian.applinks.api.CredentialsRequiredException

CrowdApplicationType - Interface in com.atlassian.applinks.api.application.crowd

Application type for Crowd

D

DependsOn - Annotation Type in com.atlassian.applinks.api.auth

An annotation that describes dependency of the configuration of an AuthenticationProvider on that of others.

E

EntityLink - Interface in com.atlassian.applinks.api

Represents a link to a remote entity (Project, Space, Repository, etc).

entityLink - Variable in class com.atlassian.applinks.api.event.EntityLinkEvent

EntityLinkAddedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an entity link is added and the new primary optionally set.

EntityLinkAddedEvent(EntityLink, String, Class<? extends EntityType>) - Constructor for class com.atlassian.applinks.api.event.EntityLinkAddedEvent

EntityLinkDeletedEvent - Class in com.atlassian.applinks.api.event

This event is broadcast after an entity link is deleted and the new primary optionally set.

EntityLinkDeletedEvent(EntityLink, String, Class<? extends EntityType>) - Constructor for class com.atlassian.applinks.api.event.EntityLinkDeletedEvent

EntityLinkEvent - Class in com.atlassian.applinks.api.event

Base class for events emitted when an EntityLink is modified

EntityLinkEvent(EntityLink, String, Class<? extends EntityType>) - Constructor for class com.atlassian.applinks.api.event.EntityLinkEvent

EntityLinkService - Interface in com.atlassian.applinks.api

Provides methods for retrieving entities from linked applications that are associated with local entities (e.g.

EntityType - Interface in com.atlassian.applinks.api

Represents the type of an EntityLink.

equals(Object) - Method in class com.atlassian.applinks.api.ApplicationId

execute(ApplicationLinkResponseHandler<R>) - Method in interface com.atlassian.applinks.api.ApplicationLinkRequest

Executes the request.

F

FishEyeCrucibleApplicationType - Interface in com.atlassian.applinks.api.application.fecru

FishEyeCrucibleProjectEntityType - Interface in com.atlassian.applinks.api.application.fecru

FishEyeRepositoryEntityType - Interface in com.atlassian.applinks.api.application.fecru

format(ApplicationLinkUIService.MessageFormat) - Method in interface com.atlassian.applinks.api.ApplicationLinkUIService.MessageBuilder

Specifies whether to use a brief format (the default) or a banner format.

G

GenericApplicationType - Interface in com.atlassian.applinks.api.application.generic

The generic application type supports all "out-of-the-box" authentication types that UAL ships with.

GenericEntityType - Interface in com.atlassian.applinks.api.application.generic

The generic entity type, can be used in combination with the generic application to create entity links to this arbitrary application.

get() - Method in class com.atlassian.applinks.api.ApplicationId

getApplicationId() - Method in class com.atlassian.applinks.api.event.ApplicationLinkEvent

getApplicationId() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getApplicationLink(ApplicationId) - Method in interface com.atlassian.applinks.api.ApplicationLinkService

Retrieves an ApplicationLink by its ApplicationId.

getApplicationLink() - Method in interface com.atlassian.applinks.api.EntityLink

getApplicationLink() - Method in class com.atlassian.applinks.api.event.ApplicationLinkEvent

getApplicationLink(ApplicationId) - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLinkService

Retrieves an ReadOnlyApplicationLink by its ApplicationId.

getApplicationLinks() - Method in interface com.atlassian.applinks.api.ApplicationLinkService

Retrieves all ApplicationLinks.

getApplicationLinks(Class<? extends ApplicationType>) - Method in interface com.atlassian.applinks.api.ApplicationLinkService

Retrieves all ApplicationLinks of a particular ApplicationType.

getApplicationLinks() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLinkService

Retrieves all ReadOnlyApplicationLinks.

getApplicationLinks(Class<? extends ApplicationType>) - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLinkService

Retrieves all ReadOnlyApplicationLinks of a particular ApplicationType.

getApplicationType() - Method in interface com.atlassian.applinks.api.EntityType

getApplicationType() - Method in class com.atlassian.applinks.api.event.ApplicationLinkEvent

getApplicationType() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getAuthorisationAdminURI() - Method in interface com.atlassian.applinks.api.AuthorisationAdminURIGenerator

The URI that can be used to view or revoke authentication for the requested resource.

getAuthorisationURI(URI) - Method in interface com.atlassian.applinks.api.AuthorisationURIGenerator

The URI that can be used to configure authentication for the requested resource.

getAuthorisationURI() - Method in interface com.atlassian.applinks.api.AuthorisationURIGenerator

Provides a URI that can be used to configure authentication for the requested resource.

getAuthorisationURI() - Method in exception com.atlassian.applinks.api.CredentialsRequiredException

getAuthorisationURI(URI) - Method in exception com.atlassian.applinks.api.CredentialsRequiredException

getDisplayUrl() - Method in interface com.atlassian.applinks.api.EntityLink

getDisplayUrl(ApplicationLink, String) - Method in interface com.atlassian.applinks.api.EntityType

Given an ApplicationLink and the key of an entity on that peer, this method returns that entity's "display URL".

getDisplayUrl() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

getEntityKey() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getEntityLink() - Method in class com.atlassian.applinks.api.event.EntityLinkAddedEvent

getEntityLinks(Object, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.api.EntityLinkService

Returns the EntityLinks that are visible to the context user.

getEntityLinks(Object) - Method in interface com.atlassian.applinks.api.EntityLinkService

Returns the EntityLinks that are visible to the context user.

getEntityLinksNoPermissionCheck(Object, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.api.SubvertedEntityLinkService

getEntityLinksNoPermissionCheck(Object) - Method in interface com.atlassian.applinks.api.SubvertedEntityLinkService

getEntityType() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getHtml() - Method in interface com.atlassian.applinks.api.ApplicationLinkUIService.MessageBuilder

Returns the message/banner as an HTML string.

getI18nKey() - Method in interface com.atlassian.applinks.api.ApplicationType

getI18nKey() - Method in interface com.atlassian.applinks.api.EntityType

getIconUrl() - Method in interface com.atlassian.applinks.api.ApplicationType

Deprecated.

for removal in 6.0. Application Types should implement IconizedType in applinks-spi instead

getIconUrl() - Method in interface com.atlassian.applinks.api.EntityType

Deprecated.

for removal in 6.0. Entity types should implement IconizedType in applinks-spi instead

getId() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

This ApplicationId is subject to change if an administrator: upgrades the remote application to use Unified Application Links (and this link was created prior to the upgrade); or the remote application does not have Unified Application Links deployed, and its RPC URL changes. If you are storing the ApplicationId for any reason, your plugin should listen for the ApplicationLinksIDChangedEvent.

getKey() - Method in interface com.atlassian.applinks.api.EntityLink

getLocalKey() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getLocalType() - Method in class com.atlassian.applinks.api.event.EntityLinkEvent

getMessageKey() - Method in exception com.atlassian.applinks.api.TypeNotInstalledException

getName() - Method in interface com.atlassian.applinks.api.EntityLink

getName() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

getName() - Method in exception com.atlassian.applinks.api.TypeNotInstalledException

getOldApplicationId() - Method in class com.atlassian.applinks.api.event.ApplicationLinksIDChangedEvent

The ApplicationId that this ApplicationLink was formerly known as.

getPluralizedI18nKey() - Method in interface com.atlassian.applinks.api.EntityType

getPrimaryApplicationLink(Class<? extends ApplicationType>) - Method in interface com.atlassian.applinks.api.ApplicationLinkService

Retrieves the primary ApplicationLink of a particular ApplicationType.

getPrimaryApplicationLink(Class<? extends ApplicationType>) - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLinkService

Retrieves the primary ReadOnlyApplicationLink of a particular ApplicationType.

getPrimaryEntityLink(Object, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.api.EntityLinkService

There are exactly zero or one primary EntityLinks of each type configured for each local entity.

getProperty(String) - Method in interface com.atlassian.applinks.api.PropertySet

Gets a setting value.

getRequestFactory(String) - Method in interface com.atlassian.applinks.api.auth.ImpersonatingAuthenticationProvider

getRequestFactory() - Method in interface com.atlassian.applinks.api.auth.NonImpersonatingAuthenticationProvider

getRpcUrl() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

getRpcUrl() - Method in exception com.atlassian.applinks.api.TypeNotInstalledException

getShortenedI18nKey() - Method in interface com.atlassian.applinks.api.EntityType

getType() - Method in interface com.atlassian.applinks.api.EntityLink

getType() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

See the com.atlassian.applinks.api.application package for a list of ApplicationTypes bundled with the Unified Application Links plugin.

getType() - Method in exception com.atlassian.applinks.api.TypeNotInstalledException

H

hashCode() - Method in class com.atlassian.applinks.api.ApplicationId

I

ImpersonatingAuthenticationProvider - Interface in com.atlassian.applinks.api.auth

Impersonating authentication providers allow the caller to specify a user, on his behalf the request to the remote application is made.

isPrimary() - Method in interface com.atlassian.applinks.api.EntityLink

isPrimary() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

isSystem() - Method in interface com.atlassian.applinks.api.ReadOnlyApplicationLink

J

JiraApplicationType - Interface in com.atlassian.applinks.api.application.jira

JiraProjectEntityType - Interface in com.atlassian.applinks.api.application.jira

L

LinkEvent - Interface in com.atlassian.applinks.api.event

A marker interface for all events fired from this plugin

localKey - Variable in class com.atlassian.applinks.api.event.EntityLinkEvent

localType - Variable in class com.atlassian.applinks.api.event.EntityLinkEvent

N

NonImpersonatingAuthenticationProvider - Interface in com.atlassian.applinks.api.auth

A Non-Impersonating authentication provider means the authentication mode doesn't allow the request to be executed in the context of user as specified by the caller.

O

OAuthAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

The OAuth Authentication provider indicating that OAuth is used to authenticate to the remote application.

P

PropertySet - Interface in com.atlassian.applinks.api

Provides access to settings.

putProperty(String, Object) - Method in interface com.atlassian.applinks.api.PropertySet

Puts a setting value.

R

ReadOnlyApplicationLink - Interface in com.atlassian.applinks.api

Represents a link to a remote application-level entity (JIRA, Confluence, Bamboo, etc).

ReadOnlyApplicationLinkService - Interface in com.atlassian.applinks.api

Provides methods for retrieving ReadOnlyApplicationLinks representing linked applications (e.g.

RefAppApplicationType - Interface in com.atlassian.applinks.api.application.refapp

RefAppCharlieEntityType - Interface in com.atlassian.applinks.api.application.refapp

removeAllTokensForUsername(String) - Method in interface com.atlassian.applinks.api.auth.oauth.ConsumerTokenService

Deletes all the consumer tokens for the given user.

removeProperty(String) - Method in interface com.atlassian.applinks.api.PropertySet

Removes a setting value

S

StashApplicationType - Interface in com.atlassian.applinks.api.application.stash

Deprecated.

Stash has been renamed to Bitbucket. Please use BitbucketApplicationType instead.

StashProjectEntityType - Interface in com.atlassian.applinks.api.application.stash

Deprecated.

Stash has been renamed to Bitbucket. Please use BitbucketProjectEntityType instead.

SubvertedEntityLinkService - Interface in com.atlassian.applinks.api

Provides methods to bypass permission checking when retrieving entity links.

T

toString() - Method in class com.atlassian.applinks.api.ApplicationId

TrustedAppsAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

Deprecated.

TwoLeggedOAuthAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

The Standard 2-Legged OAuth Authentication provider.

TwoLeggedOAuthWithImpersonationAuthenticationProvider - Interface in com.atlassian.applinks.api.auth.types

The 2-Legged OAuth Authentication with Impersonation provider.

TypeNotInstalledException - Exception in com.atlassian.applinks.api

Thrown if the requested ApplicationLink or EntityLink's ApplicationType or EntityType is currently not installed.

TypeNotInstalledException(String) - Constructor for exception com.atlassian.applinks.api.TypeNotInstalledException

Deprecated.

TypeNotInstalledException(String, String, URI) - Constructor for exception com.atlassian.applinks.api.TypeNotInstalledException

V

valueOf(String) - Static method in enum com.atlassian.applinks.api.ApplicationLinkUIService.MessageFormat

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

values() - Static method in enum com.atlassian.applinks.api.ApplicationLinkUIService.MessageFormat

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

visit(BambooApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(BitbucketApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(ConfluenceApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(CrowdApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(FishEyeCrucibleApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(GenericApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(JiraApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visit(RefAppApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

visitDefault(ApplicationType) - Method in interface com.atlassian.applinks.api.ApplicationTypeVisitor

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