Module io.inverno.mod.security

Package io.inverno.mod.security.authentication.password

Class RawPassword.Encoder

java.lang.Object

io.inverno.mod.security.authentication.password.RawPassword.Encoder

All Implemented Interfaces:

Password.Encoder<RawPassword,RawPassword.Encoder>

Enclosing class:

RawPassword

public static class RawPassword.Encoder
extends Object
implements Password.Encoder<RawPassword,RawPassword.Encoder>

A raw (no-op) password encoder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Constructor Summary

Constructors

Constructor	Description
Encoder()

Method Summary

Modifier and Type	Method	Description
RawPassword	encode(String raw)	Encodes the specified raw password.
boolean	matches(String raw, String encoded)	Matches the specified raw password with the specified encoded representation.
RawPassword	recover(String encoded)	Recovers a password from its encoded representation generated with this encoder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.security.authentication.password.Password.Encoder

matches

Constructor Details

Encoder

public Encoder()

Method Details

recover

public RawPassword recover(String encoded)
                    throws PasswordException

Description copied from interface: Password.Encoder

Recovers a password from its encoded representation generated with this encoder.

Specified by:

recover in interface Password.Encoder<RawPassword,RawPassword.Encoder>

Parameters:

encoded - an encoded password representation

Returns:

a password

Throws:

PasswordException - if there was an error recovering the password or if the specified encoded representation was not generated with this encoder

encode

public RawPassword encode(String raw)
                   throws PasswordException

Description copied from interface: Password.Encoder

Encodes the specified raw password.

Specified by:

encode in interface Password.Encoder<RawPassword,RawPassword.Encoder>

Parameters:

raw - a raw password

Returns:

an encoded password

Throws:

PasswordException - if there was an error encoding the password

matches

public boolean matches(String raw,
 String encoded)
                throws PasswordException

Description copied from interface: Password.Encoder

Matches the specified raw password with the specified encoded representation.

Specified by:

matches in interface Password.Encoder<RawPassword,RawPassword.Encoder>

Parameters:

raw - a raw password

encoded - an encoded password

Returns:

true if passwords match, false otherwise

Throws:

PasswordException - if there was an error matching passwords