Package org.forgerock.opendj.security.hash

Interface PasswordEncodingService<REQ extends PasswordEncodingRequest>

Type Parameters:

REQ - The type of request to send to encode a password.

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

BcryptPasswordEncodingService, PBKDF2PasswordEncodingService

All Known Implementing Classes:

AbstractRemotePasswordEncodingService, LocalBcryptPasswordEncodingService, LocalPBKDF2PasswordEncodingService, RemoteBcryptPasswordEncodingService, RemotePBKDF2PasswordEncodingService

public interface PasswordEncodingService<REQ extends PasswordEncodingRequest>
extends Closeable

Base class that holds the configuration for the different implementations of the remote password encoding service.

Method Summary

Modifier and Type	Method	Description
default void	close()	Finalize the service, free the resources.
byte[]	encode(REQ encodingRequest)	Encode a password, according to the parameters held by the encoding request.

Method Details

encode

byte[] encode(REQ encodingRequest)
       throws PasswordEncodingException

Encode a password, according to the parameters held by the encoding request.

Parameters:

encodingRequest - The parameters to encode the password.

Returns:

The encoded password

Throws:

PasswordEncodingException - in case of any errors during the encoding.

close

default void close()

Finalize the service, free the resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable