PBEParameterSpec (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • javax.crypto.spec.PBEParameterSpec

• All Implemented Interfaces:
  [AlgorithmParameterSpec](../../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec")

public class PBEParameterSpec
extends Object
implements AlgorithmParameterSpec
This class specifies the set of parameters used with password-based encryption (PBE), as defined in thePKCS #5 standard.
Since:
1.4

• • Constructor Summary

  Constructors

  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

  All Methods Instance Methods Concrete Methods

  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 java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,int%29)`

• • Constructor Detail

     * #### 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](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `salt` is null.  
     * #### PBEParameterSpec  
     public PBEParameterSpec​(byte[] salt,  
                             int iterationCount,  
                             [AlgorithmParameterSpec](../../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec") 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](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `salt` is null.  
     Since:  
     1.8  

  • Method Detail

    * #### 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](../../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec") getParameterSpec()  
    Returns the cipher algorithm parameter specification.  
    Returns:  
    the parameter specification, or null if none was set.  
    Since:  
    1.8

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.