Class PBEParameterSpec

java.lang.Object

javax.crypto.spec.PBEParameterSpec

All Implemented Interfaces:: AlgorithmParameterSpec

public class PBEParameterSpec extends Object implements AlgorithmParameterSpec

This class specifies the set of parameters used with password-based encryption (PBE), as defined in the PKCS #5 standard.

Since:

1.4

External Specifications

Constructor Summary

Constructor	Description
`PBEParameterSpec(byte[] salt, int iterationCount)`	Constructs a parameter set for password-based encryption as defined in the PKCS #5 standard.
`PBEParameterSpec(byte[] salt, int iterationCount, AlgorithmParameterSpec paramSpec)`	Constructs a parameter set for password-based encryption as defined in the PKCS #5 standard.

Method Summary

Modifier and Type	Method	Description
`int`	`getIterationCount()`	Returns the iteration count.
`AlgorithmParameterSpec`	`getParameterSpec()`	Returns the cipher algorithm parameter specification.
`byte[]`	`getSalt()`	Returns the salt.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

PBEParameterSpec

public PBEParameterSpec(byte[] salt, int iterationCount)

Constructs a parameter set for password-based encryption as defined in the PKCS #5 standard.

Parameters:: salt - the salt. The contents of salt are copied to protect against subsequent modification.; iterationCount - the iteration count.
Throws:: NullPointerException - if salt is null.

PBEParameterSpec

public PBEParameterSpec(byte[] salt, int iterationCount, AlgorithmParameterSpec paramSpec)

Constructs a parameter set for password-based encryption as defined in the PKCS #5 standard.

Parameters:: salt - the salt. The contents of salt are copied to protect against subsequent modification.; iterationCount - the iteration count.; paramSpec - the cipher algorithm parameter specification, which may be null.
Throws:: NullPointerException - if salt is null.
Since:: 1.8

Method Details

getSalt

public byte[] getSalt()

Returns the salt.

Returns:: the salt. Returns a new array each time this method is called.

getIterationCount

public int getIterationCount()

Returns the iteration count.

Returns:: the iteration count

getParameterSpec

public AlgorithmParameterSpec getParameterSpec()

Returns the cipher algorithm parameter specification.

Returns:: the parameter specification, or null if none was set.
Since:: 1.8

© 1993, 2025, 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.