BoundaryDelimitedStream (Apache Axis)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class BoundaryDelimitedStream
extends FilterInputStream
```
This class takes the input stream and turns it multiple streams.

Author:

Rick Rineholt

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`boundary`
`protected static int`	`BOUNDARY_NOT_FOUND` Field BOUNDARY_NOT_FOUND.
`protected static org.apache.commons.logging.Log`	`log` The `Log` that this class should log all events to.
`protected int`	`streamNo` Field streamNo.

Fields inherited from class java.io.FilterInputStream
in

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BoundaryDelimitedStream(BoundaryDelimitedStream prev, int readbufsz)` Constructor to create the next stream from the previous one.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`available()`
`protected int`	`boundaryPosition(byte[] searchbuf, int start, int end)` Read from the boundary delimited stream.
`void`	`close()` Closes the stream.
`protected void`	`finalClose()` Close the underlying stream and remove all references to it.
`BoundaryDelimitedStream`	`getNextStream()` Gets the next stream.
`protected BoundaryDelimitedStream`	`getNextStream(int readbufsz)` Gets the next stream.
`void`	`mark(int readlimit)` mark the stream.
`boolean`	`markSupported()` markSupported return false;
`protected static int`	`newStreamNo()` Signal that a new stream has been created.
`static void`	`printarry(byte[] b, int start, int end)` Method printarry
`int`	`read()` Read from the boundary delimited stream.
`int`	`read(byte[] b)` Read from the boundary delimited stream.
`int`	`read(byte[] b, int off, int len)` Read from the boundary delimited stream.
`void`	`reset()` reset the stream.

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
```
    The Log that this class should log all events to.
  - boundary
```
protected byte[] boundary
```
  - BOUNDARY_NOT_FOUND
```
protected static final int BOUNDARY_NOT_FOUND
```
    Field BOUNDARY_NOT_FOUND.
    
    See Also:
    Constant Field Values
  - streamNo
```
protected int streamNo
```
    Field streamNo.
- Constructor Detail
  - BoundaryDelimitedStream
```
protected BoundaryDelimitedStream(BoundaryDelimitedStream prev,
                       int readbufsz)
                           throws IOException
```
    Constructor to create the next stream from the previous one.
    
    Parameters:
    prev - the previous stream
    readbufsz - how many bytes to make the read buffer
    
    Throws:
    
    IOException - if there was a problem reading data from prev
- Method Detail
  - newStreamNo
```
protected static int newStreamNo()
```
    Signal that a new stream has been created.
    
    Returns:
  - getNextStream
```
public BoundaryDelimitedStream getNextStream()
                                      throws IOException
```
    Gets the next stream. From the previous using the same buffer size to read.
    
    Returns:
    the boundary delmited stream, null if there are no more streams.
    
    Throws:
    
    IOException - if there was an error loading the data for the next stream
  - getNextStream
```
protected BoundaryDelimitedStream getNextStream(int readbufsz)
                                         throws IOException
```
    Gets the next stream. From the previous using new buffer reading size.
    
    Parameters:
    readbufsz -
    
    Returns:
    the boundary delmited stream, null if there are no more streams.
    
    Throws:
    
    IOException - if there was an error loading the data for the next stream
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Read from the boundary delimited stream.
    
    Overrides:
    
    read in class FilterInputStream
    
    Parameters:
    b - is the array to read into.
    off - is the offset
    len -
    
    Returns:
    the number of bytes read. -1 if endof stream.
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b)
         throws IOException
```
    Read from the boundary 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
  - 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
  - close
```
public void close()
           throws IOException
```
    Closes the stream.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class FilterInputStream
    
    Throws:
    
    IOException
  - mark
```
public void mark(int readlimit)
```
    mark the stream. This is not supported.
    
    Overrides:
    
    mark in class FilterInputStream
    
    Parameters:
    readlimit -
  - reset
```
public void reset()
           throws IOException
```
    reset the stream. This is not supported.
    
    Overrides:
    
    reset in class FilterInputStream
    
    Throws:
    
    IOException
  - markSupported
```
public boolean markSupported()
```
    markSupported return false;
    
    Overrides:
    
    markSupported in class FilterInputStream
    
    Returns:
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class FilterInputStream
    
    Throws:
    
    IOException
  - boundaryPosition
```
protected int boundaryPosition(byte[] searchbuf,
                   int start,
                   int end)
                        throws IOException
```
    Read from the boundary delimited stream.
    
    Parameters:
    searchbuf - buffer to read from
    start - starting index
    end - ending index
    
    Returns:
    The position of the boundary. Detects the end of the source stream.
    
    Throws:
    
    IOException - if there was an error manipulating the underlying stream
  - finalClose
```
protected void finalClose()
                   throws IOException
```
    Close the underlying stream and remove all references to it.
    
    Throws:
    
    IOException - if the stream could not be closed
  - printarry
```
public static void printarry(byte[] b,
             int start,
             int end)
```
    Method printarry
    
    Parameters:
    b -
    start -
    end -

Class BoundaryDelimitedStream

Field Summary

Fields inherited from class java.io.FilterInputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.lang.Object

Field Detail

log

boundary

BOUNDARY_NOT_FOUND

streamNo

Constructor Detail

BoundaryDelimitedStream

Method Detail

newStreamNo

getNextStream

getNextStream

read

read

read

close

mark

reset

markSupported

available

boundaryPosition

finalClose

printarry