Module io.inverno.mod.security

Package io.inverno.mod.security.internal.authentication

Class GenericLoginCredentials

java.lang.Object

io.inverno.mod.security.internal.authentication.GenericLoginCredentials

All Implemented Interfaces:

Credentials, LoginCredentials, PrincipalCredentials

public class GenericLoginCredentials
extends Object
implements LoginCredentials

Generic LoginCredentials implementation.

Since:

1.5

Author:

Jeremy Kuhn

Constructor Summary

Constructors

Constructor	Description
GenericLoginCredentials(String username, Password<?,?> password)	Creates generic credentials with the specified username and password.

Method Summary

Modifier and Type	Method	Description
Password<?,?>	getPassword()	Returns the password.
String	getUsername()	Returns the unique username associated to the entity.
boolean	isLocked()	Determines whether a credentials is locked.
void	setLocked(boolean locked)	Locks/Unlocks the credentials.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericLoginCredentials

public GenericLoginCredentials(String username,
 Password<?,?> password)
                        throws InvalidCredentialsException

Creates generic credentials with the specified username and password.

Parameters:

username - the username

password - the password

Throws:

InvalidCredentialsException - if the username is blank

Method Details

getUsername

public String getUsername()

Description copied from interface: PrincipalCredentials

Returns the unique username associated to the entity.

Specified by:

getUsername in interface PrincipalCredentials

Returns:

a username

getPassword

public Password<?,?> getPassword()

Description copied from interface: LoginCredentials

Returns the password.

Specified by:

getPassword in interface LoginCredentials

Returns:

a password

isLocked

public boolean isLocked()

Description copied from interface: Credentials

Determines whether a credentials is locked.

Locked credentials should be considered invalid by authenticators when matching provided credentials with stored entity credentials.

Specified by:

isLocked in interface Credentials

Returns:

true if credentials are locked, false otherwise

setLocked

public void setLocked(boolean locked)

Locks/Unlocks the credentials.

Parameters:

locked - true to lock the credentials, false otherwise