CipherInputStream Class

Definition

A CipherInputStream is composed of an InputStream and a Cipher so that read() methods return data that are read in from the underlying InputStream but have been additionally processed by the Cipher.

[Android.Runtime.Register("javax/crypto/CipherInputStream", DoNotGenerateAcw=true)]
public class CipherInputStream : Java.IO.FilterInputStream
[<Android.Runtime.Register("javax/crypto/CipherInputStream", DoNotGenerateAcw=true)>]
type CipherInputStream = class
    inherit FilterInputStream
Inheritance
Attributes

Remarks

A CipherInputStream is composed of an InputStream and a Cipher so that read() methods return data that are read in from the underlying InputStream but have been additionally processed by the Cipher. The Cipher must be fully initialized before being used by a CipherInputStream.

For example, if the Cipher is initialized for decryption, the CipherInputStream will attempt to read in data and decrypt them, before returning the decrypted data.

This class adheres strictly to the semantics, especially the failure semantics, of its ancestor classes java.io.FilterInputStream and java.io.InputStream. This class has exactly those methods specified in its ancestor classes, and overrides them all. Moreover, this class catches all exceptions that are not thrown by its ancestor classes. In particular, the skip method skips, and the available method counts only data that have been processed by the encapsulated Cipher.

It is crucial for a programmer using this class not to use methods that are not defined or overriden in this class (such as a new method or constructor that is later added to one of the super classes), because the design and implementation of those methods are unlikely to have considered security impact with regard to CipherInputStream.

Added in 1.4.

Java documentation for javax.crypto.CipherInputStream.

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

CipherInputStream(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

CipherInputStream(Stream)

Constructs a CipherInputStream from an InputStream without specifying a Cipher.

CipherInputStream(Stream, Cipher)

Constructs a CipherInputStream from an InputStream and a Cipher.

Properties

Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
In

The input stream to be filtered.

(Inherited from FilterInputStream)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from 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

Available()

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.

(Inherited from InputStream)
Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Close()

Closes this input stream and releases any system resources associated with the stream.

(Inherited from InputStream)
Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
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)
Mark(Int32)

Marks the current position in this input stream.

(Inherited from InputStream)
MarkSupported()

Tests if this input stream supports the mark and reset methods.

(Inherited from InputStream)
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)
Read()

Reads the next byte of data from this input stream.

(Inherited from FilterInputStream)
Read(Byte[])

Reads some number of bytes from the input stream and stores them into the buffer array b.

(Inherited from InputStream)
Read(Byte[], Int32, Int32)

Reads up to len bytes of data from the input stream into an array of bytes.

(Inherited from InputStream)
ReadAllBytes()

Reads all remaining bytes from the input stream.

(Inherited from InputStream)
ReadAsync() (Inherited from InputStream)
ReadAsync(Byte[]) (Inherited from InputStream)
ReadAsync(Byte[], Int32, Int32) (Inherited from InputStream)
ReadNBytes(Byte[], Int32, Int32)

Reads the requested number of bytes from the input stream into the given byte array.

(Inherited from InputStream)
ReadNBytes(Int32)

Reads up to a specified number of bytes from the input stream.

(Inherited from InputStream)
Reset()

Repositions this stream to the position at the time the mark method was last called on this input stream.

(Inherited from InputStream)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
Skip(Int64)

Skips over and discards n bytes of data from this input stream.

(Inherited from InputStream)
SkipAsync(Int64) (Inherited from InputStream)
SkipNBytes(Int64)

Skips over and discards exactly n bytes of data from this input stream.

(Inherited from InputStream)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
TransferTo(Stream)

Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

(Inherited from InputStream)
UnregisterFromRuntime() (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)

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, 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)

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to