W3cubDocs

/OpenJDK 21

Interface PBEKey

All Superinterfaces:
Destroyable, Key, SecretKey, Serializable
public interface PBEKey extends SecretKey
The interface to a PBE key.
Since:
1.4
See Also:

Field Summary

Modifier and Type Field Description
static final long serialVersionUID
Deprecated.
A serialVersionUID field in an interface is ineffectual.

Method Summary

Modifier and Type Method Description
int getIterationCount()
Returns the iteration count or 0 if not specified.
char[] getPassword()
Returns the password.
byte[] getSalt()
Returns the salt or null if not specified.

Methods declared in interface javax.security.auth.Destroyable

destroy, isDestroyed

Methods declared in interface java.security.Key

getAlgorithm, getEncoded, getFormat

Field Details

serialVersionUID

@Deprecated static final long serialVersionUID
Deprecated.
A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.
The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.
See Also:

Method Details

getPassword

char[] getPassword()
Returns the password.

Note: this method should return a copy of the password. It is the caller's responsibility to zero out the password information after it is no longer needed.

Returns:
the password.

getSalt

byte[] getSalt()
Returns the salt or null if not specified.

Note: this method should return a copy of the salt. It is the caller's responsibility to zero out the salt information after it is no longer needed.

Returns:
the salt.

getIterationCount

int getIterationCount()
Returns the iteration count or 0 if not specified.
Returns:
the iteration count.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/crypto/interfaces/PBEKey.html