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

Method Summary

AuthenticationProvider	getAuthenticationProvider(ApplicationLink link)
java.lang.Class<? extends AuthenticationProvider>	getAuthenticationProviderClass()
java.lang.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.

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

java.lang.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

getAuthenticationProviderClass

java.lang.Class<? extends AuthenticationProvider> getAuthenticationProviderClass()