javax.crypto

Class CipherInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

javax.crypto.CipherInputStream

All Implemented Interfaces:

Closeable ， AutoCloseable

public class CipherInputStream
extends FilterInputStream

CipherInputStream由InputStream和Cipher组成，使得read（）方法返回从底层InputStream读入但是由Cipher额外处理的数据。 密码必须在被CipherInputStream使用之前完全初始化。

例如，如果将密码初始化为解密，则CipherInputStream将在返回解密的数据之前尝试读取数据并将其解密。

该类严格遵守其祖先类java.io.FilterInputStream和java.io.InputStream的语义，特别是失败语义。 这个类只有在其祖先类中指定的方法，并覆盖它们全部。 此外，此类捕获其祖先类不抛出的所有异常。 特别地， skip方法跳过，并且available方法仅计数已由封装的密码处理的数据。

对于使用此类的程序员，不要使用在此类中未定义或覆盖的方法（例如后来添加到其中一个超类的新方法或构造函数），因为这些方法的设计和实现不太可能考虑到对CipherInputStream的安全性影响。

从以下版本开始：

1.4

另请参见：

InputStream ， FilterInputStream ， Cipher ， CipherOutputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	CipherInputStream(InputStream is) 从InputStream构造CipherInputStream，而不指定密码。
	CipherInputStream(InputStream is, Cipher c) 从InputStream和Cipher构造一个CipherInputStream。

方法摘要

Modifier and Type	Method and Description
int	available() 返回可以从该输入流读取而不阻塞的字节数。
void	close() 关闭此输入流并释放与流相关联的任何系统资源。
boolean	markSupported() 测试这个输入流是否支持 mark和 reset方法，而不是。
int	read() 从该输入流读取下一个数据字节。
int	read(byte[] b) 从该输入流读取最多 b.length个字节的数据到字节数组。
int	read(byte[] b, int off, int len) 从该输入流读取高达 len字节的数据到字节数组。
long	skip(long n) 跳过 n字节的字节，可从该输入流中读取而不阻塞。

Methods inherited from class java.io.FilterInputStream

mark, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

CipherInputStream

public CipherInputStream(InputStream is,
                         Cipher c)

从InputStream和Cipher构造一个CipherInputStream。
注意：如果指定的输入流或密码为空，则在使用NullPointerException时可能会稍后抛出。

参数

is - 要处理的输入流

c - 一个初始化的Cipher对象

CipherInputStream

protected CipherInputStream(InputStream is)

从InputStream构造CipherInputStream，而不指定密码。 这具有使用NullCipher构造CipherInputStream的效果。
注意：如果指定的输入流为空，则在使用NullPointerException时可能会稍后抛出。

参数

is - 待处理的输入流

方法详细信息

read

public int read()
         throws IOException

从该输入流读取下一个数据字节。 值字节作为int返回，范围为0至255 。 如果没有字节可用，因为流已经到达，则返回值-1 。 该方法阻塞直到输入数据可用，检测到流的结尾，或抛出异常。

重写：

read在 FilterInputStream

结果

数据的下一个字节，如果达到流的末尾， -1 。

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

另请参见：

FilterInputStream.in

read

public int read(byte[] b)
         throws IOException

从该输入流读取高达b.length字节的数据到字节数组。

该read的方法InputStream调用read的三个参数与参数方法b ， 0和b.length 。

重写：

read在 FilterInputStream

参数

b - 读取数据的缓冲区。

结果

读入缓冲区的总字节数，或 -1是没有更多的数据，因为已经到达流的结尾。

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

另请参见：

InputStream.read(byte[], int, int)

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

从该输入流读取高达len字节的数据到字节数组。 此方法将阻塞，直到某些输入可用。 如果第一个参数是null,最多可以读取并丢弃len个字节。

重写：

read在 FilterInputStream

参数

b - 读取数据的缓冲区。

off - 目标数组 buf的起始偏移量

len - 读取的最大字节数。

结果

读取到缓冲区的总字节数，如果没有更多的数据，因为已经到达流的末尾，则是 -1 。

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

另请参见：

InputStream.read()

skip

public long skip(long n)
          throws IOException

跳过n字节的字节，可从该输入流中读取而不阻塞。

可能会跳过比请求的字节少的字节。 跳过的实际字节数等于n或调用available的结果，以较小者为准。 如果n小于0，则不跳过任何字节。

返回实际跳过的字节数。

重写：

skip在 FilterInputStream

参数

n - 要跳过的字节数。

结果

实际跳过的字节数。

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

available

public int available()
              throws IOException

返回可以从该输入流读取而不阻塞的字节数。 available方法InputStream返回0 。 这个方法应该被子类覆盖。

重写：

available在 FilterInputStream

结果

可以从此输入流中读取而不阻塞的字节数。

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

close

public void close()
           throws IOException

关闭此输入流并释放与流相关联的任何系统资源。

该close的方法CipherInputStream调用close其底层输入流的方法。

Specified by:

close在界面 Closeable

Specified by:

close在界面 AutoCloseable

重写：

close在类别 FilterInputStream

异常

IOException - 如果发生I / O错误。

从以下版本开始：

JCE1.2

另请参见：

FilterInputStream.in

markSupported

public boolean markSupported()

测试这个输入流是否支持 mark和 reset方法，而不是。

重写：

markSupported在类别 FilterInputStream

结果

false ，因为这个类不支持 mark和 reset方法。

从以下版本开始：

JCE1.2

另请参见：

InputStream.mark(int) ， InputStream.reset()