MultipartMessage (Stringflow Java SDK 2.0.0 API)

java.lang.Object
- abs.ixi.client.io.multipart.MultipartMessage

All Implemented Interfaces:

Writable
```
public class MultipartMessage
extends Object
implements Writable
```
Represents a multipart message. A multipart message is a collection of its body parts. A body part contains header and body content (represented by Multipart). The class maintains order of multipart bodies as they appear in multipart byte stream.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static byte`	`CR`
`protected static byte`	`DASH`
`protected static byte`	`LF`
`protected static ByteBuffer`	`LINE_FEED_BUFFER`
`protected static byte[]`	`LINE_FEED_BYTES`

Constructor Summary

Constructors
Constructor and Description

MultipartMessage()

MultipartMessage(byte[] boundary)

MultipartMessage(String boundary)

Constructors
Constructor and Description
`MultipartMessage()`
`MultipartMessage(byte[] boundary)`
`MultipartMessage(String boundary)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(String key, String value)`
`void`	`addHeaders(Map<String,String> headers)`
`void`	`addMultiPart(Multipart part)`
`static String`	`generateBoundary()`
`byte[]`	`getBoundary()`
`int`	`getBoundayLength()`
`String`	`getHeader(String key)`
`Map<String,String>`	`getHeaders()`
`List<Multipart>`	`getParts()`
`Multipart`	`newMultipart()` Returns a new multipart.
`int`	`partCount()`
`void`	`setHeaders(Map<String,String> headers)`
`long`	`writeTo(OutputStream os)` Write to an `OutputStream`
`long`	`writeTo(Socket socket)` Write this entity to a network socket.
`long`	`writeTo(SocketChannel socketChannel)` Write this entity to a `SocketChannel`

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

- Field Detail
  - DASH
```
protected static final byte DASH
```
    See Also:
    
    Constant Field Values
  - LF
```
protected static final byte LF
```
    See Also:
    
    Constant Field Values
  - CR
```
protected static final byte CR
```
    See Also:
    
    Constant Field Values
  - LINE_FEED_BYTES
```
protected static final byte[] LINE_FEED_BYTES
```
  - LINE_FEED_BUFFER
```
protected static final ByteBuffer LINE_FEED_BUFFER
```
- Constructor Detail
  - MultipartMessage
```
public MultipartMessage()
```
  - MultipartMessage
```
public MultipartMessage(byte[] boundary)
```
  - MultipartMessage
```
public MultipartMessage(String boundary)
```
- Method Detail
  - generateBoundary
```
public static String generateBoundary()
```
  - addHeader
```
public void addHeader(String key,
                      String value)
```
  - addHeaders
```
public void addHeaders(Map<String,String> headers)
```
  - getHeaders
```
public Map<String,String> getHeaders()
```
  - getHeader
```
public String getHeader(String key)
```
  - setHeaders
```
public void setHeaders(Map<String,String> headers)
```
  - getParts
```
public List<Multipart> getParts()
```
  - addMultiPart
```
public void addMultiPart(Multipart part)
```
  - getBoundary
```
public byte[] getBoundary()
```
  - getBoundayLength
```
public int getBoundayLength()
```
  - newMultipart
```
public Multipart newMultipart()
```
    Returns a new multipart. Returned multipart is added to multipart list before returning.
    
    Returns:
    
    Multipart Multipart
  - partCount
```
public int partCount()
```
    Returns:
    
    number of body parts held by this message
  - writeTo
```
public long writeTo(OutputStream os)
             throws IOException
```
    Description copied from interface: Writable
    
    Write to an OutputStream
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    os - OutputStream insatnce
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if IO error occurrs
  - writeTo
```
public long writeTo(Socket socket)
             throws IOException
```
    Description copied from interface: Writable
    
    Write this entity to a network socket. The byte conversion mechanism is up to the implementation to decide.
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    socket - network socket on which bytes will be written
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if any IO error occurred
  - writeTo
```
public long writeTo(SocketChannel socketChannel)
             throws IOException
```
    Description copied from interface: Writable
    
    Write this entity to a SocketChannel
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    socketChannel - network socket channel
    
    Returns:
    
    no of bytes written
    
    Throws:
    
    IOException - if any IO error occurred while writing bytes

Class MultipartMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DASH

LF

CR

LINE_FEED_BYTES

LINE_FEED_BUFFER

Constructor Detail

MultipartMessage

MultipartMessage

MultipartMessage

Method Detail

generateBoundary

addHeader

addHeaders

getHeaders

getHeader

setHeaders

getParts

addMultiPart

getBoundary

getBoundayLength

newMultipart

partCount

writeTo

writeTo

writeTo