Stay organized with collections
Save and categorize content based on your preferences.
PBEKey
interface PBEKey : SecretKey
The interface to a PBE key.
Summary
| Constants |
| static Long |
The class fingerprint that is set to indicate serialization compatibility since J2SE 1.
|
| Public methods |
| abstract Int |
Returns the iteration count or 0 if not specified.
|
| abstract CharArray! |
Returns the password.
|
| abstract ByteArray! |
Returns the salt or null if not specified.
|
Constants
serialVersionUID
static val serialVersionUID: Long
The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.
Value: -1430015993304333921L
Public methods
getIterationCount
abstract fun getIterationCount(): Int
Returns the iteration count or 0 if not specified.
| Return |
Int |
the iteration count. |
getPassword
abstract fun getPassword(): CharArray!
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.
getSalt
abstract fun getSalt(): ByteArray!
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# PBEKey\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nPBEKey\n======\n\n```\ninterface PBEKey : SecretKey\n```\n\n|-------------------------------------|\n| [javax.crypto.interfaces.PBEKey](#) |\n\nThe interface to a PBE key.\n\nSummary\n-------\n\n| Constants ||\n|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| static [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [serialVersionUID](#serialVersionUID:kotlin.Long) The class fingerprint that is set to indicate serialization compatibility since J2SE 1. |\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| abstract [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getIterationCount](#getIterationCount())`()` Returns the iteration count or 0 if not specified. |\n| abstract [CharArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html)! | [getPassword](#getPassword())`()` Returns the password. |\n| abstract [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | [getSalt](#getSalt())`()` Returns the salt or null if not specified. |\n\nConstants\n---------\n\n### serialVersionUID\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val serialVersionUID: Long\n```\n\nThe class fingerprint that is set to indicate serialization compatibility since J2SE 1.4. \n\n Value: -1430015993304333921L\n\nPublic methods\n--------------\n\n### getIterationCount\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getIterationCount(): Int\n```\n\nReturns the iteration count or 0 if not specified.\n\n| Return ||\n|----------------------------------------------------------------------------|----------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the iteration count. |\n\n### getPassword\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getPassword(): CharArray!\n```\n\nReturns the password.\n\nNote: 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.\n\n| Return ||\n|------------------------------------------------------------------------------------------|---------------|\n| [CharArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html)! | the password. |\n\n### getSalt\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getSalt(): ByteArray!\n```\n\nReturns the salt or null if not specified.\n\nNote: 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.\n\n| Return ||\n|------------------------------------------------------------------------------------------|-----------|\n| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)! | the salt. |"]]
