groovyx.net.http

Class MultipartContent

java.lang.Object

groovyx.net.http.MultipartContent

public class MultipartContent
extends java.lang.Object

Multipart request content object used to define the multipart data. An example would be:

request.contentType = 'multipart/form-data'
request.body = multipart {
    field 'userid','someuser'
    part 'icon', 'user-icon.jpg', 'image/jpeg', imageFile
}

which would define a multipart/form-data request with a field part and a file part with the specified properties.

Constructor Summary

Constructors

Constructor and Description
MultipartContent()

Method Summary

Modifier and Type	Method and Description
MultipartContent	field(java.lang.String fieldName, java.lang.String value) Configures a field part with the given field name and value.
MultipartContent	field(java.lang.String fieldName, java.lang.String contentType, java.lang.String value) Configures a field part with the given field name and value (of the specified content type).
static MultipartContent	multipart(Closure closure) Configures multipart request content using a Groovy closure (delegated to MultipartContent).
static MultipartContent	multipart(java.util.function.Consumer<MultipartContent> config) Configures multipart request content using a Consumer which will have an instance of MultipartContent passed into it for configuring the multipart content data.
MultipartContent	part(java.lang.String fieldName, java.lang.String value) Configures a field part with the given field name and value.
MultipartContent	part(java.lang.String fieldName, java.lang.String contentType, java.lang.String value) Configures a field part with the given field name and value (of the specified content type).
MultipartContent	part(java.lang.String fieldName, java.lang.String fileName, java.lang.String contentType, java.lang.Object content) Configures a file part with the specified properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultipartContent

public MultipartContent()

Method Detail

multipart

public static MultipartContent multipart(@DelegatesTo(value=MultipartContent.class)
                                         Closure closure)

Configures multipart request content using a Groovy closure (delegated to MultipartContent).

Parameters:

closure - the configuration closure

Returns:

a configured instance of MultipartContent

multipart

public static MultipartContent multipart(java.util.function.Consumer<MultipartContent> config)

Configures multipart request content using a Consumer which will have an instance of MultipartContent passed into it for configuring the multipart content data.

Parameters:

config - the configuration Consumer

Returns:

a configured instance of MultipartContent

field

public MultipartContent field(java.lang.String fieldName,
                              java.lang.String value)

Configures a field part with the given field name and value.

Parameters:

fieldName - the field name

value - the value

Returns:

a reference to this MultipartContent instance

field

public MultipartContent field(java.lang.String fieldName,
                              java.lang.String contentType,
                              java.lang.String value)

Configures a field part with the given field name and value (of the specified content type).

Parameters:

fieldName - the field name

contentType - the value content type

value - the value

Returns:

a reference to this MultipartContent instance

part

public MultipartContent part(java.lang.String fieldName,
                             java.lang.String value)

Configures a field part with the given field name and value.

Parameters:

fieldName - the field name

value - the value

Returns:

a reference to this MultipartContent instance

part

public MultipartContent part(java.lang.String fieldName,
                             java.lang.String contentType,
                             java.lang.String value)

Configures a field part with the given field name and value (of the specified content type).

Parameters:

fieldName - the field name

contentType - the value content type

value - the value

Returns:

a reference to this MultipartContent instance

part

public MultipartContent part(java.lang.String fieldName,
                             java.lang.String fileName,
                             java.lang.String contentType,
                             java.lang.Object content)

Configures a file part with the specified properties. Encoders must be configured on the HttpBuilder to handle the content type of each configured part.

Parameters:

fieldName - the field name

fileName - the file name

contentType - the part content type

content - the part content (encoders must be configured)

Returns:

a reference to this MultipartContent instance