DimeDelimitedInputStream (Apache Axis)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - org.apache.axis.attachments.DimeDelimitedInputStream

All Implemented Interfaces:: Closeable, AutoCloseable

public class DimeDelimitedInputStream
extends 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

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`
`protected static int`	`streamCount`
`protected IOException`	`streamInError`
`protected int`	`streamNo`

Fields inherited from class java.io.FilterInputStream
in

Method Summary

Methods
Modifier and Type	Method and Description
`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()`

Methods inherited from class java.io.FilterInputStream
skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected static org.apache.commons.logging.Log log
```
  - streamNo
```
protected int streamNo
```
  - streamInError
```
protected IOException streamInError
```
  - streamCount
```
protected static int streamCount
```
- Method Detail
  - newStreamNo
```
protected static int newStreamNo()
```
  - 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
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Read from the DIME stream.
    
    Overrides:
    
    read in class FilterInputStream
    
    Parameters:
    b - is the array to read into.
    off - is the offset
    
    Returns:
    the number of bytes read. -1 if endof stream
    
    Throws:
    
    IOException - if data could not be read from the stream
  - _read
```
protected int _read(byte[] b,
        int off,
        int len)
             throws IOException
```
    Throws:
    
    IOException
  - read
```
public int read(byte[] b)
         throws IOException
```
    Read from the delimited stream.
    
    Overrides:
    
    read in class FilterInputStream
    
    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
    
    Throws:
    
    IOException - if data could not be read from the stream
  - read
```
public int read()
         throws IOException
```
    Read from the boundary delimited stream.
    
    Overrides:
    
    read in class FilterInputStream
    
    Returns:
    the byte read, or -1 if endof stream
    
    Throws:
    
    IOException - if there was an error reading the data
  - 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.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class FilterInputStream
    
    Throws:
    
    IOException - if the stream could not be closed
  - mark
```
public void mark(int readlimit)
```
    Mark the stream. This is not supported.
    
    Overrides:
    
    mark in class FilterInputStream
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class FilterInputStream
    
    Throws:
    
    IOException
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class FilterInputStream
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class FilterInputStream
    
    Throws:
    
    IOException
  - finalClose
```
protected void finalClose()
                   throws IOException
```
    Throws:
    
    IOException

Class DimeDelimitedInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

Method Summary

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.lang.Object

Field Detail

log

streamNo

streamInError

streamCount

Method Detail

newStreamNo

getContentId

getDimeTypeNameFormat

getType

read

_read

read

read

close

mark

reset

markSupported

available

finalClose