Class PasswordField

java.lang.Object

com.inet.taskplanner.server.api.field.Field

com.inet.taskplanner.server.api.field.PasswordField

@JsonData
public class PasswordField
extends Field

A field that allows the definition of a password.

Since:

taskplanner 3.0

Constructor Summary

Constructors

Constructor	Description
PasswordField(String key, String label)	Creates the field for setting a password.

Method Summary

Modifier and Type	Method	Description
static String	decodePassword(String encodedPassword)	Decodes the given encrypted password and returns the plain-text string.
static String	encodePassword(String plainPassword)	Encodes the given plain-text password with strong internal encryption.
static PasswordField	passwordFieldAsTextArea(String key, String label, String placeholderIfValueSet)	Creates the field for setting a password as a text area that displays the value only when it is created.

Methods inherited from class Field

getConditions, getKey, getLabel, getPlaceholder, getType, getValue, isUpdateValuesOnChange, isValueSavable, patchResultPlaceholderInValue, patchSeriesPlaceholderInValue, replaceSeriesPlaceholders, setConditions, setKey, setLabel, setPlaceholder, setType, setType, setUpdateValuesOnChange, setValue, setValueSavable

Methods inherited from class Object

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

Constructor Details

PasswordField

public PasswordField(String key,
 String label)

Creates the field for setting a password.

Parameters:

key - the key of the field

label - the label to be displayed in front of the field

Since:

taskplanner 3.0

Method Details

passwordFieldAsTextArea

public static PasswordField passwordFieldAsTextArea(String key,
 String label,
 String placeholderIfValueSet)

Creates the field for setting a password as a text area that displays the value only when it is created.

Parameters:

key - the key of the field

label - the label to be displayed in front of the field

placeholderIfValueSet - a placeholder for the case that there is a value already set

Returns:

the password field model

Since:

taskplanner 21.0

encodePassword

public static String encodePassword(String plainPassword)
                             throws IOException

Encodes the given plain-text password with strong internal encryption.

Parameters:

plainPassword - the password to be encrypted

Returns:

the encoded password

Throws:

IOException - if the encryption failed due to an error

Since:

taskplanner 3.0

decodePassword

public static String decodePassword(String encodedPassword)
                             throws IOException

Decodes the given encrypted password and returns the plain-text string.

Parameters:

encodedPassword - the encrypted password to be decoded

Returns:

the decoded password

Throws:

IOException - if the decryption failed due to an error

Since:

taskplanner 3.0