AlgorithmParameters Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This class is used as an opaque representation of cryptographic parameters.
[Android.Runtime.Register("java/security/AlgorithmParameters", DoNotGenerateAcw=true)]
public class AlgorithmParameters : Java.Lang.Object[<Android.Runtime.Register("java/security/AlgorithmParameters", DoNotGenerateAcw=true)>]
type AlgorithmParameters = class
inherit Object- Inheritance
- Attributes
Remarks
This class is used as an opaque representation of cryptographic parameters.
An AlgorithmParameters object for managing the parameters for a particular algorithm can be obtained by calling one of the getInstance factory methods (static methods that return instances of a given class).
Once an AlgorithmParameters object is obtained, it must be initialized via a call to init, using an appropriate parameter specification or parameter encoding.
A transparent parameter specification is obtained from an AlgorithmParameters object via a call to getParameterSpec, and a byte encoding of the parameters is obtained via a call to getEncoded.
Android provides the following AlgorithmParameters algorithms: <table> <thead> <tr> <th>Algorithm</th> <th>Supported API Levels</th> </tr> </thead> <tbody> <tr> <td>AES</td> <td>1+</td> </tr> <tr> <td>BLOWFISH</td> <td>10+</td> </tr> <tr> <td>ChaCha20</td> <td>28+</td> </tr> <tr> <td>DES</td> <td>1+</td> </tr> <tr> <td>DESede</td> <td>1+</td> </tr> <tr> <td>DH</td> <td>1+</td> </tr> <tr> <td>DSA</td> <td>1+</td> </tr> <tr> <td>EC</td> <td>26+</td> </tr> <tr> <td>GCM</td> <td>22+</td> </tr> <tr class="deprecated"> <td>IES</td> <td>1-8</td> </tr> <tr> <td>OAEP</td> <td>1+</td> </tr> <tr> <td>PBEwithHmacSHA1AndAES_128</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA1AndAES_256</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA224AndAES_128</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA224AndAES_256</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA256AndAES_128</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA256AndAES_256</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA384AndAES_128</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA384AndAES_256</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA512AndAES_128</td> <td>26+</td> </tr> <tr> <td>PBEwithHmacSHA512AndAES_256</td> <td>26+</td> </tr> <tr> <td>PKCS12PBE</td> <td>1+</td> </tr> <tr> <td>PSS</td> <td>1-8,24+</td> </tr> </tbody> </table>
Added in 1.2.
Java documentation for java.security.AlgorithmParameters.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| Name | Description |
|---|---|
| AlgorithmParameters(AlgorithmParametersSpi, Provider, String) |
Creates an AlgorithmParameters object. |
| AlgorithmParameters(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
Properties
| Name | Description |
|---|---|
| Algorithm |
Returns the name of the algorithm associated with this parameter object. |
| Class |
Returns the runtime class of this |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniPeerMembers | |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| Provider |
Returns the provider of this parameter object. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetEncoded() |
Returns the parameters in their primary encoding format. |
| GetEncoded(String) |
Returns the parameters encoded in the specified scheme. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetInstance(String, Provider) |
Returns a parameter object for the specified algorithm. |
| GetInstance(String, String) |
Returns a parameter object for the specified algorithm. |
| GetInstance(String) |
Returns a parameter object for the specified algorithm. |
| GetParameterSpec(Class) |
Returns a (transparent) specification of this parameter object. |
| Init(Byte[], String) |
Imports the parameters from |
| Init(Byte[]) |
Imports the specified parameters and decodes them according to the primary decoding format for parameters. |
| Init(IAlgorithmParameterSpec) |
Initializes this parameter object using the parameters
specified in |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a formatted string describing the parameters. |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Notifies the interop runtime that this managed peer has been disposed. (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() |
Releases this Java peer unless it is retained by another managed reference. (Inherited from Object) |
| IJavaPeerable.Finalized() |
Notifies the interop runtime that this managed peer has been finalized. (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState |
Gets the state that describes the relationship between this managed peer and its JNI reference. (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Sets the interop identity hash code for this Java peer. (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Sets the managed and JNI peer state for this Java peer. (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Sets the JNI object reference used by this managed peer. (Inherited from Object) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |