java.lang.Object

kong.unirest.core.BaseRequest<MultipartBody>

kong.unirest.core.HttpRequestMultiPart

All Implemented Interfaces:: Body, HttpRequest<MultipartBody>, MultipartBody

class HttpRequestMultiPart extends BaseRequest<MultipartBody> implements MultipartBody

Field Summary

Fields

Modifier and Type

Field

Description

private String

boundary

private Charset

charSet

private boolean

forceMulti

private MultipartMode

mode

private ProgressMonitor

monitor

private List<BodyPart>

parameters

Fields inherited from class kong.unirest.core.BaseRequest
config, headers, method, url
Constructor Summary

Constructors

Constructor

Description

HttpRequestMultiPart(HttpRequestBody httpRequest)

HttpRequestMultiPart(HttpRequestMultiPart httpRequest)
Method Summary

Modifier and Type

Method

Description

private void

addPart(String name, Object value, String contentType)

private void

addPart(BodyPart value)

MultipartBody

boundary(String boundaryIdentifier)

Sets the value to use as the boundary identifier.

MultipartBody

charset(Charset charset)

Set the encoding of the request body

MultipartBody

contentType(String mimeType)

Set the mime-type of the request body

MultipartBody

field(String name, byte[] bytes, String fileName)

add a simple field with a name and value

MultipartBody

field(String name, byte[] bytes, ContentType contentType, String fileName)

add a simple field with a name and value

MultipartBody

field(String name, File file)

add a simple field with a name and value

MultipartBody

field(String name, File file, String contentType)

add a simple field with a name and value

MultipartBody

field(String name, InputStream stream, String fileName)

add a simple field with a name and value

MultipartBody

field(String name, InputStream value, ContentType contentType)

add a simple field with a name and value

MultipartBody

field(String name, InputStream stream, ContentType contentType, String fileName)

add a simple field with a name and value

MultipartBody

field(String name, Object value, String contentType)

MultipartBody

field(String name, String value)

add a simple field with a name and value

MultipartBody

field(String name, String value, String contentType)

add a simple field with a name and value

MultipartBody

field(String name, String value, ContentType contentType)

add a simple field with a name and value

MultipartBody

field(String name, Collection<?> collection)

add a simple field with a name and value

MultipartBody

fields(Map<String,Object> fields)

(package private) MultipartBody

forceMultiPart(boolean value)

Optional<Body>

getBody()

String

getBoundary()

Charset

getCharset()

MultipartMode

getMode()

ProgressMonitor

getMonitor()

boolean

isEntityBody()

boolean

isMultiPart()

MultipartBody

mode(MultipartMode value)

Set the Apache Mode.

Collection<BodyPart>

multiParts()

MultipartBody

uploadMonitor(ProgressMonitor uploadMonitor)

Set a file Progress upload monitor suitable for drawing progress bars and whatnot.

Methods inherited from class kong.unirest.core.BaseRequest
accept, asBytes, asBytesAsync, asBytesAsync, asEmpty, asEmptyAsync, asEmptyAsync, asFile, asFileAsync, asFileAsync, asJson, asJsonAsync, asJsonAsync, asObject, asObject, asObject, asObjectAsync, asObjectAsync, asObjectAsync, asObjectAsync, asObjectAsync, asPaged, asString, asStringAsync, asStringAsync, basicAuth, cookie, cookie, cookie, downloadMonitor, equals, getCreationTime, getDownloadMonitor, getHeaders, getHttpMethod, getObjectMapper, getPath, getRequestTimeout, getUrl, getVersion, hashCode, header, headerReplace, headers, headersReplace, queryString, queryString, queryString, requestTimeout, responseEncoding, routeParam, routeParam, thenConsume, thenConsumeAsync, toSummary, version, withObjectMapper

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

Methods inherited from interface kong.unirest.core.Body
getField, uniPart

Methods inherited from interface kong.unirest.core.HttpRequest
accept, accept, asBytes, asBytesAsync, asBytesAsync, asEmpty, asEmptyAsync, asEmptyAsync, asFile, asFileAsync, asFileAsync, asJson, asJsonAsync, asJsonAsync, asObject, asObject, asObject, asObjectAsync, asObjectAsync, asObjectAsync, asObjectAsync, asObjectAsync, asPaged, asString, asStringAsync, asStringAsync, basicAuth, cookie, cookie, cookie, downloadMonitor, getCreationTime, getHeaders, getHttpMethod, getRequestTimeout, getUrl, getVersion, header, headerReplace, headers, headersReplace, queryString, queryString, queryString, requestTimeout, responseEncoding, routeParam, routeParam, thenConsume, thenConsumeAsync, toSummary, version, withObjectMapper

Field Details
- parameters
  
  private List<BodyPart> parameters
- mode
  
  private MultipartMode mode
- charSet
  
  private Charset charSet
- forceMulti
  
  private boolean forceMulti
- monitor
  
  private ProgressMonitor monitor
- boundary
  
  private String boundary
Constructor Details
- HttpRequestMultiPart
  
  HttpRequestMultiPart(HttpRequestBody httpRequest)
- HttpRequestMultiPart
  
  HttpRequestMultiPart(HttpRequestMultiPart httpRequest)
Method Details
- field
  
  public MultipartBody field(String name, String value)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  value - : The string value for the field
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, String value, String contentType)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  value - : The string value for the field
  
  contentType - : the content type of the value
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, String value, ContentType contentType)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  value - : The string value for the field
  
  contentType - : the content type of the value
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, Collection<?> collection)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  collection - : A collection of values for the same name.
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, InputStream value, ContentType contentType)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  value - : A input stream
  
  contentType - : the content mime-type of the file
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, File file)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  file - : A File object.
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, File file, String contentType)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  file - : A File object.
  
  contentType - : the content mime-type of the file
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, InputStream stream, ContentType contentType, String fileName)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  stream - : A input stream
  
  contentType - : the content mime-type of the file
  
  fileName - : the name of the file which will be included in the file part header
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, InputStream stream, String fileName)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  stream - : The raw bytes for the file
  
  fileName - : the name of the file which will be included in the file part header
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, byte[] bytes, ContentType contentType, String fileName)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  bytes - : The raw bytes for the file
  
  contentType - : the content mime-type of the file
  
  fileName - : the name of the file which will be included in the file part header
  
  Returns:
  
  The same MultipartBody
- field
  
  public MultipartBody field(String name, byte[] bytes, String fileName)
  
  Description copied from interface: MultipartBody
  
  add a simple field with a name and value
  
  Specified by:
  
  field in interface MultipartBody
  
  Parameters:
  
  name - : the Name of the form field
  
  bytes - : The raw bytes for the file
  
  fileName - : the name of the file which will be included in the file part header
  
  Returns:
  
  The same MultipartBody
- charset
  
  public MultipartBody charset(Charset charset)
  
  Description copied from interface: MultipartBody
  
  Set the encoding of the request body
  
  Specified by:
  
  charset in interface MultipartBody
  
  Parameters:
  
  charset - the character set encoding of the body
  
  Returns:
  
  The same MultipartBody
- contentType
  
  public MultipartBody contentType(String mimeType)
  
  Description copied from interface: MultipartBody
  
  Set the mime-type of the request body
  
  Specified by:
  
  contentType in interface MultipartBody
  
  Parameters:
  
  mimeType - the mime type of the body
  
  Returns:
  
  The same MultipartBody
- mode
  
  public MultipartBody mode(MultipartMode value)
  
  Description copied from interface: MultipartBody
  
  Set the Apache Mode.
  
  Specified by:
  
  mode in interface MultipartBody
  
  Parameters:
  
  value - the value of the mode
  
  Returns:
  
  The same MultipartBody
- uploadMonitor
  
  public MultipartBody uploadMonitor(ProgressMonitor uploadMonitor)
  
  Description copied from interface: MultipartBody
  
  Set a file Progress upload monitor suitable for drawing progress bars and whatnot.
  
  Specified by:
  
  uploadMonitor in interface MultipartBody
  
  Parameters:
  
  uploadMonitor - a monitor
  
  Returns:
  
  The same MultipartBody
- boundary
  
  public MultipartBody boundary(String boundaryIdentifier)
  
  Description copied from interface: MultipartBody
  
  Sets the value to use as the boundary identifier. see https://datatracker.ietf.org/doc/html/rfc2046
  
  Specified by:
  
  boundary in interface MultipartBody
  
  Parameters:
  
  boundaryIdentifier - the value
  
  Returns:
  
  The same MultipartBody
- getBoundary
  
  public String getBoundary()
  
  Specified by:
  
  getBoundary in interface Body
- getCharset
  
  public Charset getCharset()
  
  Specified by:
  
  getCharset in interface Body
- fields
  
  public MultipartBody fields(Map<String,Object> fields)
- field
  
  public MultipartBody field(String name, Object value, String contentType)
- addPart
  
  private void addPart(String name, Object value, String contentType)
- addPart
  
  private void addPart(BodyPart value)
- getBody
  
  public Optional<Body> getBody()
  
  Specified by:
  
  getBody in interface HttpRequest<MultipartBody>
  
  Returns:
  
  if the request has a body it will be here.
- isMultiPart
  
  public boolean isMultiPart()
  
  Specified by:
  
  isMultiPart in interface Body
- isEntityBody
  
  public boolean isEntityBody()
  
  Specified by:
  
  isEntityBody in interface Body
- multiParts
  
  public Collection<BodyPart> multiParts()
  
  Specified by:
  
  multiParts in interface Body
- getMode
  
  public MultipartMode getMode()
  
  Specified by:
  
  getMode in interface Body
- getMonitor
  
  public ProgressMonitor getMonitor()
  
  Specified by:
  
  getMonitor in interface Body
- forceMultiPart
  
  MultipartBody forceMultiPart(boolean value)

Class HttpRequestMultiPart

Field Summary

Fields inherited from class kong.unirest.core.BaseRequest

Constructor Summary

Method Summary

Methods inherited from class kong.unirest.core.BaseRequest

Methods inherited from class java.lang.Object

Methods inherited from interface kong.unirest.core.Body

Methods inherited from interface kong.unirest.core.HttpRequest

Field Details

parameters

mode

charSet

forceMulti

monitor

boundary

Constructor Details

HttpRequestMultiPart

HttpRequestMultiPart

Method Details

field

field

field

field

field

field

field

field

field

field

field

charset

contentType

mode

uploadMonitor

boundary

getBoundary

getCharset

fields

field

addPart

addPart

getBody

isMultiPart

isEntityBody

multiParts

getMode

getMonitor

forceMultiPart