org.pentaho.di.core.encryption

Interface TwoWayPasswordEncoderInterface

All Known Implementing Classes:

KettleTwoWayPasswordEncoder

public interface TwoWayPasswordEncoderInterface

Method Summary

Modifier and Type	Method and Description
String	decode(String encodedPassword) Decode a password which does NOT have a prefix attached.
String	decode(String encodedPassword, boolean optionallyEncrypted) Decode a password.
String	encode(String password) Encode the raw password, include a prefix indicating the type of encryption used.
String	encode(String password, boolean includePrefix) Encode a password.
String[]	getPrefixes()
void	init() Initialize the password encoder by loading key details from the environment (kettle.properties or system settings).

Method Detail

init

void init()
   throws KettleException

Initialize the password encoder by loading key details from the environment (kettle.properties or system settings).

Throws:

KettleException

encode

String encode(String password)

Encode the raw password, include a prefix indicating the type of encryption used.

Parameters:

password - The password to encode

Returns:

The encoded password string

encode

String encode(String password,
              boolean includePrefix)

Encode a password.

Parameters:

password - The password to encode

includePrefix - True if a prefix needs to be encoded

Returns:

The encoded password string

decode

String decode(String encodedPassword,
              boolean optionallyEncrypted)

Decode a password.

Parameters:

encodedPassword - The encoded password with or without a prefix

optionallyEncrypted - Set to true if the password is optionally encrypted (indicated by a prefix).

Returns:

The decoded password string

decode

String decode(String encodedPassword)

Decode a password which does NOT have a prefix attached.

Parameters:

encodedPassword - The encoded password without a prefix

Returns:

The decoded password string

getPrefixes

String[] getPrefixes()

Returns:

The prefixes to the encoded passwords which this password encoder supports.