org.rvpf.base.security

Class Identity

Object

Identity

All Implemented Interfaces:

Principal

public class Identity
extends Object
implements Principal

Identity.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Identity(String identifier, Credential credential, Set<String> roles) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(Object credential) Authenticates.
String	getIdentifier() Gets the identifier.
String	getName()
Set<String>	getRoles() Gets the roles.
boolean	isAuthenticated() Asks if authenticated.
boolean	isInRoles(String[] roles) Asks if this identity acts in one of the specified roles.
void	reset() Resets.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Principal

equals, hashCode, implies

Constructor Detail

Identity

protected Identity(@Nonnull
                   String identifier,
                   @Nonnull
                   Credential credential,
                   @Nonnull
                   Set<String> roles)

Constructs an instance.

Parameters:

identifier - The identifier.

credential - The credential.

roles - The roles.

Method Detail

authenticate

@CheckReturnValue
public boolean authenticate(@Nonnull
                                               Object credential)

Authenticates.

Parameters:

credential - A supplied credential.

Returns:

True if authenticated.

getIdentifier

@Nonnull
 @CheckReturnValue
public String getIdentifier()

Gets the identifier.

Returns:

The identifier.

getName

public String getName()

Specified by:

getName in interface Principal

getRoles

@Nonnull
 @CheckReturnValue
public Set<String> getRoles()

Gets the roles.

Returns:

The roles.

isAuthenticated

@CheckReturnValue
public boolean isAuthenticated()

Asks if authenticated.

Returns:

True if authenticated.

isInRoles

@CheckReturnValue
public boolean isInRoles(@Nonnull
                                            String[] roles)

Asks if this identity acts in one of the specified roles.

Parameters:

roles - The roles.

Returns:

True if a role matches one of the specified roles.

reset

public void reset()

Resets.

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object