MultipartUtils (nio-multipart-parser 1.1.0 API)

java.lang.Object
- org.synchronoss.cloud.nio.multipart.MultipartUtils

```
public class MultipartUtils
extends Object
```
Utilities to parse a multipart stream.

Author:

Silvano Riz.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTACHMENT` Content disposition attachment parameter
`static String`	`CONTENT_DISPOSITION` Content disposition header name
`static String`	`CONTENT_LENGTH` Content length header name
`static String`	`CONTENT_TRANSFER_ENCODING` Content transfer encoding header name
`static String`	`CONTENT_TYPE` Content type header name
`static byte`	`CR` The (\r) character in bytes
`static byte`	`DASH` The dash (-) character in bytes
`static String`	`FORM_DATA` Content disposition form-data parameter
`static byte[]`	`HEADER_DELIMITER` Sequence of bytes that represents the end of a headers section
`static byte`	`LF` The (\n) character in bytes
`static String`	`MULTIPART` Multipart content type prefix
`static String`	`MULTIPART_FORM_DATA` Specific multipart/form-data content type
`static String`	`MULTIPART_MIXED` Specific multipart/mixed content type
`static String`	`TEXT_PLAIN` text/plain mime-type

Method Summary

Methods
Modifier and Type	Method and Description
`static byte[]`	`getBoundary(String contentType)` Extracts the boundary parameter value defined in the Content-Type header of a multipart request.
`static String`	`getCharEncoding(Map<String,List<String>> headers)` Extracts the charset parameter value from the content type header.
`static long`	`getContentLength(Map<String,List<String>> headers)` Returns the value of the content length header if present.
`static String`	`getContentType(Map<String,List<String>> headers)` Returns the value of the content type header if present.
`static String`	`getFieldName(Map<String,List<String>> headers)` Returns the 'name' parameter of the Content-disposition header.
`static String`	`getFileName(Map<String,List<String>> headers)` Returns the 'filename' parameter of the Content-disposition header.
`static String`	`getHeader(String headerName, Map<String,List<String>> headers)` Returns the first value of a particular header
`static List<String>`	`getHeaders(String headerName, Map<String,List<String>> headers)` Returns the list of values fo a particular header.
`static boolean`	`hasMultipartContentType(Map<String,List<String>> headers)` Checks if the headers contains a Content-Type header that defines a multipart request.
`static boolean`	`isContentTransferEncodingBase64Encoded(Map<String,List<String>> partHeaders)` Returns true if the headers contain the Content-transfer-encoding with value 'base64'.
`static boolean`	`isFormField(Map<String,List<String>> headers, MultipartContext context)` Checks if the part is a form field.
`static boolean`	`isMultipart(String contentTypeHeaderValue)` Checks if the Content-Type header defines a multipart request.
`static String`	`readFormParameterValue(org.synchronoss.cloud.nio.stream.storage.StreamStorage streamStorage, Map<String,List<String>> headers)` Reads the form fields into a string.

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

- Field Detail
  - DASH
```
public static final byte DASH
```
    The dash (-) character in bytes
    
    See Also:
    Constant Field Values
  - CR
```
public static final byte CR
```
    The (\r) character in bytes
    
    See Also:
    Constant Field Values
  - LF
```
public static final byte LF
```
    The (\n) character in bytes
    
    See Also:
    Constant Field Values
  - HEADER_DELIMITER
```
public static final byte[] HEADER_DELIMITER
```
    Sequence of bytes that represents the end of a headers section
  - MULTIPART
```
public static final String MULTIPART
```
    Multipart content type prefix
    
    See Also:
    Constant Field Values
  - CONTENT_DISPOSITION
```
public static final String CONTENT_DISPOSITION
```
    Content disposition header name
    
    See Also:
    Constant Field Values
  - CONTENT_TRANSFER_ENCODING
```
public static final String CONTENT_TRANSFER_ENCODING
```
    Content transfer encoding header name
    
    See Also:
    Constant Field Values
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    Content length header name
    
    See Also:
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    Content type header name
    
    See Also:
    Constant Field Values
  - FORM_DATA
```
public static final String FORM_DATA
```
    Content disposition form-data parameter
    
    See Also:
    Constant Field Values
  - ATTACHMENT
```
public static final String ATTACHMENT
```
    Content disposition attachment parameter
    
    See Also:
    Constant Field Values
  - MULTIPART_FORM_DATA
```
public static final String MULTIPART_FORM_DATA
```
    Specific multipart/form-data content type
    
    See Also:
    Constant Field Values
  - MULTIPART_MIXED
```
public static final String MULTIPART_MIXED
```
    Specific multipart/mixed content type
    
    See Also:
    Constant Field Values
  - TEXT_PLAIN
```
public static final String TEXT_PLAIN
```
    text/plain mime-type
    
    See Also:
    Constant Field Values
- Method Detail
  - isMultipart
```
public static boolean isMultipart(String contentTypeHeaderValue)
```
    Checks if the Content-Type header defines a multipart request.
    
    Parameters:
    contentTypeHeaderValue - The value of the Content-Type header.
    
    Returns:
    true if the request is a multipart request, false otherwise.
  - hasMultipartContentType
```
public static boolean hasMultipartContentType(Map<String,List<String>> headers)
```
    Checks if the headers contains a Content-Type header that defines a multipart request.
    
    Parameters:
    headers - The headers map
    
    Returns:
    true if the request is a multipart request, false otherwise.
  - getContentType
```
public static String getContentType(Map<String,List<String>> headers)
```
    Returns the value of the content type header if present.
    
    Parameters:
    headers - The headers map
    
    Returns:
    the value of the content type header if present.
  - getContentLength
```
public static long getContentLength(Map<String,List<String>> headers)
```
    Returns the value of the content length header if present. -1 if the header is not present or if the value cannot be converted to a long
    
    Parameters:
    headers - The headers map
    
    Returns:
    the value of the content length header if present. -1 if the header is not present or if the value cannot be converted to a long
  - getCharEncoding
```
public static String getCharEncoding(Map<String,List<String>> headers)
```
    Extracts the charset parameter value from the content type header.
    
    Parameters:
    headers - The headers map
    
    Returns:
    the charset parameter value from the content type header or null if the header is not present of the charset parameter not defined
  - getHeaders
```
public static List<String> getHeaders(String headerName,
                      Map<String,List<String>> headers)
```
    Returns the list of values fo a particular header.
    
    Parameters:
    headerName - The header name
    headers - The list of headers
    
    Returns:
    The list of header values or null.
  - getHeader
```
public static String getHeader(String headerName,
               Map<String,List<String>> headers)
```
    Returns the first value of a particular header
    
    Parameters:
    headerName - The header name
    headers - The headers
    
    Returns:
    The first value of the header or null
  - isFormField
```
public static boolean isFormField(Map<String,List<String>> headers,
                  MultipartContext context)
```
    Checks if the part is a form field. The rules are:
    - There must not be a file name specified in the 'Content-disposition' header
    - There must be a field name specified in the 'Content-disposition' header
    - The main request 'Content-Type' must be 'multipart/form-data'
    - The part 'Content-Type' must be 'text/plain' (or not defined which defaults to 'text/plain')
    Parameters:
    headers - The part headers
    context - The multipart context
    
    Returns:
    true if the part is a form field, false otherwise.
  - readFormParameterValue
```
public static String readFormParameterValue(org.synchronoss.cloud.nio.stream.storage.StreamStorage streamStorage,
                            Map<String,List<String>> headers)
```
    Reads the form fields into a string. The method takes care of handling the char encoding.
    If an error occurs while reading the StreamStorage, an IllegalStateException will be thrown.
    
    Parameters:
    streamStorage - The stream storage.
    headers - The part headers.
    
    Returns:
    The form parameter value as string.
  - getFileName
```
public static String getFileName(Map<String,List<String>> headers)
```
    Returns the 'filename' parameter of the Content-disposition header.
    
    Parameters:
    headers - The list of headers
    
    Returns:
    The 'filename' parameter of the Content-disposition header or null
  - getFieldName
```
public static String getFieldName(Map<String,List<String>> headers)
```
    Returns the 'name' parameter of the Content-disposition header.
    
    Parameters:
    headers - The list of headers
    
    Returns:
    The 'name' parameter of the Content-disposition header or null
  - isContentTransferEncodingBase64Encoded
```
public static boolean isContentTransferEncodingBase64Encoded(Map<String,List<String>> partHeaders)
```
    Returns true if the headers contain the Content-transfer-encoding with value 'base64'.
    
    Parameters:
    partHeaders - The list of headers
    
    Returns:
    true if the headers contain the Content-transfer-encoding with value 'base64', false otherwise
  - getBoundary
```
public static byte[] getBoundary(String contentType)
```
    Extracts the boundary parameter value defined in the Content-Type header of a multipart request.
    For example if the Content-Type header is
```
     Content-Type: multipart/form-data; boundary=---------------------------735323031399963166993862150
     
 
```
    This method will extract
```
     ---------------------------735323031399963166993862150
     
 
```
    and return the correspondent bytes.
    The charset used to encode the string into bytes is ISO-8859-1 and if it is not supported it will fall back to the default charset.
    Parameters:
    contentType - The value of the Content-Type header.
    
    Returns:
    The boundary parameter value or null if not defined.

Class MultipartUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DASH

CR

LF

HEADER_DELIMITER

MULTIPART

CONTENT_DISPOSITION

CONTENT_TRANSFER_ENCODING

CONTENT_LENGTH

CONTENT_TYPE

FORM_DATA

ATTACHMENT

MULTIPART_FORM_DATA

MULTIPART_MIXED

TEXT_PLAIN

Method Detail

isMultipart

hasMultipartContentType

getContentType

getContentLength

getCharEncoding

getHeaders

getHeader

isFormField

readFormParameterValue

getFileName

getFieldName

isContentTransferEncodingBase64Encoded

getBoundary