Package ch.tocco.nice2.security.impl.auth

Class AuthChallenge

java.lang.Object

ch.tocco.nice2.security.impl.auth.AuthChallenge

All Implemented Interfaces:

ImmutableChallenge, Challenge

public class AuthChallenge
extends Object
implements Challenge

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.security.api.auth.ImmutableChallenge

ImmutableChallenge.State

Field Summary

Fields inherited from interface ch.tocco.nice2.security.api.auth.ImmutableChallenge

CREDENTIALS_ATTRIBUTE, REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
AuthChallenge()

Method Summary

Modifier and Type	Method	Description
void	addMessage(String message)
Object	getAttribute(String key)
Map<String,Object>	getAttributes()
AuthenticationResult	getAuthenticationResult()	Returns the authentication result to this challenge.
List<String>	getMessages()
ImmutableChallenge.State	getState()	Return the overall vote.
Map<String,ImmutableChallenge.State>	getVotes()
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setAuthenticationResult(@Nullable AuthenticationResult authenticationResult)	Sets the authentication result to this challenge.
void	setWho(AuthenticationHandler who)
String	toString()
void	vote(ImmutableChallenge.State state)	Vote for this challenge with an appropriate state.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthChallenge

public AuthChallenge()

Method Details

setWho

public void setWho(AuthenticationHandler who)

getAuthenticationResult

public AuthenticationResult getAuthenticationResult()

Description copied from interface: ImmutableChallenge

Returns the authentication result to this challenge. This may be null while authentication process takes place, but must not be null on successful authentication.

Specified by:

getAuthenticationResult in interface ImmutableChallenge

setAuthenticationResult

public void setAuthenticationResult(@Nullable
 @Nullable AuthenticationResult authenticationResult)

Description copied from interface: Challenge

Sets the authentication result to this challenge.

Specified by:

setAuthenticationResult in interface Challenge

getState

public ImmutableChallenge.State getState()

Return the overall vote. ImmutableChallenge.State.SUCCESS is only returned if there are only success votes. If there is at least one failed or cancelled vote, ImmutableChallenge.State.CANCELLED is returned if there exists a cancelled vote, otherwise ImmutableChallenge.State.FAILED.

Specified by:

getState in interface ImmutableChallenge

vote

public void vote(ImmutableChallenge.State state)

Description copied from interface: Challenge

Vote for this challenge with an appropriate state.

Specified by:

vote in interface Challenge

getAttributes

public Map<String,Object> getAttributes()

Specified by:

getAttributes in interface ImmutableChallenge

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface ImmutableChallenge

setAttribute

public void setAttribute(String name,
 Object value)

Specified by:

setAttribute in interface Challenge

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface Challenge

addMessage

public void addMessage(String message)

Specified by:

addMessage in interface Challenge

getMessages

public List<String> getMessages()

Specified by:

getMessages in interface ImmutableChallenge

getVotes

public Map<String,ImmutableChallenge.State> getVotes()

Specified by:

getVotes in interface ImmutableChallenge

toString

public String toString()

Overrides:

toString in class Object