net.krotscheck.kangaroo.authz.common.database.entity

Class Authenticator

java.lang.Object

net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

net.krotscheck.kangaroo.authz.common.database.entity.AbstractAuthzEntity

net.krotscheck.kangaroo.authz.common.database.entity.Authenticator

All Implemented Interfaces:

Cloneable, ICreatedDateEntity, IModifiedDateEntity

@Entity
 @Indexed(index="authenticators")
 @Analyzer(definition="entity_analyzer")
public final class Authenticator
extends AbstractAuthzEntity

An authentication provider, linked to an application, containing miscellaneous configuration information for this provider.

Author:

Michael Krotscheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Authenticator.Deserializer Deserialize a reference to an Authenticator.

Constructor Summary

Constructors

Constructor and Description
Authenticator()

Method Summary

Modifier and Type	Method and Description
Client	getClient() Get the client for this authenticator.
Map<String,String>	getConfiguration() Get the current configuration, as persisted in the database.
User	getOwner() The owner of this entity.
List<AuthenticatorState>	getStates() Get the list of currently active query states.
AuthenticatorType	getType() Get the authenticator type, a string lookup key by which the authenticator is retrieved from the injection manager.
void	setClient(Client client) Set a new client for this authenticator.
void	setConfiguration(Map<String,String> configuration) Set the configuration values.
void	setStates(List<AuthenticatorState> states) Set the list of states.
void	setType(AuthenticatorType type) Set a new authenticator type.

Methods inherited from class net.krotscheck.kangaroo.common.hibernate.entity.AbstractEntity

clone, equals, getCreatedDate, getId, getModifiedDate, hashCode, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Authenticator

public Authenticator()

Method Detail

getClient

public Client getClient()

Get the client for this authenticator.

Returns:

The authenticator's client.

setClient

public void setClient(Client client)

Set a new client for this authenticator.

Parameters:

client - The new client.

getType

public AuthenticatorType getType()

Get the authenticator type, a string lookup key by which the authenticator is retrieved from the injection manager.

Returns:

The type.

setType

public void setType(AuthenticatorType type)

Set a new authenticator type.

Parameters:

type - The new type. Must match one of the IAuthenticator injection names, else will throw scope exceptions.

getConfiguration

public Map<String,String> getConfiguration()

Get the current configuration, as persisted in the database.

Returns:

The configuration.

setConfiguration

public void setConfiguration(Map<String,String> configuration)

Set the configuration values.

Parameters:

configuration - The new config values.

getStates

public List<AuthenticatorState> getStates()

Get the list of currently active query states.

Returns:

The list of states.

setStates

public void setStates(List<AuthenticatorState> states)

Set the list of states.

Parameters:

states - The list of states.

getOwner

public User getOwner()

The owner of this entity.

Specified by:

getOwner in class AbstractAuthzEntity

Returns:

This entity's owner, if it exists.