Top Description Methods
reactor.netty5.http.client

public Interface HttpClientForm

Known Direct Implementers
reactor.netty5.http.client.HttpClientFormEncoder
Imports
java.io.File, .InputStream, java.nio.charset.Charset, io.netty.contrib.handler.codec.http.multipart.HttpDataFactory, .HttpPostRequestEncoder, reactor.util.annotation.Nullable
An HTTP Form builder

Method Summary

Modifier and TypeMethod and Description
public HttpClientForm

Returns:

this builder
attr(String
Attribute name
name, String
Attribute value
value)

Add an HTTP Form attribute

public HttpClientForm

Returns:

this builder
charset(Charset
form charset
charset)

Set the Form Charset

public HttpClientForm

Returns:

this builder
cleanOnTerminate(boolean
true if cleaned on termination (successful or failed)
clean)

Should file attributes be cleaned and eventually removed from disk.

public HttpClientForm

Returns:

this builder
encoding(HttpPostRequestEncoder.EncoderMode
the encoding mode for this form encoding
mode)

Set Form encoding

public HttpClientForm

Returns:

this builder
factory(HttpDataFactory
the new HttpDataFactory to use
factory)

Set Upload factories (allows memory threshold configuration)

public HttpClientForm

Returns:

this builder
file(String
File name
name, File
File reference
file)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
file(String
File name
name, InputStream
File content as InputStream
stream)

Add an HTTP File Upload attribute

public default HttpClientForm

Returns:

this builder
file(String
File name
name, File
File reference
file, String
File mime-type
contentType)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
file(String
File name
name, String
File name to override origin name
filename, File
File reference
file, String
File mime-type
contentType)

Add an HTTP File Upload attribute

public default HttpClientForm

Returns:

this builder
file(String
File name
name, InputStream
File content as InputStream
stream, String
File mime-type
contentType)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
file(String
File name
name, String
File name to override origin name
filename, InputStream
File content as InputStream
stream, String
File mime-type
contentType)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
files(String
File name
name, File[]
File references
files, String[]
File mime-types in the same order than file references
contentTypes)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
files(String
File name
name, File[]
File references
files, String[]
File mime-type in the same order than file references
contentTypes, boolean[]
Plain-Text transmission in the same order than file references
textFiles)

Add an HTTP File Upload attribute

public HttpClientForm

Returns:

this builder
multipart(boolean
should this form be encoded as Multipart
multipart)

Define if this request will be encoded as Multipart

public HttpClientForm

Returns:

this builder
textFile(String
Text file name
name, File
Text File reference
file)

Add an HTTP File Upload attribute for a text file.

public HttpClientForm

Returns:

this builder
textFile(String
Text file name
name, InputStream
Text file content as InputStream
stream)

Add an HTTP File Upload attribute for a text file.

public HttpClientForm

Returns:

this builder
textFile(String
Text file name
name, File
Text File reference
file, String
Text file mime-type
contentType)

Add an HTTP File Upload attribute for a text file.

public HttpClientForm

Returns:

this builder
textFile(String
Text file name
name, InputStream
Text file content as InputStream
inputStream, String
Text file mime-type
contentType)

Add an HTTP File Upload attribute for a text file.

Method Detail

attrback to summary
public HttpClientForm attr(String name, String value)

Add an HTTP Form attribute

Parameters
name:String

Attribute name

value:String

Attribute value

Returns:HttpClientForm

this builder

charsetback to summary
public HttpClientForm charset(Charset charset)

Set the Form Charset

Parameters
charset:Charset

form charset

Returns:HttpClientForm

this builder

cleanOnTerminateback to summary
public HttpClientForm cleanOnTerminate(boolean clean)

Should file attributes be cleaned and eventually removed from disk. Default to false.

Parameters
clean:boolean

true if cleaned on termination (successful or failed)

Returns:HttpClientForm

this builder

encodingback to summary
public HttpClientForm encoding(HttpPostRequestEncoder.EncoderMode mode)

Set Form encoding

Parameters
mode:HttpPostRequestEncoder.EncoderMode

the encoding mode for this form encoding

Returns:HttpClientForm

this builder

factoryback to summary
public HttpClientForm factory(HttpDataFactory factory)

Set Upload factories (allows memory threshold configuration)

Parameters
factory:HttpDataFactory

the new HttpDataFactory to use

Returns:HttpClientForm

this builder

fileback to summary
public HttpClientForm file(String name, File file)

Add an HTTP File Upload attribute

Parameters
name:String

File name

file:File

File reference

Returns:HttpClientForm

this builder

fileback to summary
public HttpClientForm file(String name, InputStream stream)

Add an HTTP File Upload attribute

Parameters
name:String

File name

stream:InputStream

File content as InputStream

Returns:HttpClientForm

this builder

fileback to summary
public default HttpClientForm file(String name, File file, String contentType)

Add an HTTP File Upload attribute

Parameters
name:String

File name

file:File

File reference

contentType:String

File mime-type

Returns:HttpClientForm

this builder

fileback to summary
public HttpClientForm file(String name, String filename, File file, String contentType)

Add an HTTP File Upload attribute

Parameters
name:String

File name

filename:String

File name to override origin name

file:File

File reference

contentType:String

File mime-type

Returns:HttpClientForm

this builder

fileback to summary
public default HttpClientForm file(String name, InputStream stream, String contentType)

Add an HTTP File Upload attribute

Parameters
name:String

File name

stream:InputStream

File content as InputStream

contentType:String

File mime-type

Returns:HttpClientForm

this builder

fileback to summary
public HttpClientForm file(String name, String filename, InputStream stream, String contentType)

Add an HTTP File Upload attribute

Parameters
name:String

File name

filename:String

File name to override origin name

stream:InputStream

File content as InputStream

contentType:String

File mime-type

Returns:HttpClientForm

this builder

filesback to summary
public HttpClientForm files(String name, File[] files, String[] contentTypes)

Add an HTTP File Upload attribute

Parameters
name:String

File name

files:File[]

File references

contentTypes:String[]

File mime-types in the same order than file references

Returns:HttpClientForm

this builder

filesback to summary
public HttpClientForm files(String name, File[] files, String[] contentTypes, boolean[] textFiles)

Add an HTTP File Upload attribute

Parameters
name:String

File name

files:File[]

File references

contentTypes:String[]

File mime-type in the same order than file references

textFiles:boolean[]

Plain-Text transmission in the same order than file references

Returns:HttpClientForm

this builder

multipartback to summary
public HttpClientForm multipart(boolean multipart)

Define if this request will be encoded as Multipart

Parameters
multipart:boolean

should this form be encoded as Multipart

Returns:HttpClientForm

this builder

textFileback to summary
public HttpClientForm textFile(String name, File file)

Add an HTTP File Upload attribute for a text file.

Parameters
name:String

Text file name

file:File

Text File reference

Returns:HttpClientForm

this builder

textFileback to summary
public HttpClientForm textFile(String name, InputStream stream)

Add an HTTP File Upload attribute for a text file.

Parameters
name:String

Text file name

stream:InputStream

Text file content as InputStream

Returns:HttpClientForm

this builder

textFileback to summary
public HttpClientForm textFile(String name, File file, String contentType)

Add an HTTP File Upload attribute for a text file.

Parameters
name:String

Text file name

file:File

Text File reference

contentType:String

Text file mime-type

Returns:HttpClientForm

this builder

textFileback to summary
public HttpClientForm textFile(String name, InputStream inputStream, String contentType)

Add an HTTP File Upload attribute for a text file.

Parameters
name:String

Text file name

inputStream:InputStream

Text file content as InputStream

contentType:String

Text file mime-type

Returns:HttpClientForm

this builder