org.rvpf.base.security

Class Realm

Object

Realm

public class Realm
extends Object

Realm.

The format of the configuration properties file is:

   identifier: password [,rolename . . .]
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRYPT_PREFIX CRYPT prefix.
static Identity	UNKNOWN_IDENTITY Unknown identity.

Constructor Summary

Constructors

Constructor and Description
Realm() Constructs an instance.

Method Summary

Modifier and Type	Method and Description
Optional<Identity>	authenticate(String identifier, Object credential) Authenticates an identity.
Identity	getIdentity(Optional<String> identifier) Gets the identity for an identifier.
protected Logger	getThisLogger() Gets the logger.
boolean	isConfigured() Asks if this realm is configured.
boolean	isInRoles(Optional<String> identifier, String[] roles) Asks if an identity acts as one of the specified roles.
protected Identity	newIdentity(String identifier, Credential credential, Set<String> roles) Returns a new identity.
boolean	setUp(KeyedGroups realmProperties, SecurityContext securityContext) Sets up this.

Methods inherited from class Object

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

Field Detail

CRYPT_PREFIX

public static final String CRYPT_PREFIX

CRYPT prefix.

See Also:

Constant Field Values

UNKNOWN_IDENTITY

public static final Identity UNKNOWN_IDENTITY

Unknown identity.

Constructor Detail

Realm

public Realm()

Constructs an instance.

Method Detail

authenticate

@Nonnull
 @CheckReturnValue
public Optional<Identity> authenticate(@Nonnull
                                                                     String identifier,
                                                                     @Nonnull
                                                                     Object credential)

Authenticates an identity.

Parameters:

identifier - The identifier for the identity.

credential - The credential.

Returns:

The identity (empty on failure to identify).

getIdentity

@Nonnull
 @CheckReturnValue
public Identity getIdentity(@Nonnull
                                                          Optional<String> identifier)

Gets the identity for an identifier.

Parameters:

identifier - The optional identifier.

Returns:

The identity (may be 'unknown').

isConfigured

@CheckReturnValue
public boolean isConfigured()

Asks if this realm is configured.

Returns:

True if configured.

isInRoles

@CheckReturnValue
public boolean isInRoles(@Nonnull
                                            Optional<String> identifier,
                                            @Nonnull
                                            String[] roles)

Asks if an identity acts as one of the specified roles.

Parameters:

identifier - The optional identifier for the identity.

roles - The roles.

Returns:

True if the identity acts in one of the specified roles.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        KeyedGroups realmProperties,
                                        @Nonnull
                                        SecurityContext securityContext)

Sets up this.

Parameters:

realmProperties - The realm configuration properties.

securityContext - The security context.

Returns:

True on success.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

newIdentity

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

Returns a new identity.

Allows subclasses to extend Identity.

Parameters:

identifier - The identifier.

credential - The credential.

roles - The roles.

Returns:

The new identity.