org.jboss.aerogear.android.authentication

Class AuthenticationConfiguration<CONFIGURATION extends AuthenticationConfiguration<CONFIGURATION>>

java.lang.Object

org.jboss.aerogear.android.authentication.AuthenticationConfiguration<CONFIGURATION>

Type Parameters:

CONFIGURATION - The concrete implementation of this configuration.

All Implemented Interfaces:

org.jboss.aerogear.android.Config<CONFIGURATION>

Direct Known Subclasses:

HttpBasicAuthenticationConfiguration, HttpDigestAuthenticationConfiguration

public abstract class AuthenticationConfiguration<CONFIGURATION extends AuthenticationConfiguration<CONFIGURATION>>
extends Object
implements org.jboss.aerogear.android.Config<CONFIGURATION>

Authentication Registration config.

Constructor Summary

Constructors

Constructor and Description
AuthenticationConfiguration()

Method Summary

Modifier and Type	Method and Description
CONFIGURATION	addOnAuthenticationCreatedListener(OnAuthenticationCreatedListener listener) OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.
AuthenticationModule	asModule() Creates a authenticationModule based on the current configuration and notifies all listeners
CONFIGURATION	baseURL(URL baseURL) The baseURL is the URL that any endpoints (for example, login, logout, enroll etc) will be build on.
protected abstract AuthenticationModule	buildModule() Validates configuration parameters and returns a AuthenticationModule instance.
URL	getBaseUrl() The baseURL is the URL that any endpoints (for example, login, logout, enroll etc) will be build on.
String	getName() The name is the lookup parameter which will be used by AuthenticationManager.getModule(java.lang.String).
Collection<OnAuthenticationCreatedListener>	getOnAuthenticationCreatedListeners() OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.
CONFIGURATION	setName(String name) The name is the lookup parameter which will be used by AuthenticationManager.getModule(java.lang.String).
CONFIGURATION	setOnAuthenticationCreatedListeners(Collection<OnAuthenticationCreatedListener> listeners) OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticationConfiguration

public AuthenticationConfiguration()

Method Detail

getName

public String getName()

The name is the lookup parameter which will be used by AuthenticationManager.getModule(java.lang.String). It is automatically registered when the module is built.

Specified by:

getName in interface org.jboss.aerogear.android.Config<CONFIGURATION extends AuthenticationConfiguration<CONFIGURATION>>

Returns:

the current name

setName

public CONFIGURATION setName(String name)

The name is the lookup parameter which will be used by AuthenticationManager.getModule(java.lang.String). It is automatically registered when the module is built.

Specified by:

setName in interface org.jboss.aerogear.android.Config<CONFIGURATION extends AuthenticationConfiguration<CONFIGURATION>>

Parameters:

name - a new name.

Returns:

the current configuration

getOnAuthenticationCreatedListeners

public Collection<OnAuthenticationCreatedListener> getOnAuthenticationCreatedListeners()

OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.

Returns:

the current collection.

addOnAuthenticationCreatedListener

public CONFIGURATION addOnAuthenticationCreatedListener(OnAuthenticationCreatedListener listener)

OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.

Parameters:

listener - new listener to add to the collection

Returns:

this configuration

setOnAuthenticationCreatedListeners

public CONFIGURATION setOnAuthenticationCreatedListeners(Collection<OnAuthenticationCreatedListener> listeners)

OnAuthenticationCreatedListeners are a collection of classes to be notified when the configuration of the Pipe is complete.

Parameters:

listeners - new collection to replace the current one

Returns:

this configuration

asModule

public final AuthenticationModule asModule()

Creates a authenticationModule based on the current configuration and notifies all listeners

Returns:

An AuthenticationModule based on this configuration

Throws:

IllegalStateException - if the AuthenticationModule can not be constructed.

buildModule

protected abstract AuthenticationModule buildModule()

Validates configuration parameters and returns a AuthenticationModule instance.

Returns:

An AuthenticationModule based on this configuration

Throws:

IllegalStateException - if the Pipe can not be constructed.

getBaseUrl

public URL getBaseUrl()

The baseURL is the URL that any endpoints (for example, login, logout, enroll etc) will be build on.

Returns:

the baseURL

baseURL

public CONFIGURATION baseURL(URL baseURL)

The baseURL is the URL that any endpoints (for example, login, logout, enroll etc) will be build on.

Parameters:

baseURL - a new baseURL

Returns:

the configuration objects