java.lang.Object | |
↳ | com.atlassian.applinks.core.link.DefaultApplicationLink |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
The
ApplicationLinkRequestFactory returned by this method will choose a single
AuthenticationProvider for automatically authenticating created Request objects. | |||||||||||
This method returns a
ApplicationLinkRequestFactory initialised by the specified
AuthenticationProvider . | |||||||||||
This
ApplicationId is subject to change if an administrator:
| |||||||||||
Gets a setting value.
| |||||||||||
See the
com.atlassian.applinks.api.application package for a list of ApplicationType s bundled
with the Unified Application Links plugin. | |||||||||||
Puts a setting value.
| |||||||||||
Removes a setting value
| |||||||||||
Sets the primary flag of the
ApplicationLink to true. | |||||||||||
Update the ApplicationLink's details
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.applinks.api.ApplicationLink
| |||||||||||
From interface
com.atlassian.applinks.api.PropertySet
| |||||||||||
From interface
com.atlassian.applinks.core.link.InternalApplicationLink
| |||||||||||
From interface
com.atlassian.applinks.spi.link.MutableApplicationLink
|
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
.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
.This ApplicationId
is subject to change if an administrator:
ApplicationId
for any reason, your plugin should listen for the
ApplicationLinksIDChangedEvent
.Gets a setting value.
key | The setting key. Cannot be null |
---|
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
Puts a setting value. Note that the namespace for this key is shared between all applinks consumers. If you don't want a different plugin to override a property you have set, ensure that you use a unique key. A good way to do this is to prefix the key with your plugin key, which is guaranteed to be globally unique.
key | Setting key. Cannot be null |
---|---|
value | Setting value. Must be one of String , List, Properties or null. a null value is equivalent to removeProperty(String) |
Removes a setting value
key | The setting key |
---|
Sets the primary flag of the ApplicationLink
to true.
NOTE: it does not mutate other stored ApplicationLink
s. Setting multiple
ApplicationLink
s as 'primary' will leave the application in an inconsistent
state.
isPrimary | the new value of the primary flag. |
---|
Update the ApplicationLink's details
details | the details of the ApplicationLink. Note that all field values will be set to
the values of the provided ApplicationLinkDetails object, including null values.
Note that this method has no protection against setting two application links to the same name,
which must be avoided.
|
---|