Index (Applinks - SPI 5.4.7 API)

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

A

addApplicationLink(ApplicationId, ApplicationType, ApplicationLinkDetails) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Register an outgoing ApplicationLink
addEntityLink(String, Class<? extends EntityType>, EntityLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Create an EntityLink from an entity in the local application to an entity in the remote application.
addReciprocatedEntityLink(String, Class<? extends EntityType>, EntityLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Create an EntityLink from an entity in the local application to an entity in the remote application, and a reciprocal link from the entity in the remote application back to the local entity.
ApplicationIdUtil - Class in com.atlassian.applinks.spi.application
ApplicationIdUtil() - Constructor for class com.atlassian.applinks.spi.application.ApplicationIdUtil
applicationLink(ApplicationLink) - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder
ApplicationLinkDetails - Class in com.atlassian.applinks.spi.link: POJO for holding attributes that may be updated during an ApplicationLink's life-cycle.
ApplicationLinkDetails.Builder - Class in com.atlassian.applinks.spi.link
ApplicationStatus - Enum in com.atlassian.applinks.spi.manifest
AuthenticationConfigurationException - Exception in com.atlassian.applinks.spi.auth
AuthenticationConfigurationException(String) - Constructor for exception com.atlassian.applinks.spi.auth.AuthenticationConfigurationException
AuthenticationConfigurationException(String, Throwable) - Constructor for exception com.atlassian.applinks.spi.auth.AuthenticationConfigurationException
AuthenticationConfigurationException(Throwable) - Constructor for exception com.atlassian.applinks.spi.auth.AuthenticationConfigurationException
AuthenticationConfigurationManager - Interface in com.atlassian.applinks.spi.auth: Acts as a data store for authentication providers.
AuthenticationDirection - Enum in com.atlassian.applinks.spi.auth: Used to identify the direction of invocations between two application when configuring authentication providers.
AuthenticationProviderPluginModule - Interface in com.atlassian.applinks.spi.auth: This is the interface that must be implemented by the class that is used in the authentication provider module descriptor.
AuthenticationResponseException - Exception in com.atlassian.applinks.spi.link
AuthenticationResponseException() - Constructor for exception com.atlassian.applinks.spi.link.AuthenticationResponseException
AuthenticationScenario - Interface in com.atlassian.applinks.spi.auth: Describes the relationship between two Unified Application Links enabled servers, with respect to authentication
AutoConfiguringAuthenticatorProviderPluginModule - Interface in com.atlassian.applinks.spi.auth: Authentication provider modules implementing this interface will be exposed to the Create Application Link Wizard, and considered for initialisation during the link creation process.

B

build() - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails.Builder
build() - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder
builder() - Static method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails
builder(ApplicationLinkDetails) - Static method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails: Creates a new ApplicationLinkDetails.Builder initialized with the state from the supplied ApplicationLinkDetails instance.
builder(ApplicationLink) - Static method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails: Creates a new ApplicationLinkDetails.Builder initialized with the state from the supplied ApplicationLink instance.
builder() - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory

C

changeApplicationId(ApplicationId, ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Changes the value of an application link's ID.
com.atlassian.applinks.spi - package com.atlassian.applinks.spi
com.atlassian.applinks.spi.application - package com.atlassian.applinks.spi.application
com.atlassian.applinks.spi.auth - package com.atlassian.applinks.spi.auth
com.atlassian.applinks.spi.link - package com.atlassian.applinks.spi.link
com.atlassian.applinks.spi.manifest - package com.atlassian.applinks.spi.manifest
com.atlassian.applinks.spi.util - package com.atlassian.applinks.spi.util
compareTo(TypeId) - Method in class com.atlassian.applinks.spi.application.TypeId
configureAuthenticationForApplicationLink(ApplicationLink, AuthenticationScenario, String, String) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Configures authentication on an application link
createApplicationLink(ApplicationType, ApplicationLinkDetails) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Creates an application link from this application to a remote application.
createReciprocalLink(URI, URI, String, String) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Deprecated.
will be removed in a future version, should only be used by test code
createSelfLinkFor(ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Returns the URI of the application link resource exposed to a remote application.

D

deleteApplicationLink(ApplicationLink) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Deletes an outgoing ApplicationLink
deleteEntityLink(String, Class<? extends EntityType>, EntityLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Delete an EntityLink from an entity in the local application to an entity in the remote application.
deleteEntityLinksFor(ApplicationLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Delete all EntityLinks targeting entities in the application instance specified by the supplied ApplicationLink
deleteReciprocatedApplicationLink(ApplicationLink) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Delete the outgoing and incoming ApplicationLinks to and from a linked application.
deleteReciprocatedEntityLink(String, Class<? extends EntityType>, EntityLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Delete an EntityLink from an entity in the local application to an entity in the remote application after first deleting the reciprocal link from the entity in the remote application back to the local entity.
disable(RequestFactory, ApplicationLink) - Method in interface com.atlassian.applinks.spi.auth.AutoConfiguringAuthenticatorProviderPluginModule: Disables the reciprocal authentication relationship with the target ApplicationLink.
displayUrl(URI) - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails.Builder

E

enable(RequestFactory, ApplicationLink) - Method in interface com.atlassian.applinks.spi.auth.AutoConfiguringAuthenticatorProviderPluginModule: Initialises a working reciprocal authentication relationship with the target ApplicationLink using this authentication provider.
EntityLinkBuilderFactory - Interface in com.atlassian.applinks.spi.link: Factory for providing builders with which to create EntityLinks
EntityLinkBuilderFactory.EntityLinkBuilder - Interface in com.atlassian.applinks.spi.link
equals(Object) - Method in class com.atlassian.applinks.spi.application.TypeId

G

generate(URI) - Static method in class com.atlassian.applinks.spi.application.ApplicationIdUtil: Generates a consistent, unique ApplicationId for the specified baseUri.
get() - Method in class com.atlassian.applinks.spi.application.TypeId
getApplicationLink(ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService
getApplicationStatus(URI, ApplicationType) - Method in interface com.atlassian.applinks.spi.manifest.ManifestRetriever
getApplicationType(Class<T>) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getAppLinksVersion() - Method in interface com.atlassian.applinks.spi.Manifest: Get the version of AppLinks running on the remote application.
getAuthenticationProvider(ApplicationLink) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule
getAuthenticationProviderClass() - Method in interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule: Gets the authentication provider class that this plugin module can create.
getAuthenticationProviderClass(String) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getBuildNumber() - Method in interface com.atlassian.applinks.spi.Manifest: Get the build number of the remote application.
getConfiguration(ApplicationId, Class<? extends AuthenticationProvider>) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationConfigurationManager: Returns the configuration previously stored for this application/auth pair, or null when no configuration was ever stored.
getConfigUrl(ApplicationLink, Version, AuthenticationDirection, HttpServletRequest) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule: Called by AppLinks when it renders the inbound and outbound authentication configuration.
getDisplayUrl() - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails
getEnabledApplicationTypes() - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getEnabledEntityTypes() - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getEnabledEntityTypesForApplicationType(ApplicationType) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getEntityLink(String, Class<? extends EntityType>, String, Class<? extends EntityType>, ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Retrieve an existing EntityLink that links the specified local entity to the specified remote entity, or return null if no link matching linking the specified entities exists.
getEntityLinkBuilderFactory() - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService
getEntityLinksForApplicationLink(ApplicationLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Retrieves all configured entity links for a configured application link.
getEntityLinksForKey(String, Class<? extends EntityType>, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Retrieves all EntityLinks from a local entity, filtered by the target entity's EntityType.
getEntityLinksForKey(String, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Retrieves all EntityLinks from a local entity.
getEntityType(Class<T>) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor
getErrors() - Method in exception com.atlassian.applinks.spi.link.RemoteErrorListException
getIconUri() - Method in interface com.atlassian.applinks.spi.application.IconizedType: Provides URI to retrieve an icon for this application type
getIconUri() - Method in interface com.atlassian.applinks.spi.Manifest: Get a larger icon URI of the remote application
getIconUrl() - Method in interface com.atlassian.applinks.spi.Manifest: Deprecated.
getId() - Method in interface com.atlassian.applinks.spi.application.IdentifiableType
getId() - Method in interface com.atlassian.applinks.spi.Manifest: Get the ID of this server.
getInboundAuthenticationTypes() - Method in interface com.atlassian.applinks.spi.Manifest: Get the inbound authentication types that this remote application supports.
getManifest(URI) - Method in interface com.atlassian.applinks.spi.manifest.ManifestProducer: During ApplicationLink registration via the administrative UI, the user is prompted to choose what type of remote application they are linking to.
getManifest(URI) - Method in interface com.atlassian.applinks.spi.manifest.ManifestRetriever
getManifest(URI, ApplicationType) - Method in interface com.atlassian.applinks.spi.manifest.ManifestRetriever
getName() - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails
getName() - Method in interface com.atlassian.applinks.spi.Manifest: Get the name of this server.
getOutboundAuthenticationTypes() - Method in interface com.atlassian.applinks.spi.Manifest: Get the outbound authentication types that this remote application supports.
getPrimaryEntityLinkForKey(String, Class<? extends EntityType>, Class<? extends EntityType>) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService
getRpcUrl() - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails
getStaticUrl() - Method in interface com.atlassian.applinks.spi.application.StaticUrlApplicationType: Get the URL that this application type lives at
getStatus(URI) - Method in interface com.atlassian.applinks.spi.manifest.ManifestProducer: Returns the current state of the application located at the specified Url.
getTypeId(EntityType) - Static method in class com.atlassian.applinks.spi.application.TypeId: Convenience method for looking up TypeIds from EntityTypes.
getTypeId(ApplicationType) - Static method in class com.atlassian.applinks.spi.application.TypeId: Convenience method for looking up TypeIds from ApplicationTypes.
getTypeId() - Method in interface com.atlassian.applinks.spi.Manifest: Get the type ID of the application this manifest is for.
getUrl() - Method in interface com.atlassian.applinks.spi.Manifest: Get the URL of the remote application
getUrl() - Method in exception com.atlassian.applinks.spi.manifest.ManifestNotFoundException
getVersion() - Method in interface com.atlassian.applinks.spi.Manifest: The version of the application.

H

hashCode() - Method in class com.atlassian.applinks.spi.application.TypeId
hasPublicSignup() - Method in interface com.atlassian.applinks.spi.Manifest: Whether the remote application supports public sign up.

I

IconizedType - Interface in com.atlassian.applinks.spi.application: Represents application or entity type that provides a high quality icon URI that will eventually supersedes ApplicationType#getIconUrl().
IdentifiableType - Interface in com.atlassian.applinks.spi.application
incomingEnabled(ApplicationLink) - Method in interface com.atlassian.applinks.spi.auth.IncomingTrustAuthenticationProviderPluginModule: Return true if this authentication type can be used by the application link to make request to this application.
IncomingTrustAuthenticationProviderPluginModule - Interface in com.atlassian.applinks.spi.auth: This interface can be used by AuthentiationProviderPluginModules that can also configure inbound authentication.
isAdminUserInRemoteApplication(URI, String, String) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Determines whether a set of credentials belong to an administrator of a remote application.
isApplicable(AuthenticationScenario, ApplicationLink) - Method in interface com.atlassian.applinks.spi.auth.AutoConfiguringAuthenticatorProviderPluginModule
isCommonUserBase() - Method in interface com.atlassian.applinks.spi.auth.AuthenticationScenario
isConfigured(ApplicationId, Class<? extends AuthenticationProvider>) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationConfigurationManager
isNameInUse(String, ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Checks whether an application link already exists with this name
isPrimary(boolean) - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails.Builder
isPrimary() - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails
isTrusted() - Method in interface com.atlassian.applinks.spi.auth.AuthenticationScenario

K

key(String) - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder

L

LinkCreationResponseException - Exception in com.atlassian.applinks.spi.link
LinkCreationResponseException(String, Throwable) - Constructor for exception com.atlassian.applinks.spi.link.LinkCreationResponseException
loadApplicationType(TypeId) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor: Load application type using its unique identifier represented by typeId.
loadEntityType(TypeId) - Method in interface com.atlassian.applinks.spi.util.TypeAccessor

M

makePrimary(ApplicationId) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Make the specified ApplicationLink the primary link of its ApplicationType.
makePrimary(String, Class<? extends EntityType>, EntityLink) - Method in interface com.atlassian.applinks.spi.link.MutatingEntityLinkService: Make the specified EntityLink the primary link of its EntityType for the specified local entity
Manifest - Interface in com.atlassian.applinks.spi: Describes the capabilities of a remote application.
ManifestNotFoundException - Exception in com.atlassian.applinks.spi.manifest
ManifestNotFoundException(String) - Constructor for exception com.atlassian.applinks.spi.manifest.ManifestNotFoundException
ManifestNotFoundException(String, String) - Constructor for exception com.atlassian.applinks.spi.manifest.ManifestNotFoundException
ManifestNotFoundException(String, Throwable) - Constructor for exception com.atlassian.applinks.spi.manifest.ManifestNotFoundException
ManifestProducer - Interface in com.atlassian.applinks.spi.manifest: Each application type implements and registers its own manifest retriever component.
ManifestRetriever - Interface in com.atlassian.applinks.spi.manifest
MutableApplicationLink - Interface in com.atlassian.applinks.spi.link: Interface adding mutating behaviour for ApplicationLinks
MutatingApplicationLinkService - Interface in com.atlassian.applinks.spi.link: This interface adds methods for adding, updating and deleting ApplicationLinks.
MutatingEntityLinkService - Interface in com.atlassian.applinks.spi.link

N

name(String) - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails.Builder
name(String) - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder
NonAppLinksApplicationType - Interface in com.atlassian.applinks.spi.application: This SPI interface allows additional ApplicationTypes to be registered via the administrative UI and made available to consumers via the various applinks services.
NonAppLinksEntityType - Interface in com.atlassian.applinks.spi.application: This SPI interface allows additional EntityTypes to be registered via the administrative UI and made available to consumers via the various applinks services.
NotAdministratorException - Exception in com.atlassian.applinks.spi.link
NotAdministratorException() - Constructor for exception com.atlassian.applinks.spi.link.NotAdministratorException

P

primary(boolean) - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder

R

ReciprocalActionException - Exception in com.atlassian.applinks.spi.link: Thrown when a reciprocal action, such as the deletion or creation of a link, fails in a remote application
ReciprocalActionException(String) - Constructor for exception com.atlassian.applinks.spi.link.ReciprocalActionException
ReciprocalActionException(Throwable) - Constructor for exception com.atlassian.applinks.spi.link.ReciprocalActionException
ReciprocalActionException(String, Throwable) - Constructor for exception com.atlassian.applinks.spi.link.ReciprocalActionException
registerProvider(ApplicationId, Class<? extends AuthenticationProvider>, Map<String, String>) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationConfigurationManager: Registers configuration for the specified authentication provider with the given application link.
RemoteErrorListException - Exception in com.atlassian.applinks.spi.link
RemoteErrorListException(List<String>) - Constructor for exception com.atlassian.applinks.spi.link.RemoteErrorListException
rpcUrl(URI) - Method in class com.atlassian.applinks.spi.link.ApplicationLinkDetails.Builder

S

setSystem(ApplicationId, boolean) - Method in interface com.atlassian.applinks.spi.link.MutatingApplicationLinkService: Make the ApplicationLink specified by ApplicationId a system link.
StaticUrlApplicationType - Interface in com.atlassian.applinks.spi.application: Application types can implement this interface if there is only ever one URL that they will point at.

T

TO_PROVIDER_CLASS - Static variable in interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule
toString() - Method in class com.atlassian.applinks.spi.application.TypeId
type(EntityType) - Method in interface com.atlassian.applinks.spi.link.EntityLinkBuilderFactory.EntityLinkBuilder
TypeAccessor - Interface in com.atlassian.applinks.spi.util: Provides access to singleton instances of EntityType and ApplicationType and registered AuthenticationProvider classes.
TypeId - Class in com.atlassian.applinks.spi.application
TypeId(String) - Constructor for class com.atlassian.applinks.spi.application.TypeId

U

unregisterProvider(ApplicationId, Class<? extends AuthenticationProvider>) - Method in interface com.atlassian.applinks.spi.auth.AuthenticationConfigurationManager: Removes the configuration for the specified applink/auth-provider combination.
update(ApplicationLinkDetails) - Method in interface com.atlassian.applinks.spi.link.MutableApplicationLink: Update the ApplicationLink's details

V

valueOf(String) - Static method in enum com.atlassian.applinks.spi.auth.AuthenticationDirection: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.applinks.spi.manifest.ApplicationStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.atlassian.applinks.spi.auth.AuthenticationDirection: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.applinks.spi.manifest.ApplicationStatus: Returns an array containing the constants of this enum type, in the order they are declared.

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