Stay organized with collections
Save and categorize content based on your preferences.
CollectionCertStoreParameters
open class CollectionCertStoreParameters : CertStoreParameters
Parameters used as input for the Collection CertStore algorithm.
This class is used to provide necessary configuration parameters to implementations of the Collection CertStore algorithm. The only parameter included in this class is the Collection from which the CertStore will retrieve certificates and CRLs.
Concurrent Access
Unless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.
Summary
| Public constructors |
|
Creates an instance of CollectionCertStoreParameters with the default parameter values (an empty and immutable Collection).
|
|
Creates an instance of CollectionCertStoreParameters which will allow certificates and CRLs to be retrieved from the specified Collection.
|
| Public methods |
| open Any |
Returns a copy of this object.
|
| open MutableCollection<*>! |
Returns the Collection from which Certificates and CRLs are retrieved.
|
| open String |
Returns a formatted string describing the parameters.
|
Public constructors
CollectionCertStoreParameters
CollectionCertStoreParameters()
Creates an instance of CollectionCertStoreParameters with the default parameter values (an empty and immutable Collection).
CollectionCertStoreParameters
CollectionCertStoreParameters(collection: MutableCollection<*>!)
Creates an instance of CollectionCertStoreParameters which will allow certificates and CRLs to be retrieved from the specified Collection. If the specified Collection contains an object that is not a Certificate or CRL, that object will be ignored by the Collection CertStore.
The Collection is not copied. Instead, a reference is used. This allows the caller to subsequently add or remove Certificates or CRLs from the Collection, thus changing the set of Certificates or CRLs available to the Collection CertStore. The Collection CertStore will not modify the contents of the Collection.
If the Collection will be modified by one thread while another thread is calling a method of a Collection CertStore that has been initialized with this Collection, the Collection must have fail-fast iterators.
| Exceptions |
java.lang.NullPointerException |
if collection is null |
Public methods
clone
open fun clone(): Any
Returns a copy of this object. Note that only a reference to the Collection is copied, and not the contents.
| Exceptions |
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
getCollection
open fun getCollection(): MutableCollection<*>!
Returns the Collection from which Certificates and CRLs are retrieved. This is not a copy of the Collection, it is a reference. This allows the caller to subsequently add or remove Certificates or CRLs from the Collection.
toString
open fun toString(): String
Returns a formatted string describing the parameters.
| Return |
String |
a formatted string describing the parameters |
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,["# CollectionCertStoreParameters\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCollectionCertStoreParameters\n=============================\n\n```\nopen class CollectionCertStoreParameters : CertStoreParameters\n```\n\n|---|-------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.cert.CollectionCertStoreParameters](#) |\n\nParameters used as input for the Collection `CertStore` algorithm.\n\nThis class is used to provide necessary configuration parameters to implementations of the Collection `CertStore` algorithm. The only parameter included in this class is the `Collection` from which the `CertStore` will retrieve certificates and CRLs.\n\n**Concurrent Access**\n\nUnless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.\n\nSummary\n-------\n\n| Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [CollectionCertStoreParameters](#CollectionCertStoreParameters())`()` Creates an instance of `CollectionCertStoreParameters` with the default parameter values (an empty and immutable `Collection`). |\n| [CollectionCertStoreParameters](#CollectionCertStoreParameters(kotlin.collections.MutableCollection))`(`collection:` `[MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\u003c*\u003e!`)` Creates an instance of `CollectionCertStoreParameters` which will allow certificates and CRLs to be retrieved from the specified `Collection`. |\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|\n| open [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | [clone](#clone())`()` Returns a copy of this object. |\n| open [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\\\u003c\\*\\\u003e! | [getCollection](#getCollection())`()` Returns the `Collection` from which `Certificate`s and `CRL`s are retrieved. |\n| open [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](#toString())`()` Returns a formatted string describing the parameters. |\n\nPublic constructors\n-------------------\n\n### CollectionCertStoreParameters\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nCollectionCertStoreParameters()\n```\n\nCreates an instance of `CollectionCertStoreParameters` with the default parameter values (an empty and immutable `Collection`). \n\n### CollectionCertStoreParameters\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nCollectionCertStoreParameters(collection: MutableCollection\u003c*\u003e!)\n```\n\nCreates an instance of `CollectionCertStoreParameters` which will allow certificates and CRLs to be retrieved from the specified `Collection`. If the specified `Collection` contains an object that is not a `Certificate` or `CRL`, that object will be ignored by the Collection `CertStore`.\n\nThe `Collection` is **not** copied. Instead, a reference is used. This allows the caller to subsequently add or remove `Certificates` or `CRL`s from the `Collection`, thus changing the set of `Certificates` or `CRL`s available to the Collection `CertStore`. The Collection `CertStore` will not modify the contents of the `Collection`.\n\nIf the `Collection` will be modified by one thread while another thread is calling a method of a Collection `CertStore` that has been initialized with this `Collection`, the `Collection` must have fail-fast iterators.\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `collection` | [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\\\u003c\\*\\\u003e!: a `Collection` of `Certificate`s and `CRL`s |\n\n| Exceptions ||\n|----------------------------------|---------------------------|\n| `java.lang.NullPointerException` | if `collection` is `null` |\n\nPublic methods\n--------------\n\n### clone\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun clone(): Any\n```\n\nReturns a copy of this object. Note that only a reference to the `Collection` is copied, and not the contents.\n\n| Return ||\n|----------------------------------------------------------------------------|----------|\n| [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | the copy |\n\n| Exceptions ||\n|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `java.lang.CloneNotSupportedException` | if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned. |\n\n### getCollection\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getCollection(): MutableCollection\u003c*\u003e!\n```\n\nReturns the `Collection` from which `Certificate`s and `CRL`s are retrieved. This is **not** a copy of the `Collection`, it is a reference. This allows the caller to subsequently add or remove `Certificates` or `CRL`s from the `Collection`.\n\n| Return ||\n|-------------------------------------------------------------------------------------------------------------------------|-------------------------------|\n| [MutableCollection](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)\u003c*\u003e! | the `Collection` (never null) |\n\n### toString\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun toString(): String\n```\n\nReturns a formatted string describing the parameters.\n\n| Return ||\n|----------------------------------------------------------------------------------|----------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a formatted string describing the parameters |"]]
