com.atlassian.applinks.spi.auth

Interface AuthenticationProviderPluginModule

All Known Subinterfaces:

AutoConfiguringAuthenticatorProviderPluginModule

public interface AuthenticationProviderPluginModule

This is the interface that must be implemented by the class that is used in the authentication provider module descriptor. It's setters are used by the module descriptor class to pass in the descriptor's configuration properties.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<AuthenticationProviderPluginModule,Class<? extends AuthenticationProvider>>	TO_PROVIDER_CLASS

Method Summary

Modifier and Type	Method and Description
AuthenticationProvider	getAuthenticationProvider(ApplicationLink link)
Class<? extends AuthenticationProvider>	getAuthenticationProviderClass() Gets the authentication provider class that this plugin module can create.
String	getConfigUrl(ApplicationLink link, org.osgi.framework.Version applicationLinksVersion, AuthenticationDirection direction, javax.servlet.http.HttpServletRequest request) Called by AppLinks when it renders the inbound and outbound authentication configuration.

Field Detail

TO_PROVIDER_CLASS

static final com.google.common.base.Function<AuthenticationProviderPluginModule,Class<? extends AuthenticationProvider>> TO_PROVIDER_CLASS

Method Detail

getAuthenticationProvider

AuthenticationProvider getAuthenticationProvider(ApplicationLink link)

Parameters:

link - an ApplicationLink to create an AuthenticationProvider for

Returns:

an AuthenticationProvider instance configured for the specified ApplicationLink, or null if this AuthenticationProvider is not configured for the specified link.

getConfigUrl

String getConfigUrl(ApplicationLink link,
                    org.osgi.framework.Version applicationLinksVersion,
                    AuthenticationDirection direction,
                    javax.servlet.http.HttpServletRequest request)

Called by AppLinks when it renders the inbound and outbound authentication configuration. The returned url is absolute. If the returned URL points to the local configuration servlet, it should respect the request url of the incoming request.

Parameters:

direction - the authentication direction (inbound or outbound)

request - the incoming request

Returns:

the url of the servlet used to configure the authenticator in the desired direction, null if there is no config screen for the given direction

getAuthenticationProviderClass

Class<? extends AuthenticationProvider> getAuthenticationProviderClass()

Gets the authentication provider class that this plugin module can create.

Returns:

authentication provider class