ISecretKey Interface

Definition

Namespace:

Javax.Crypto

Assembly:

Mono.Android.dll

A secret (symmetric) key.

[Android.Runtime.Register("javax/crypto/SecretKey", "", "Javax.Crypto.ISecretKeyInvoker")]
public interface ISecretKey : IDisposable, Java.Interop.IJavaPeerable, Java.Security.IKey

[<Android.Runtime.Register("javax/crypto/SecretKey", "", "Javax.Crypto.ISecretKeyInvoker")>]
type ISecretKey = interface
    interface IKey
    interface ISerializable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Derived

Javax.Crypto.Interfaces.IPBEKey

Javax.Crypto.Spec.SecretKeySpec

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable ISerializable IKey IDisposable

Remarks

A secret (symmetric) key. The purpose of this interface is to group (and provide type safety for) all secret key interfaces.

Provider implementations of this interface must overwrite the equals and hashCode methods inherited from java.lang.Object, so that secret keys are compared based on their underlying key material and not based on reference. Implementations should override the default destroy and isDestroyed methods from the javax.security.auth.Destroyable interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since SecretKey is Serializable, implementations should also override java.io.ObjectOutputStream#writeObject(java.lang.Object) to prevent keys that have been destroyed from being serialized.

Keys that implement this interface return the string RAW as their encoding format (see getFormat), and return the raw key bytes as the result of a getEncoded method call. (The getFormat and getEncoded methods are inherited from the java.security.Key parent interface.)

Added in 1.4.

Java documentation for javax.crypto.SecretKey.

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.

Fields

SerialVersionUID

The class fingerprint that is set to indicate serialization compatibility since J2SE 1.

Properties

Algorithm	Returns the name of the algorithm of this key. (Inherited from IKey)
Format	Returns the name of the format used to encode this key, or null if it can not be encoded. (Inherited from IKey)
Handle	Gets the JNI value of the underlying Android object. (Inherited from IJavaObject)
JniIdentityHashCode	Returns the value of java.lang.System.identityHashCode() for the wrapped instance. (Inherited from IJavaPeerable)
JniManagedPeerState	State of the managed peer. (Inherited from IJavaPeerable)
JniPeerMembers	Member access and invocation support. (Inherited from IJavaPeerable)
PeerReference	Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable)

Methods

Disposed()	Called when the instance has been disposed. (Inherited from IJavaPeerable)
DisposeUnlessReferenced()	If there are no outstanding references to this instance, then calls Dispose(); otherwise, does nothing. (Inherited from IJavaPeerable)
Finalized()	Called when the instance has been finalized. (Inherited from IJavaPeerable)
GetEncoded()	Returns the key in its primary encoding format, or null if this key does not support encoding. (Inherited from IKey)
SetJniIdentityHashCode(Int32)	Set the value returned by JniIdentityHashCode. (Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)	Set the value returned by PeerReference. (Inherited from IJavaPeerable)
UnregisterFromRuntime()	Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)