com.atlassian.applinks.spi.link.MutatingApplicationLinkService |
Known Indirect Subclasses |
This interface adds methods for adding, updating and deleting ApplicationLink
s.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Register an outgoing
ApplicationLink | |||||||||||
Changes the value of an application link's ID.
| |||||||||||
Configures authentication on an application link
| |||||||||||
Creates an application link from this application to a remote application.
| |||||||||||
Creates a reciprocal application link from a remote application to this application.
| |||||||||||
Returns the URI of the application link resource exposed to a remote application.
| |||||||||||
Deletes an outgoing
ApplicationLink | |||||||||||
Delete the outgoing and incoming
ApplicationLink s to and from a linked application. | |||||||||||
Retrieves an
ApplicationLink by its ApplicationId . | |||||||||||
Determines whether a set of credentials belong to an administrator of a remote application.
| |||||||||||
Checks whether an application link already exists with this name
| |||||||||||
Make the specified
ApplicationLink the primary link of its ApplicationType . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.atlassian.applinks.api.ApplicationLinkService
|
Register an outgoing ApplicationLink
id | the ApplicationId of the application to create a link to |
---|---|
type | the ApplicationType of the link (use the TypeAccessor to access registered ApplicationType s) |
details | an ApplicationLinkDetails object initialised with the ApplicationLink 's details. Note that
another name may be used if an application link with this name already exists. |
ApplicationLink
Changes the value of an application link's ID. This operation does NOT emit an event.
IllegalArgumentException | if oldId does not exist.
|
---|---|
TypeNotInstalledException |
Configures authentication on an application link
applicationLink | The application link to configure |
---|---|
authenticationScenario | holder for details that are used to determine the most appropriate
AuthenticationProvider , which will be configured by this method (e.g. if
isCommonUserBase() and isTrusted() are both true,
Trusted Applications will be configured). |
username | The username of an administrator on the remote application |
password | The password of the administrator on the remote application |
AuthenticationConfigurationException | if authentication could not be configured |
---|
Creates an application link from this application to a remote application. Similar to addApplicationLink but
doesn't retrieves or automatically generates the ApplicationId
for you (depending on the
ApplicationType
's ManifestRetriever
implementation.
type | The type of the remote application |
---|---|
linkDetails | The details of the link to create |
ManifestNotFoundException | |
ManifestNotFoundException |
Creates a reciprocal application link from a remote application to this application.
remoteRpcUrl | The base URI of the remote application, for RPC purposes |
---|---|
customLocalRpcUrl | The base URI of the local application, for display purposes, or null to use the configured base URL |
username | The username of an administrator of the remote system |
password | The password of the administrator on the remote system |
NotAdministratorException | if the supplied credentials are not those of an administrator on the remote system |
---|---|
LinkCreationResponseException | if the link creation response from the remote system was invalid |
AuthenticationResponseException | if the authentication response from the remote system was invalid |
RemoteErrorListException | if the remote system reported one or more errors |
ReciprocalActionException |
Returns the URI of the application link resource exposed to a remote application.
id | The ID of the remote application |
---|
Deletes an outgoing ApplicationLink
link | the ApplicationLink to delete
|
---|
Delete the outgoing and incoming ApplicationLink
s to and from a linked application. If the (incoming)
link deletion in the remote application fails, the local (outgoing) link will not be deleted. Use
deleteApplicationLink(ApplicationLink)
to delete just the outgoing ApplicationLink
if such
behaviour is desired.
link | the ApplicationLink to delete |
---|
ReciprocalActionException | if there was an issue deleting the link from the remote application |
---|---|
CredentialsRequiredException | if a request to delete the remote application link could not be created as
the current user has not provided credentials for the remote application. See
createRequest(Request.MethodType, String) for more details.
|
Retrieves an ApplicationLink
by its ApplicationId
. Use this method only if you know the
ApplicationId
of an existing ApplicationLink
. If you storing an ApplicationId
for
future look-ups using this method, you should listen for the ApplicationLinksIDChangedEvent
to ensure
your stored ApplicationId
is kept current.
id | the ApplicationId of a stored ApplicationLink |
---|
MutableApplicationLink
object, specified by the id, or null
if it does not existTypeNotInstalledException | if the specified ApplicationLink 's ApplicationType is
not currently installed.
|
---|
Determines whether a set of credentials belong to an administrator of a remote application.
url | The base URI of the remote application |
---|---|
username | A username to check |
password | A password to check |
true
if the supplied credentials belong to administator of the remote application. false
otherwise.ResponseException | if the response from the remote application was invalid |
---|
Checks whether an application link already exists with this name
name | Name of the application link |
---|---|
id | Applink to be excluded from the result. If null, it means no link will be excluded. |
Make the specified ApplicationLink
the primary link of its ApplicationType
. Note that exactly
one primary link of each type is allowed, so this method will remove the primary flag from the current primary
link of the link's type.
id | the ApplicationId of a stored ApplicationLink |
---|
TypeNotInstalledException | if the specified ApplicationLink 's ApplicationType is
not currently installed.
|
---|