PbeParameters (TrueCommons KeyManager Specification 2.3.4 API)

TrueCommons KeyManager Specification 2.3.4

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Type Parameters:
P - the type of these PBE parameters.
S - the type of the key strength.

All Superinterfaces:

Cloneable, Key<P>

All Known Subinterfaces:

PromptingPbeParameters<P,S>

All Known Implementing Classes:

AbstractPbeParameters, AbstractPromptingPbeParameters, AesPbeParameters
```
@ImplementationsShouldExtend(value=AbstractPbeParameters.class)
public interface PbeParameters<P extends PbeParameters<P,S>,S extends KeyStrength>
extends Key<P>
```
A key with properties for password based encryption (PBE).
Implementations do not need to be safe for multi-threading.

Since:

TrueCommons 2.2

Author:

Christian Schlichtherle

Method Summary

Methods
Modifier and Type	Method and Description
`S[]`	`getAllKeyStrengths()` Returns a new non-empty array of all available cipher key strengths.
`S`	`getKeyStrength()` Returns the cipher key strength.
`char[]`	`getPassword()` Returns a protective copy of the password char array.
`void`	`setKeyStrength(S keyStrength)` Sets the cipher key strength.
`void`	`setPassword(char[] password)` Copies and stores the given password char array for deriving the cipher key.

Methods inherited from interface net.java.truecommons.key.spec.Key
clone, equals, hashCode, reset

- Method Detail
  - getAllKeyStrengths
```
S[] getAllKeyStrengths()
```
    Returns a new non-empty array of all available cipher key strengths. There should be no duplicated elements in this array.
    
    Returns:
    A new non-empty array of all available cipher key strengths.
  - getKeyStrength
```
@CheckForNull
S getKeyStrength()
```
    Returns the cipher key strength.
  - getPassword
```
@CheckForNull
char[] getPassword()
```
    Returns a protective copy of the password char array. It's highly recommended to overwrite the char array with any non-password data after using the password.
    
    Returns:
    A protective copy of the password char array.
  - setKeyStrength
```
void setKeyStrength(@CheckForNull
                  S keyStrength)
```
    Sets the cipher key strength.
    
    Parameters:
    keyStrength - the cipher key strength.
  - setPassword
```
void setPassword(@CheckForNull
               char[] password)
```
    Copies and stores the given password char array for deriving the cipher key. It's highly recommended to overwrite the char array with any non-password data after calling this method.
    
    Parameters:
    password - the password char array for deriving the cipher key.

TrueCommons KeyManager Specification 2.3.4

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012–2014 Schlichtherle IT Services. All rights reserved.