com.atlassian.applinks.spi.auth

Interface AutoConfiguringAuthenticatorProviderPluginModule

All Superinterfaces:

AuthenticationProviderPluginModule

public interface AutoConfiguringAuthenticatorProviderPluginModule
extends AuthenticationProviderPluginModule

Authentication provider modules implementing this interface will be exposed to the Create Application Link Wizard, and considered for initialisation during the link creation process.

Since:

3.0

Field Summary

Fields inherited from interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule

TO_PROVIDER_CLASS

Method Summary

Modifier and Type	Method and Description
void	disable(com.atlassian.sal.api.net.RequestFactory authenticatedRequestFactory, ApplicationLink applicationLink) Disables the reciprocal authentication relationship with the target ApplicationLink.
void	enable(com.atlassian.sal.api.net.RequestFactory authenticatedRequestFactory, ApplicationLink applicationLink) Initialises a working reciprocal authentication relationship with the target ApplicationLink using this authentication provider.
boolean	isApplicable(AuthenticationScenario authenticationScenario, ApplicationLink applicationLink)

Methods inherited from interface com.atlassian.applinks.spi.auth.AuthenticationProviderPluginModule

getAuthenticationProvider, getAuthenticationProviderClass, getConfigUrl

Method Detail

isApplicable

boolean isApplicable(AuthenticationScenario authenticationScenario,
                     ApplicationLink applicationLink)

Parameters:

authenticationScenario - descriptive of the relationship between the local server and the target ApplicationLink

applicationLink - the ApplicationLink that will be the target of this authentication provider configuration

Returns:

true if this authentication provider is appropriate to the supplied AuthenticationScenario for the specified ApplicationLink

enable

void enable(com.atlassian.sal.api.net.RequestFactory authenticatedRequestFactory,
            ApplicationLink applicationLink)
     throws AuthenticationConfigurationException

Initialises a working reciprocal authentication relationship with the target ApplicationLink using this authentication provider.

Parameters:

authenticatedRequestFactory - a RequestFactory initialised with the base url of the target application (see ReadOnlyApplicationLink.createAuthenticatedRequestFactory() for details) and authenticated with an administrators credentials in the remote application (using HTTP Basic authentication).

applicationLink - the ApplicationLink that will be the target of this authentication provider configuration

Throws:

AuthenticationConfigurationException - if a problem was encountered initialising the authentication relationship between the local and remote application

disable

void disable(com.atlassian.sal.api.net.RequestFactory authenticatedRequestFactory,
             ApplicationLink applicationLink)
      throws AuthenticationConfigurationException

Disables the reciprocal authentication relationship with the target ApplicationLink.

Parameters:

authenticatedRequestFactory - a RequestFactory initialised with the base url of the target application (see ReadOnlyApplicationLink.createAuthenticatedRequestFactory() for details) and authenticated with an administrators credentials in the remote application (using HTTP Basic authentication).

applicationLink - the ApplicationLink that will be the target of this authentication provider configuration change.

Throws:

AuthenticationConfigurationException - if a problem was encountered initialising the authentication relationship between the local and remote application