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

A

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

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

ApplicationType - Interface in com.atlassian.applinks.api

Represents the type of an ApplicationLink.

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

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

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

Standard Bamboo ApplicationType and EntityType type classes.

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

Standard Confluence ApplicationType and EntityType type classes.

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

Standard FishEye/Crucible ApplicationType and EntityType type classes.

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

Standard JIRA ApplicationType and EntityType type classes.

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

Standard Atlassian Reference Application ApplicationType and EntityType type classes.

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

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

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

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

This method returns a ApplicationLinkRequestFactory initialised by the specified AuthenticationProvider.

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

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

G

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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 to specify a user, on his behalf the request to the remote application is made.

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

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

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

TODO: Document this class / interface here

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

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

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

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

Removes a setting value

T

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

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

Pass this type to the ApplicationLink.createAuthenticatedRequestFactory(Class) method to obtain a RequestFactory instance that uses the Trusted Apps protocol for transparent authentication.

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

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