com.atlassian.applinks.api.ApplicationLink |
Known Indirect Subclasses |
Represents a link to a remote application-level entity (JIRA, Confluence, Bamboo, etc).
You can store simple data against ApplicationLink
s using the methods provided by the PropertySet
interface. Note that these properties are shared between all plugins in the local application, so be careful to
namespace your property keys carefully.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method returns a
ApplicationLinkRequestFactory initialised by the specified
AuthenticationProvider . | |||||||||||
The
ApplicationLinkRequestFactory returned by this method will choose a single
AuthenticationProvider for automatically authenticating created Request objects. | |||||||||||
This
ApplicationId is subject to change if an administrator:
| |||||||||||
See the
com.atlassian.applinks.api.application package for a list of ApplicationType s bundled
with the Unified Application Links plugin. | |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.atlassian.applinks.api.PropertySet
|
This method returns a ApplicationLinkRequestFactory
initialised by the specified
AuthenticationProvider
. You should use this method only if your feature requires a specific
AuthenticationProvider
implementation. Note that this method will return null if an administrator
of the local application has not configured the specified AuthenticationProvider
for this
ApplicationLink
.
providerClass | the AuthenticationProvider type to use for the RequestFactory |
---|
ApplicationLink
using an AuthenticationProvider
implementation that conforms to the supplied providerClass, or
null if no AuthenticationProvider
is configured for this ApplicationLink
. If the supplied
providerClass is AuthenticationProvider.class
this method will bind the RequestFactory
to any available AuthenticationProvider
, or return null if there are no
AuthenticationProvider
s configured. This method will only return an unauthenticated
RequestFactory if the supplied providerClass is Anonymous
.The ApplicationLinkRequestFactory
returned by this method will choose a single
AuthenticationProvider
for automatically authenticating created Request objects. The selection
algorithm is as follows:
ImpersonatingAuthenticationProvider
s are configured (for example, OAuth or Trusted
Applications), one will be used. Trusted Applications will be returned in preference to OAuth if both are configured;NonImpersonatingAuthenticationProvider
s are configured (for example,
Basic Auth), one will be usedAuthenticationProvider
s can be implemented via the extension APIs in the
applinks-spi module.
If your feature only supports a single authentication method, you should use
createAuthenticatedRequestFactory(Class)
}.ApplicationLinkRequestFactory
for creating requests that are authenticated for this
ApplicationLink
.URI
returned by this
method will have no trailing slash. e.g. "https://mydomain.com/jira"
This ApplicationId
is subject to change if an administrator:
ApplicationId
for any reason, your plugin should listen for the
ApplicationLinksIDChangedEvent
.URI
will have no trailing slash.
e.g. "http://localhost:8080/jira"
See the com.atlassian.applinks.api.application
package for a list of ApplicationType
s bundled
with the Unified Application Links plugin. Additional types can be added via the extension APIs in the
applinks-spi module.
JiraApplicationType
ApplicationLink
of its type, false otherwise