Java Doc for DigestOutputStream.java in  » 6.0-JDK-Core » security » java » security » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » security » java.security 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.OutputStream
      java.io.FilterOutputStream
         java.security.DigestOutputStream

DigestOutputStream
public class DigestOutputStream extends FilterOutputStream (Code)
A transparent stream that updates the associated message digest using the bits going through the stream.

To complete the message digest computation, call one of the digest methods on the associated message digest after your calls to one of this digest ouput stream's DigestOutputStream.write(int) write methods.

It is possible to turn this stream on or off (see DigestOutputStream.on(boolean) on ). When it is on, a call to one of the write methods results in an update on the message digest. But when it is off, the message digest is not updated. The default is for the stream to be on.
See Also:   MessageDigest
See Also:   DigestInputStream
version:
   1.38 07/05/05
author:
   Benjamin Renaud



Field Summary
protected  MessageDigestdigest
     The message digest associated with this stream.

Constructor Summary
public  DigestOutputStream(OutputStream stream, MessageDigest digest)
     Creates a digest output stream, using the specified output stream and message digest.

Method Summary
public  MessageDigestgetMessageDigest()
     Returns the message digest associated with this stream.
public  voidon(boolean on)
     Turns the digest function on or off.
public  voidsetMessageDigest(MessageDigest digest)
     Associates the specified message digest with this stream.
public  StringtoString()
     Prints a string representation of this digest output stream and its associated message digest object.
public  voidwrite(int b)
     Updates the message digest (if the digest function is on) using the specified byte, and in any case writes the byte to the output stream.
public  voidwrite(byte[] b, int off, int len)
     Updates the message digest (if the digest function is on) using the specified subarray, and in any case writes the subarray to the output stream.

Field Detail
digest
protected MessageDigest digest(Code)
The message digest associated with this stream.




Constructor Detail
DigestOutputStream
public DigestOutputStream(OutputStream stream, MessageDigest digest)(Code)
Creates a digest output stream, using the specified output stream and message digest.
Parameters:
  stream - the output stream.
Parameters:
  digest - the message digest to associate with this stream.




Method Detail
getMessageDigest
public MessageDigest getMessageDigest()(Code)
Returns the message digest associated with this stream. the message digest associated with this stream.
See Also:   DigestOutputStream.setMessageDigest(java.security.MessageDigest)



on
public void on(boolean on)(Code)
Turns the digest function on or off. The default is on. When it is on, a call to one of the write methods results in an update on the message digest. But when it is off, the message digest is not updated.
Parameters:
  on - true to turn the digest function on, false to turn itoff.



setMessageDigest
public void setMessageDigest(MessageDigest digest)(Code)
Associates the specified message digest with this stream.
Parameters:
  digest - the message digest to be associated with this stream.
See Also:   DigestOutputStream.getMessageDigest()



toString
public String toString()(Code)
Prints a string representation of this digest output stream and its associated message digest object.



write
public void write(int b) throws IOException(Code)
Updates the message digest (if the digest function is on) using the specified byte, and in any case writes the byte to the output stream. That is, if the digest function is on (see DigestOutputStream.on(boolean) on ), this method calls update on the message digest associated with this stream, passing it the byte b. This method then writes the byte to the output stream, blocking until the byte is actually written.
Parameters:
  b - the byte to be used for updating and writing to theoutput stream.
exception:
  IOException - if an I/O error occurs.
See Also:   MessageDigest.update(byte)



write
public void write(byte[] b, int off, int len) throws IOException(Code)
Updates the message digest (if the digest function is on) using the specified subarray, and in any case writes the subarray to the output stream. That is, if the digest function is on (see DigestOutputStream.on(boolean) on ), this method calls update on the message digest associated with this stream, passing it the subarray specifications. This method then writes the subarray bytes to the output stream, blocking until the bytes are actually written.
Parameters:
  b - the array containing the subarray to be used for updatingand writing to the output stream.
Parameters:
  off - the offset into b of the first byte tobe updated and written.
Parameters:
  len - the number of bytes of data to be updated and writtenfrom b, starting at offset off.
exception:
  IOException - if an I/O error occurs.
See Also:   MessageDigest.update(byte[]intint)



Fields inherited from java.io.FilterOutputStream
protected OutputStream out(Code)(Java Doc)

Methods inherited from java.io.FilterOutputStream
public void close() throws IOException(Code)(Java Doc)
public void flush() throws IOException(Code)(Java Doc)
public void write(int b) throws IOException(Code)(Java Doc)
public void write(byte b) throws IOException(Code)(Java Doc)
public void write(byte b, int off, int len) throws IOException(Code)(Java Doc)

Methods inherited from java.io.OutputStream
public void close() throws IOException(Code)(Java Doc)
public void flush() throws IOException(Code)(Java Doc)
abstract public void write(int b) throws IOException(Code)(Java Doc)
public void write(byte b) throws IOException(Code)(Java Doc)
public void write(byte b, int off, int len) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.