org.rvpf.base.util

Class LoginInfo

Object

LoginInfo

@Immutable
public final class LoginInfo
extends Object

Login informations.

Holds login informations: the user identification and its associated password.

Constructor Summary

Constructors

Constructor and Description
LoginInfo(Optional<String> user, Optional<char[]> password) Constructs a login info instance.

Method Summary

Modifier and Type	Method and Description
Optional<char[]>	getPassword() Gets the password.
Optional<String>	getUser() Gets the user.
boolean	isEnabled() Asks if this login info is enabled.

Methods inherited from class Object

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

Constructor Detail

LoginInfo

public LoginInfo(@Nonnull
                 Optional<String> user,
                 @Nonnull
                 Optional<char[]> password)

Constructs a login info instance.

Parameters:

user - The user to associate with the session.

password - The password authenticating the user.

Method Detail

getPassword

@Nonnull
 @CheckReturnValue
public Optional<char[]> getPassword()

Gets the password.

The password will be empty if and only if the user is empty.

Returns:

The optional password.

getUser

@Nonnull
 @CheckReturnValue
public Optional<String> getUser()

Gets the user.

Returns:

The optional user.

isEnabled

@CheckReturnValue
public boolean isEnabled()

Asks if this login info is enabled.

Returns:

True if enabled.