CipherInputStream

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - javax.crypto.CipherInputStream

所有已实现的接口:

Closeable, AutoCloseable
```
public class CipherInputStream
extends FilterInputStream
```
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. This class may catch BadPaddingException and other exceptions thrown by failed integrity checks during decryption. These exceptions are not re-thrown, so the client may not be informed that integrity checks failed. Because of this behavior, this class may not be suitable for use with decryption in an authenticated mode of operation (e.g. GCM). Applications that require authenticated encryption can use the Cipher API directly as an alternative to using this class.
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.

从以下版本开始:

1.4

另请参阅:

InputStream, FilterInputStream, Cipher, CipherOutputStream

字段概要
- 从类继承的字段 java.io.FilterInputStream
  in

构造器概要

构造器
限定符	构造器	说明
`protected`	`CipherInputStream(InputStream is)`	Constructs a CipherInputStream from an InputStream without specifying a Cipher.
	`CipherInputStream(InputStream is, Cipher c)`	Constructs a CipherInputStream from an InputStream and a Cipher.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`available()`	Returns the number of bytes that can be read from this input stream without blocking.
`void`	`close()`	Closes this input stream and releases any system resources associated with the stream.
`boolean`	`markSupported()`	Tests if this input stream supports the `mark` and `reset` methods, which it does not.
`int`	`read()`	Reads the next byte of data from this input stream.
`int`	`read(byte[] b)`	Reads up to `b.length` bytes of data from this input stream into an array of bytes.
`int`	`read(byte[] b, int off, int len)`	Reads up to `len` bytes of data from this input stream into an array of bytes.
`long`	`skip(long n)`	Skips `n` bytes of input from the bytes that can be read from this input stream without blocking.

从类继承的方法 java.io.FilterInputStream
mark, reset

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CipherInputStream
```
public CipherInputStream(InputStream is,
                         Cipher c)
```
    Constructs a CipherInputStream from an InputStream and a Cipher.
    Note: if the specified input stream or cipher is null, a NullPointerException may be thrown later when they are used.
    
    参数:
    
    is - the to-be-processed input stream
    
    c - an initialized Cipher object
  - CipherInputStream
```
protected CipherInputStream(InputStream is)
```
    Constructs a CipherInputStream from an InputStream without specifying a Cipher. This has the effect of constructing a CipherInputStream using a NullCipher.
    Note: if the specified input stream is null, a NullPointerException may be thrown later when it is used.
    
    参数:
    
    is - the to-be-processed input stream
- 方法详细资料
  - read
```
public int read()
         throws IOException
```
    Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
    
    覆盖:
    
    read 在类中 FilterInputStream
    
    返回:
    
    the next byte of data, or -1 if the end of the stream is reached.
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
    
    另请参阅:
    
    FilterInputStream.in
  - read
```
public int read(byte[] b)
         throws IOException
```
    Reads up to b.length bytes of data from this input stream into an array of bytes.
    The read method of InputStream calls the read method of three arguments with the arguments b, 0, and b.length.
    
    覆盖:
    
    read 在类中 FilterInputStream
    
    参数:
    
    b - the buffer into which the data is read.
    
    返回:
    
    the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
    
    另请参阅:
    
    InputStream.read(byte[], int, int)
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws IOException
```
    Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available. If the first argument is null, up to len bytes are read and discarded.
    
    覆盖:
    
    read 在类中 FilterInputStream
    
    参数:
    
    b - the buffer into which the data is read.
    
    off - the start offset in the destination array buf
    
    len - the maximum number of bytes read.
    
    返回:
    
    the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
    
    另请参阅:
    
    InputStream.read()
  - skip
```
public long skip(long n)
          throws IOException
```
    Skips n bytes of input from the bytes that can be read from this input stream without blocking.
    Fewer bytes than requested might be skipped. The actual number of bytes skipped is equal to n or the result of a call to available, whichever is smaller. If n is less than zero, no bytes are skipped.
    The actual number of bytes skipped is returned.
    
    覆盖:
    
    skip 在类中 FilterInputStream
    
    参数:
    
    n - the number of bytes to be skipped.
    
    返回:
    
    the actual number of bytes skipped.
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
  - available
```
public int available()
              throws IOException
```
    Returns the number of bytes that can be read from this input stream without blocking. The available method of InputStream returns 0. This method should be overridden by subclasses.
    
    覆盖:
    
    available 在类中 FilterInputStream
    
    返回:
    
    the number of bytes that can be read from this input stream without blocking.
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
  - close
```
public void close()
           throws IOException
```
    Closes this input stream and releases any system resources associated with the stream.
    The close method of CipherInputStream calls the close method of its underlying input stream.
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Closeable
    
    覆盖:
    
    close 在类中 FilterInputStream
    
    抛出:
    
    IOException - if an I/O error occurs.
    
    从以下版本开始:
    
    JCE1.2
    
    另请参阅:
    
    FilterInputStream.in
  - markSupported
```
public boolean markSupported()
```
    Tests if this input stream supports the mark and reset methods, which it does not.
    
    覆盖:
    
    markSupported 在类中 FilterInputStream
    
    返回:
    
    false, since this class does not support the mark and reset methods.
    
    从以下版本开始:
    
    JCE1.2
    
    另请参阅:
    
    InputStream.mark(int), InputStream.reset()

类 CipherInputStream

字段概要

从类继承的字段 java.io.FilterInputStream

构造器概要

方法概要

从类继承的方法 java.io.FilterInputStream

从类继承的方法 java.lang.Object

构造器详细资料

CipherInputStream

CipherInputStream

方法详细资料

read

read

read

skip

available

close

markSupported