MultipartRequest (Codename One API)

java.lang.Object
- com.codename1.io.ConnectionRequest
- - com.codename1.io.MultipartRequest

All Implemented Interfaces:

IOProgressListener
```
public class MultipartRequest
extends ConnectionRequest
```
A multipart post request allows a developer to submit large binary data files to the server in a multipart mime post request. This is a standard method for large binary file uploads to webservers and data services.
The sample code below includes both the client code using the upload capabilities as well as a simple sample servlet that can accept multipart data:

The sample code below demonstrates uploading to the filestack.com API.

Nested Class Summary
- Nested classes/interfaces inherited from class com.codename1.io.ConnectionRequest
  ConnectionRequest.CachingMode, ConnectionRequest.SSLCertificate

Field Summary
- Fields inherited from class com.codename1.io.ConnectionRequest
  PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_NORMAL, PRIORITY_REDUNDANT

Constructor Summary

Constructors
Constructor and Description

MultipartRequest()
Initialize variables

Constructors
Constructor and Description
`MultipartRequest()` Initialize variables

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArgument(String name, String value)` Add an argument to the request response
`void`	`addArgument(String name, String[] value)` Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key
`void`	`addArgumentNoEncoding(String key, String value)` Add an argument to the request response without encoding it, this is useful for arguments which are already encoded
`void`	`addArgumentNoEncoding(String key, String[] value)` Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key, notice that this doesn't implicitly encode the value
`void`	`addArgumentNoEncodingArray(String key, String... value)` Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key, notice that this doesn't implicitly encode the value
`void`	`addData(String name, byte[] data, String mimeType)` Adds a binary argument to the arguments
`void`	`addData(String name, InputStream data, long dataSize, String mimeType)` Adds a binary argument to the arguments, notice the input stream will be read only during submission
`void`	`addData(String name, String filePath, String mimeType)` Adds a binary argument to the arguments
`protected void`	`buildRequestBody(OutputStream os)` Invoked when send body is true, by default sends the request arguments based on "POST" conventions
`protected long`	`calculateContentLength()`
`String`	`getBoundary()` Returns the boundary string which is normally generated based on system time
`int`	`getContentLength()` Returns the content length header value
`protected void`	`initConnection(Object connection)` Invoked to initialize HTTP headers, cookies etc.
`boolean`	`isBase64Binaries()` Set to true to encode binary data as base 64
`static boolean`	`isLeaveInputStreamsOpen()` Special flag to keep input stream files open after they are read
`boolean`	`isManualRedirect()` By default redirect responses (302 etc.) are handled manually in multipart requests
`boolean`	`onRedirect(String url)` This is a callback method that been called when there is a redirect.
`void`	`setBase64Binaries(boolean base64Binaries)` Set to true to encode binary data as base 64
`void`	`setBoundary(String boundary)` Sets the boundary string, normally you don't need this method.
`static void`	`setCanFlushStream(boolean flush)` Sending large files requires flushing the writer once in a while to prevent Out Of Memory Errors, Some J2ME implementation are not able to flush the streams causing the upload to fail.
`void`	`setFilename(String arg, String filename)` Sets the filename for the given argument
`static void`	`setLeaveInputStreamsOpen(boolean aLeaveInputStreamsOpen)` Special flag to keep input stream files open after they are read
`void`	`setManualRedirect(boolean autoRedirect)` By default redirect responses (302 etc.) are handled manually in multipart requests, set this to false to handle the redirect.

Methods inherited from class com.codename1.io.ConnectionRequest
addArgument, addArgumentArray, addArguments, addExceptionListener, addRequestHeader, addResponseCodeListener, addResponseListener, cacheUnmodified, canGetSSLCertificates, checkSSLCertificates, cookieReceived, cookieSent, createRequestURL, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, equals, fetchJSON, fetchJSONAsync, fireResponseListener, getCachedData, getCacheMode, getContentType, getCookieHeader, getDefaultCacheMode, getDefaultUserAgent, getDestinationFile, getDestinationStorage, getDisposeOnCompletion, getHeader, getHeaderFieldNames, getHeaders, getHttpMethod, getPriority, getReadTimeout, getRequestBody, getRequestBodyData, getResponseCode, getResponseContentType, getResponseData, getResponseErrorMessage, getResposeCode, getShowOnInit, getSilentRetryCount, getSSLCertificates, getTimeout, getUrl, getUserAgent, getYield, handleErrorResponseCode, handleException, handleIOException, handleRuntimeException, hashCode, hasResponseListeners, initCookieHeader, ioStreamUpdate, isCheckSSLCertificates, isCookiesEnabled, isCookiesEnabledDefault, isDefaultFollowRedirects, isDuplicateSupported, isFailSilently, isFollowRedirects, isHandleErrorCodesInGlobalErrorHandler, isInsecure, isKilled, isNativeCookieSharingSupported, isPausable, isPaused, isPost, isReadRequest, isReadResponseForErrors, isReadResponseForErrorsDefault, isReadTimeoutSupported, isRedirecting, isWriteRequest, kill, pause, postResponse, purgeCache, purgeCacheDirectory, readErrorCodeHeaders, readHeaders, readResponse, removeAllArguments, removeArgument, removeExceptionListener, removeResponseCodeListener, removeResponseListener, resume, retry, setCacheMode, setCheckSSLCertificates, setChunkedStreamingMode, setContentType, setCookieHeader, setCookiesEnabled, setCookiesEnabledDefault, setDefaultCacheMode, setDefaultFollowRedirects, setDefaultUserAgent, setDestinationFile, setDestinationStorage, setDisposeOnCompletion, setDuplicateSupported, setFailSilently, setFollowRedirects, setHandleErrorCodesInGlobalErrorHandler, setHttpMethod, setInsecure, setKilled, setPaused, setPost, setPriority, setReadRequest, setReadResponseForErrors, setReadResponseForErrorsDefault, setReadTimeout, setRequestBody, setRequestBody, setShowOnInit, setSilentRetryCount, setTimeout, setUrl, setUseNativeCookieStore, setUserAgent, setWriteRequest, shouldAutoCloseResponse, shouldConvertPostToGetOnRedirect, shouldStop, shouldWriteUTFAsGetBytes, validate

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

- Constructor Detail
  - MultipartRequest
```
public MultipartRequest()
```
    Initialize variables
- Method Detail
  - isLeaveInputStreamsOpen
```
public static boolean isLeaveInputStreamsOpen()
```
    Special flag to keep input stream files open after they are read
    
    Returns:
    
    the leaveInputStreamsOpen
  - setLeaveInputStreamsOpen
```
public static void setLeaveInputStreamsOpen(boolean aLeaveInputStreamsOpen)
```
    Special flag to keep input stream files open after they are read
    
    Parameters:
    
    aLeaveInputStreamsOpen - the leaveInputStreamsOpen to set
  - getBoundary
```
public String getBoundary()
```
    Returns the boundary string which is normally generated based on system time
    
    Returns:
    
    the multipart boundary string
  - setBoundary
```
public void setBoundary(String boundary)
```
    Sets the boundary string, normally you don't need this method. Its useful to workaround server issues only. Notice that this method must be invoked before adding any elements.
    
    Parameters:
    
    boundary - the boundary string
  - initConnection
```
protected void initConnection(Object connection)
```
    Description copied from class: ConnectionRequest
    
    Invoked to initialize HTTP headers, cookies etc.
    
    Overrides:
    
    initConnection in class ConnectionRequest
    
    Parameters:
    
    connection - the connection object
  - addData
```
public void addData(String name,
                    byte[] data,
                    String mimeType)
```
    Adds a binary argument to the arguments
    
    Parameters:
    
    name - the name of the data
    
    data - the data as bytes
    
    mimeType - the mime type for the content
  - addData
```
public void addData(String name,
                    String filePath,
                    String mimeType)
             throws IOException
```
    Adds a binary argument to the arguments
    
    Parameters:
    
    name - the name of the file data
    
    filePath - the path of the file to upload
    
    mimeType - the mime type for the content
    
    Throws:
    
    IOException - if the file cannot be opened
  - addData
```
public void addData(String name,
                    InputStream data,
                    long dataSize,
                    String mimeType)
```
    Adds a binary argument to the arguments, notice the input stream will be read only during submission
    
    Parameters:
    
    name - the name of the data
    
    data - the data stream
    
    dataSize - the byte size of the data stream, if the data stream is a file the file size can be obtained using the FileSystemStorage.getInstance().getLength(file) method
    
    mimeType - the mime type for the content
  - setFilename
```
public void setFilename(String arg,
                        String filename)
```
    Sets the filename for the given argument
    
    Parameters:
    
    arg - the argument name
    
    filename - the file name
  - addArgumentNoEncoding
```
public void addArgumentNoEncoding(String key,
                                  String value)
```
    Add an argument to the request response without encoding it, this is useful for arguments which are already encoded
    
    Overrides:
    
    addArgumentNoEncoding in class ConnectionRequest
    
    Parameters:
    
    key - the key of the argument
    
    value - the value for the argument
  - addArgumentNoEncoding
```
public void addArgumentNoEncoding(String key,
                                  String[] value)
```
    Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key, notice that this doesn't implicitly encode the value
    
    Overrides:
    
    addArgumentNoEncoding in class ConnectionRequest
    
    Parameters:
    
    key - the key of the argument
    
    value - the value for the argument
  - addArgumentNoEncodingArray
```
public void addArgumentNoEncodingArray(String key,
                                       String... value)
```
    Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key, notice that this doesn't implicitly encode the value
    
    Overrides:
    
    addArgumentNoEncodingArray in class ConnectionRequest
    
    Parameters:
    
    key - the key of the argument
    
    value - the value for the argument
  - addArgument
```
public void addArgument(String name,
                        String[] value)
```
    Add an argument to the request response as an array of elements, this will trigger multiple request entries with the same key
    
    Overrides:
    
    addArgument in class ConnectionRequest
    
    Parameters:
    
    name - the key of the argument
    
    value - the value for the argument
  - addArgument
```
public void addArgument(String name,
                        String value)
```
    Add an argument to the request response
    
    Overrides:
    
    addArgument in class ConnectionRequest
    
    Parameters:
    
    name - the key of the argument
    
    value - the value for the argument
  - calculateContentLength
```
protected long calculateContentLength()
```
  - buildRequestBody
```
protected void buildRequestBody(OutputStream os)
                         throws IOException
```
    Invoked when send body is true, by default sends the request arguments based on "POST" conventions
    
    Overrides:
    
    buildRequestBody in class ConnectionRequest
    
    Parameters:
    
    os - output stream of the body
    
    Throws:
    
    IOException
  - getContentLength
```
public int getContentLength()
```
    Description copied from class: ConnectionRequest
    
    Returns the content length header value
    
    Overrides:
    
    getContentLength in class ConnectionRequest
    
    Returns:
    
    the content length
  - onRedirect
```
public boolean onRedirect(String url)
```
    Description copied from class: ConnectionRequest
    
    This is a callback method that been called when there is a redirect. IMPORTANT this feature doesn't work on all platforms and currently doesn't work on iOS which always implicitly redirects
    
    Overrides:
    
    onRedirect in class ConnectionRequest
    
    Parameters:
    
    url - the url to be redirected
    
    Returns:
    
    true if the implementation would like to handle this by itself
  - isManualRedirect
```
public boolean isManualRedirect()
```
    By default redirect responses (302 etc.) are handled manually in multipart requests
    
    Returns:
    
    the autoRedirect
  - setManualRedirect
```
public void setManualRedirect(boolean autoRedirect)
```
    By default redirect responses (302 etc.) are handled manually in multipart requests, set this to false to handle the redirect. Notice that a redirect converts a post to a get.
    
    Parameters:
    
    autoRedirect - the autoRedirect to set
  - setCanFlushStream
```
public static void setCanFlushStream(boolean flush)
```
    Sending large files requires flushing the writer once in a while to prevent Out Of Memory Errors, Some J2ME implementation are not able to flush the streams causing the upload to fail. This method can indicate to the upload to not use the flushing mechanism.
  - isBase64Binaries
```
public boolean isBase64Binaries()
```
    Set to true to encode binary data as base 64
    
    Returns:
    
    the base64Binaries
  - setBase64Binaries
```
public void setBase64Binaries(boolean base64Binaries)
```
    Set to true to encode binary data as base 64
    
    Parameters:
    
    base64Binaries - the base64Binaries to set

Class MultipartRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.codename1.io.ConnectionRequest

Field Summary

Fields inherited from class com.codename1.io.ConnectionRequest

Constructor Summary

Method Summary

Methods inherited from class com.codename1.io.ConnectionRequest

Methods inherited from class java.lang.Object

Constructor Detail

MultipartRequest

Method Detail

isLeaveInputStreamsOpen

setLeaveInputStreamsOpen

getBoundary

setBoundary

initConnection

addData

addData

addData

setFilename

addArgumentNoEncoding

addArgumentNoEncoding

addArgumentNoEncodingArray

addArgument

addArgument

calculateContentLength

buildRequestBody

getContentLength

onRedirect

isManualRedirect

setManualRedirect

setCanFlushStream

isBase64Binaries

setBase64Binaries