ChunkWriter (d4servlet 5.0.0-beta5 API)

java.lang.Object
- java.io.OutputStream
- - dap4.servlet.ChunkWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable
```
public class ChunkWriter
extends OutputStream
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class ChunkWriter.State

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`ChunkWriter.State`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteBuffer`	`chunk`
`protected boolean`	`closed`
`static byte[]`	`CRLF8`
`static boolean`	`DEBUG`
`static boolean`	`DEBUGHEADER`
`protected byte[]`	`dmr8`
`static boolean`	`DUMPDATA`
`protected ByteBuffer`	`header`
`protected int`	`maxbuffersize`
`protected dap4.dap4lib.RequestMode`	`mode`
`protected OutputStream`	`output`
`protected OutputStream`	`saveoutput`
`protected ChunkWriter.State`	`state`
`protected long`	`writecount`
`protected long`	`writelimit`
`protected ByteOrder`	`writeorder`
`static String`	`XMLDOCUMENTHEADER`

Constructor Summary

Constructors
Constructor and Description

ChunkWriter(OutputStream output, dap4.dap4lib.RequestMode mode, ByteOrder writeorder)

Constructors
Constructor and Description
`ChunkWriter(OutputStream output, dap4.dap4lib.RequestMode mode, ByteOrder writeorder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cacheDMR(String dmr)` Cache the DMR.
`static void`	`chunkheader(int length, int flags, ByteBuffer hdrbuf)`
`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`flush()` Overload flush to also write out the DMR
`byte[]`	`getDump()`
`dap4.dap4lib.RequestMode`	`getMode()`
`ByteOrder`	`getWriteOrder()`
`void`	`setBufferSize(int maxsize)`
`void`	`setMode(dap4.dap4lib.RequestMode mode)`
`void`	`setWriteLimit(long limit)`
`void`	`setWriteOrder(ByteOrder writeorder)`
`void`	`write(byte[] b)` Writes b.length bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes len bytes from the specified byte array starting at offset off to this output stream.
`void`	`write(int b)` Writes the specified byte to the chunk
`void`	`writeDSR(String dsr)` Write the DSR; do not bother to cache.
`void`	`writeError(int httpcode, String msg, String cxt, String other)` Write an error chunk.

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

- Field Detail
  - DEBUG
```
public static boolean DEBUG
```
  - DUMPDATA
```
public static boolean DUMPDATA
```
  - DEBUGHEADER
```
public static boolean DEBUGHEADER
```
  - CRLF8
```
public static final byte[] CRLF8
```
  - XMLDOCUMENTHEADER
```
public static final String XMLDOCUMENTHEADER
```
    See Also:
    
    Constant Field Values
  - saveoutput
```
protected OutputStream saveoutput
```
  - output
```
protected OutputStream output
```
  - state
```
protected ChunkWriter.State state
```
  - maxbuffersize
```
protected int maxbuffersize
```
  - writelimit
```
protected long writelimit
```
  - writecount
```
protected long writecount
```
  - chunk
```
protected ByteBuffer chunk
```
  - header
```
protected ByteBuffer header
```
  - writeorder
```
protected ByteOrder writeorder
```
  - mode
```
protected dap4.dap4lib.RequestMode mode
```
  - dmr8
```
protected byte[] dmr8
```
  - closed
```
protected boolean closed
```
- Constructor Detail
  - ChunkWriter
```
public ChunkWriter(OutputStream output,
                   dap4.dap4lib.RequestMode mode,
                   ByteOrder writeorder)
            throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getMode
```
public dap4.dap4lib.RequestMode getMode()
```
  - setMode
```
public void setMode(dap4.dap4lib.RequestMode mode)
```
  - setBufferSize
```
public void setBufferSize(int maxsize)
```
  - getWriteOrder
```
public ByteOrder getWriteOrder()
```
  - setWriteOrder
```
public void setWriteOrder(ByteOrder writeorder)
```
  - setWriteLimit
```
public void setWriteLimit(long limit)
```
  - writeDSR
```
public void writeDSR(String dsr)
              throws IOException
```
    Write the DSR; do not bother to cache.
    
    Parameters:
    
    dsr - The DSR string
    
    Throws:
    
    IOException - on IO related errors
  - cacheDMR
```
public void cacheDMR(String dmr)
              throws IOException
```
    Cache the DMR. What it really does is cache the DMR and write it at the point where it is needed; either in close(), if writing the DMR only, or in writeChunk() if writing data as well.
    
    Parameters:
    
    dmr - The DMR string
    
    Throws:
    
    IOException - on IO related errors
  - writeError
```
public void writeError(int httpcode,
                       String msg,
                       String cxt,
                       String other)
                throws IOException
```
    Write an error chunk. If mode == DMR then replaces the dmr else reset the current chunk thus losing any partial write.
    
    Parameters:
    
    httpcode - The httpcode, 0 => ignore
    
    msg - The , null => ignore
    
    cxt - The , null => ignore
    
    other - The , null => ignore
    
    Throws:
    
    IOException - on IO related errors
  - chunkheader
```
public static void chunkheader(int length,
                               int flags,
                               ByteBuffer hdrbuf)
                        throws dap4.core.util.DapException
```
    Throws:
    
    dap4.core.util.DapException
  - close
```
public void close()
           throws IOException
```
    Closes this output stream and releases any system resources associated with this stream. Except, the underlying stream is not actually closed; that is left to the servlet level
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException - on IO related errors
  - getDump
```
public byte[] getDump()
```
  - flush
```
public void flush()
           throws IOException
```
    Overload flush to also write out the DMR
    
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b)
           throws IOException
```
    Writes b.length bytes from the specified byte array to this output stream.
    
    Overrides:
    
    write in class OutputStream
    
    Parameters:
    
    b - the data
    
    Throws:
    
    IOException - if an I/O error occurs
  - write
```
public void write(int b)
           throws IOException
```
    Writes the specified byte to the chunk
    
    Specified by:
    
    write in class OutputStream
    
    Parameters:
    
    b - the byte to write
    
    Throws:
    
    IOException - if an I/O error occurs
  - write
```
public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
```
    Writes len bytes from the specified byte array starting at offset off to this output stream.
    If this write fills up the chunk buffer, then write out the buffer and put the remaining bytes into the reset buffer.
    
    Overrides:
    
    write in class OutputStream
    
    Parameters:
    
    b - the data
    
    off - start point in b from which to write data
    
    len - number of bytes to write
    
    Throws:
    
    IOException - if an I/O error occurs

Class ChunkWriter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

DUMPDATA

DEBUGHEADER

CRLF8

XMLDOCUMENTHEADER

saveoutput

output

state

maxbuffersize

writelimit

writecount

chunk

header

writeorder

mode

dmr8

closed

Constructor Detail

ChunkWriter

Method Detail

getMode

setMode

setBufferSize

getWriteOrder

setWriteOrder

setWriteLimit

writeDSR

cacheDMR

writeError

chunkheader

close

getDump

flush

write

write

write