org.apache.axis.attachments

Class DimeDelimitedInputStream


public class DimeDelimitedInputStream
extends java.io.FilterInputStream

This class takes the input stream and turns it multiple streams. DIME version 0 format
0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  ---
| VERSION |B|E|C| TYPE_T| OPT_T |         OPTIONS_LENGTH        |   A
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|          ID_LENGTH          |             TYPE_LENGTH         |   Always present 12 bytes
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+   even on chunked data.
|                          DATA_LENGTH                          |   V
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+  ---
|                                                               /
/                       OPTIONS + PADDING                       /
/                     (absent for version 0)                    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               /
/                        ID + PADDING                           /
/                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               /
/                        TYPE + PADDING                         /
/                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               /
/                        DATA + PADDING                         /
/                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
This implementation of input stream does not support marking operations.
Author:
Rick Rineholt

Field Summary

protected static Log
log
protected static int
streamCount
protected IOException
streamInError
protected int
streamNo

Method Summary

protected int
_read(byte[] b, int off, int len)
int
available()
void
close()
Closes the stream.
protected void
finalClose()
String
getContentId()
Get the id for this stream part.
DimeTypeNameFormat
getDimeTypeNameFormat()
String
getType()
Get the type, as read from the header.
void
mark(int readlimit)
Mark the stream.
boolean
markSupported()
protected static int
newStreamNo()
int
read()
Read from the boundary delimited stream.
int
read(byte[] b)
Read from the delimited stream.
int
read(byte[] b, int off, int len)
Read from the DIME stream.
void
reset()

Field Details

log

protected static Log log

streamCount

protected static int streamCount

streamInError

protected IOException streamInError

streamNo

protected int streamNo

Method Details

_read

protected int _read(byte[] b,
                    int off,
                    int len)
            throws IOException

available

public int available()
            throws IOException

close

public void close()
            throws IOException
Closes the stream.

This will take care of flushing any remaining data to the strea.

Multiple calls to this method will result in the stream being closed once and then all subsequent calls being ignored.


finalClose

protected void finalClose()
            throws IOException

getContentId

public String getContentId()
Get the id for this stream part.
Returns:
the id;

getDimeTypeNameFormat

public DimeTypeNameFormat getDimeTypeNameFormat()

getType

public String getType()
Get the type, as read from the header.
Returns:
the type of this dime

mark

public void mark(int readlimit)
Mark the stream. This is not supported.

markSupported

public boolean markSupported()

newStreamNo

protected static int newStreamNo()

read

public int read()
            throws IOException
Read from the boundary delimited stream.
Returns:
the byte read, or -1 if endof stream

read

public int read(byte[] b)
            throws IOException
Read from the delimited stream.
Parameters:
b - is the array to read into. Read as much as possible into the size of this array.
Returns:
the number of bytes read. -1 if endof stream

read

public int read(byte[] b,
                int off,
                int len)
            throws IOException
Read from the DIME stream.
Parameters:
b - is the array to read into.
off - is the offset
Returns:
the number of bytes read. -1 if endof stream

reset

public void reset()
            throws IOException

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.