Nested and Inner Type Summary

Modifier and Type	Class and Description
private abstract static class	DefaultParts.AbstractPart Abstract base class for `Part` implementations.
private static interface	DefaultParts.Content Part content abstraction.
private static class	DefaultParts.DefaultFilePart Default implementation of `FilePart`.
private static class	DefaultParts.DefaultFormFieldPart Default implementation of `FormFieldPart`.
private static class	DefaultParts.DefaultPart Default implementation of `Part`.
private static class	DefaultParts.FileContent `Content` implementation based on a file.
private static class	DefaultParts.FluxContent `Content` implementation based on a flux of data buffers.

Access	Constructor and Description
pack-priv	DefaultParts()

Method Summary

Modifier and Type	Method and Description
public static FormFieldPart	Returns: the created part formFieldPart(HttpHeaders the part headers headers, String the form field value value) Create a new `FormFieldPart` with the given parameters.
public static Part	Returns: `Part` or `FilePart`, depending on `HttpHeaders#getContentDisposition()` part(HttpHeaders the part headers headers, Flux<DataBuffer> the content of the part dataBuffers) Create a new `Part` or `FilePart` based on a flux of data buffers.
public static Part	Returns: `Part` or `FilePart`, depending on `HttpHeaders#getContentDisposition()` part(HttpHeaders the part headers headers, Path the file file, Scheduler the scheduler used for reading the file scheduler) Create a new `Part` or `FilePart` based on the given file.
private static Part	partInternal(HttpHeaders headers, DefaultParts.Content content)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DefaultParts	back to summary
pack-priv DefaultParts()

Method Detail

formFieldPart back to summary

formFieldPart	back to summary
public static FormFieldPart formFieldPart(HttpHeaders headers, String value) Create a new `FormFieldPart` with the given parameters. Parameters headers:HttpHeaders the part headers value:String the form field value Returns:FormFieldPart the created part

public static FormFieldPart formFieldPart(HttpHeaders headers, String value)

Create a new FormFieldPart with the given parameters.

Parameters

headers:HttpHeaders: the part headers
value:String: the form field value

Returns:FormFieldPart

the created part

part back to summary

part	back to summary
public static Part part(HttpHeaders headers, Flux<DataBuffer> dataBuffers) Create a new `Part` or `FilePart` based on a flux of data buffers. Returns `FilePart` if the `Content-Disposition` of the given headers contains a filename, or a "normal" `Part` otherwise. Parameters headers:HttpHeaders the part headers dataBuffers:Flux<DataBuffer> the content of the part Returns:Part `Part` or `FilePart`, depending on `HttpHeaders#getContentDisposition()`

public static Part part(HttpHeaders headers, Flux<DataBuffer> dataBuffers)

Create a new Part or FilePart based on a flux of data buffers. Returns FilePart if the Content-Disposition of the given headers contains a filename, or a "normal" Part otherwise.

Parameters

headers:HttpHeaders: the part headers
dataBuffers:Flux<DataBuffer>: the content of the part

Returns:Part

Part or FilePart, depending on HttpHeaders#getContentDisposition()

part back to summary

part	back to summary
public static Part part(HttpHeaders headers, Path file, Scheduler scheduler) Create a new `Part` or `FilePart` based on the given file. Returns `FilePart` if the `Content-Disposition` of the given headers contains a filename, or a "normal" `Part` otherwise Parameters headers:HttpHeaders the part headers file:Path the file scheduler:Scheduler the scheduler used for reading the file Returns:Part `Part` or `FilePart`, depending on `HttpHeaders#getContentDisposition()`

public static Part part(HttpHeaders headers, Path file, Scheduler scheduler)

Create a new Part or FilePart based on the given file. Returns FilePart if the Content-Disposition of the given headers contains a filename, or a "normal" Part otherwise

Parameters

headers:HttpHeaders: the part headers
file:Path: the file
scheduler:Scheduler: the scheduler used for reading the file

Returns:Part

Part or FilePart, depending on HttpHeaders#getContentDisposition()

partInternal	back to summary
private static Part partInternal(HttpHeaders headers, DefaultParts.Content content)

org.springframework.http.codec.multipart back to summary

private abstract Class DefaultParts.AbstractPart

Class Inheritance

extends Object
implements Part

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.AbstractPart

All Implemented Interfaces

org.springframework.http.codec.multipart.Part

Known Direct Subclasses

org.springframework.http.codec.multipart.DefaultParts.DefaultFormFieldPart, org.springframework.http.codec.multipart.DefaultParts.DefaultPart

Abstract base class for Part implementations.

Field Summary

Modifier and Type	Field and Description
private final HttpHeaders	headers

Constructor Summary

Access	Constructor and Description
protected	AbstractPart(HttpHeaders headers)

Method Summary

Modifier and Type	Method and Description
public HttpHeaders	headers() Implements org.springframework.http.codec.multipart.Part.headers. Return the headers associated with the part.
public String	name() Implements org.springframework.http.codec.multipart.Part.name. Return the name of the part in the multipart form.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

headers	back to summary
private final HttpHeaders headers

Constructor Detail

AbstractPart	back to summary
protected AbstractPart(HttpHeaders headers)

Method Detail

headers	back to summary
public HttpHeaders headers() Implements org.springframework.http.codec.multipart.Part.headers. Doc from org.springframework.http.codec.multipart.Part.headers. Return the headers associated with the part. Annotations @Override

headers

back to summary

public HttpHeaders headers()

Implements org.springframework.http.codec.multipart.Part.headers.

Doc from org.springframework.http.codec.multipart.Part.headers.

Return the headers associated with the part.

Annotations

@Override

name back to summary

name	back to summary
public String name() Implements org.springframework.http.codec.multipart.Part.name. Doc from org.springframework.http.codec.multipart.Part.name. Return the name of the part in the multipart form. Returns:String the name of the part, never `null` or empty Annotations @Override

public String name()

Implements org.springframework.http.codec.multipart.Part.name.

Doc from org.springframework.http.codec.multipart.Part.name.

Return the name of the part in the multipart form.

Returns:String

the name of the part, never null or empty

Annotations

@Override

org.springframework.http.codec.multipart back to summary

private Interface DefaultParts.Content

Known Direct Implementers: org.springframework.http.codec.multipart.DefaultParts.FluxContent, org.springframework.http.codec.multipart.DefaultParts.FileContent

Part content abstraction.

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	content()
public Mono<Void>	delete()
public Mono<Void>	transferTo(Path dest)

Method Detail

content	back to summary
public Flux<DataBuffer> content()

delete	back to summary
public Mono<Void> delete()

transferTo	back to summary
public Mono<Void> transferTo(Path dest)

org.springframework.http.codec.multipart back to summary

private final Class DefaultParts.DefaultFilePart

Class Inheritance

extends DefaultPart
implements FilePart

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.AbstractPart
org.springframework.http.codec.multipart.DefaultParts.DefaultPart
org.springframework.http.codec.multipart.DefaultParts.DefaultFilePart

All Implemented Interfaces

org.springframework.http.codec.multipart.FilePart, org.springframework.http.codec.multipart.Part

Default implementation of FilePart.

Field Summary

Inherited from org.springframework.http.codec.multipart.DefaultParts.DefaultPart:: content

Constructor Summary

Access	Constructor and Description
public	DefaultFilePart(HttpHeaders headers, DefaultParts.Content content)

Method Summary

Modifier and Type	Method and Description
public String	filename() Implements org.springframework.http.codec.multipart.FilePart.filename. Return the original filename in the client's filesystem.
public String	toString() Overrides org.springframework.http.codec.multipart.DefaultParts.DefaultPart.toString. Returns a string representation of the object.
public Mono<Void>	transferTo(Path the target file dest) Implements org.springframework.http.codec.multipart.FilePart.transferTo. Convenience method to copy the content of the file in this part to the given destination file.

Inherited from org.springframework.http.codec.multipart.DefaultParts.DefaultPart:: content delete

Constructor Detail

DefaultFilePart	back to summary
public DefaultFilePart(HttpHeaders headers, DefaultParts.Content content)

Method Detail

filename back to summary

filename	back to summary
public String filename() Implements org.springframework.http.codec.multipart.FilePart.filename. Doc from org.springframework.http.codec.multipart.FilePart.filename. Return the original filename in the client's filesystem. Note Please keep in mind this filename is supplied by the client and should not be used blindly. In addition to not using the directory portion, the file name could also contain characters such as ".." and others that can be used maliciously. It is recommended to not use this filename directly. Preferably generate a unique one and save this one somewhere for reference, if necessary. Returns:String the original filename, or the empty String if no file has been chosen in the multipart form, or `null` if not defined or not available Annotations @Override

public String filename()

Implements org.springframework.http.codec.multipart.FilePart.filename.

Doc from org.springframework.http.codec.multipart.FilePart.filename.

Return the original filename in the client's filesystem.

Note

Please keep in mind this filename is supplied by the client and should not be used blindly. In addition to not using the directory portion, the file name could also contain characters such as ".." and others that can be used maliciously. It is recommended to not use this filename directly. Preferably generate a unique one and save this one somewhere for reference, if necessary.

Returns:String

the original filename, or the empty String if no file has been chosen in the multipart form, or null if not defined or not available

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.springframework.http.codec.multipart.DefaultParts.DefaultPart.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.springframework.http.codec.multipart.DefaultParts.DefaultPart.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

transferTo back to summary

transferTo	back to summary
public Mono<Void> transferTo(Path dest) Implements org.springframework.http.codec.multipart.FilePart.transferTo. Doc from org.springframework.http.codec.multipart.FilePart.transferTo. Convenience method to copy the content of the file in this part to the given destination file. If the destination file already exists, it will be truncated first. Parameters dest:Path the target file Returns:Mono<Void> completion `Mono` with the result of the file transfer, possibly `IllegalStateException` if the part isn't a file Annotations @Override

public Mono<Void> transferTo(Path dest)

Implements org.springframework.http.codec.multipart.FilePart.transferTo.

Doc from org.springframework.http.codec.multipart.FilePart.transferTo.

Convenience method to copy the content of the file in this part to the given destination file. If the destination file already exists, it will be truncated first.

Parameters

dest:Path: the target file

Returns:Mono<Void>

completion Mono with the result of the file transfer, possibly IllegalStateException if the part isn't a file

Annotations

@Override

org.springframework.http.codec.multipart back to summary

private Class DefaultParts.DefaultFormFieldPart

Class Inheritance

extends AbstractPart
implements FormFieldPart

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.AbstractPart
org.springframework.http.codec.multipart.DefaultParts.DefaultFormFieldPart

All Implemented Interfaces

org.springframework.http.codec.multipart.FormFieldPart, org.springframework.http.codec.multipart.Part

Default implementation of FormFieldPart.

Field Summary

Modifier and Type	Field and Description
private final String	value

Constructor Summary

Access	Constructor and Description
public	DefaultFormFieldPart(HttpHeaders headers, String value)

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	content() Implements org.springframework.http.codec.multipart.Part.content. Return the content for this part.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	value() Implements org.springframework.http.codec.multipart.FormFieldPart.value. Return the form field value.

Inherited from org.springframework.http.codec.multipart.DefaultParts.AbstractPart:: headers name

Field Detail

value	back to summary
private final String value

Constructor Detail

DefaultFormFieldPart	back to summary
public DefaultFormFieldPart(HttpHeaders headers, String value)

Method Detail

content back to summary

content	back to summary
public Flux<DataBuffer> content() Implements org.springframework.http.codec.multipart.Part.content. Doc from org.springframework.http.codec.multipart.Part.content. Return the content for this part. Note that for a `FormFieldPart` the content may be accessed more easily via `FormFieldPart#value()`. Annotations @Override

public Flux<DataBuffer> content()

Implements org.springframework.http.codec.multipart.Part.content.

Doc from org.springframework.http.codec.multipart.Part.content.

Return the content for this part.

Note that for a FormFieldPart the content may be accessed more easily via FormFieldPart#value().

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

value	back to summary
public String value() Implements org.springframework.http.codec.multipart.FormFieldPart.value. Doc from org.springframework.http.codec.multipart.FormFieldPart.value. Return the form field value. Annotations @Override

value

back to summary

public String value()

Implements org.springframework.http.codec.multipart.FormFieldPart.value.

Doc from org.springframework.http.codec.multipart.FormFieldPart.value.

Return the form field value.

Annotations

@Override

org.springframework.http.codec.multipart back to summary

private Class DefaultParts.DefaultPart

Class Inheritance

extends AbstractPart

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.AbstractPart
org.springframework.http.codec.multipart.DefaultParts.DefaultPart

Known Direct Subclasses

org.springframework.http.codec.multipart.DefaultParts.DefaultFilePart

Default implementation of Part.

Field Summary

Modifier and Type	Field and Description
protected final DefaultParts.Content	content

Constructor Summary

Access	Constructor and Description
public	DefaultPart(HttpHeaders headers, DefaultParts.Content content)

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	content() Implements org.springframework.http.codec.multipart.Part.content. Return the content for this part.
public Mono<Void>	delete() Overrides default org.springframework.http.codec.multipart.Part.delete. Return a mono that, when subscribed to, deletes the underlying storage for this part.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.springframework.http.codec.multipart.DefaultParts.AbstractPart:: headers name

Field Detail

content	back to summary
protected final DefaultParts.Content content

Constructor Detail

DefaultPart	back to summary
public DefaultPart(HttpHeaders headers, DefaultParts.Content content)

Method Detail

content back to summary

content	back to summary
public Flux<DataBuffer> content() Implements org.springframework.http.codec.multipart.Part.content. Doc from org.springframework.http.codec.multipart.Part.content. Return the content for this part. Note that for a `FormFieldPart` the content may be accessed more easily via `FormFieldPart#value()`. Annotations @Override

public Flux<DataBuffer> content()

Implements org.springframework.http.codec.multipart.Part.content.

Doc from org.springframework.http.codec.multipart.Part.content.

Return the content for this part.

Note that for a FormFieldPart the content may be accessed more easily via FormFieldPart#value().

Annotations

@Override

delete	back to summary
public Mono<Void> delete() Overrides default org.springframework.http.codec.multipart.Part.delete. Doc from org.springframework.http.codec.multipart.Part.delete. Return a mono that, when subscribed to, deletes the underlying storage for this part. Annotations @Override

delete

back to summary

public Mono<Void> delete()

Overrides default org.springframework.http.codec.multipart.Part.delete.

Doc from org.springframework.http.codec.multipart.Part.delete.

Return a mono that, when subscribed to, deletes the underlying storage for this part.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.http.codec.multipart back to summary

private final Class DefaultParts.FileContent

Class Inheritance

extends Object
implements Content

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.FileContent

All Implemented Interfaces

org.springframework.http.codec.multipart.DefaultParts.Content

Content implementation based on a file.

Field Summary

Modifier and Type	Field and Description
private final Path	file
private final Scheduler	scheduler

Constructor Summary

Access	Constructor and Description
public	FileContent(Path file, Scheduler scheduler)

Method Summary

Modifier and Type	Method and Description
private Mono<Void>	blockingOperation(Callable<?> callable)
public Flux<DataBuffer>	content() Implements org.springframework.http.codec.multipart.DefaultParts.Content.content.
public Mono<Void>	delete() Implements org.springframework.http.codec.multipart.DefaultParts.Content.delete.
public Mono<Void>	transferTo(Path dest) Implements org.springframework.http.codec.multipart.DefaultParts.Content.transferTo.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

file	back to summary
private final Path file

scheduler	back to summary
private final Scheduler scheduler

Constructor Detail

FileContent	back to summary
public FileContent(Path file, Scheduler scheduler)

Method Detail

blockingOperation	back to summary
private Mono<Void> blockingOperation(Callable<?> callable)

content	back to summary
public Flux<DataBuffer> content() Implements org.springframework.http.codec.multipart.DefaultParts.Content.content. Annotations @Override

content

back to summary

public Flux<DataBuffer> content()

Implements org.springframework.http.codec.multipart.DefaultParts.Content.content.

Annotations

@Override

delete	back to summary
public Mono<Void> delete() Implements org.springframework.http.codec.multipart.DefaultParts.Content.delete. Annotations @Override

delete

back to summary

public Mono<Void> delete()

Implements org.springframework.http.codec.multipart.DefaultParts.Content.delete.

Annotations

@Override

transferTo

back to summary

public Mono<Void> transferTo(Path dest)

Implements org.springframework.http.codec.multipart.DefaultParts.Content.transferTo.

Annotations

@Override

org.springframework.http.codec.multipart back to summary

private final Class DefaultParts.FluxContent

Class Inheritance

extends Object
implements Content

java.lang.Object
org.springframework.http.codec.multipart.DefaultParts.FluxContent

All Implemented Interfaces

org.springframework.http.codec.multipart.DefaultParts.Content

Content implementation based on a flux of data buffers.

Field Summary

Modifier and Type	Field and Description
private final Flux<DataBuffer>	content

Constructor Summary

Access	Constructor and Description
public	FluxContent(Flux<DataBuffer> content)

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	content() Implements org.springframework.http.codec.multipart.DefaultParts.Content.content.
public Mono<Void>	delete() Implements org.springframework.http.codec.multipart.DefaultParts.Content.delete.
public Mono<Void>	transferTo(Path dest) Implements org.springframework.http.codec.multipart.DefaultParts.Content.transferTo.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

content	back to summary
private final Flux<DataBuffer> content

Constructor Detail

FluxContent	back to summary
public FluxContent(Flux<DataBuffer> content)

Method Detail

content

back to summary

public Flux<DataBuffer> content()

Implements org.springframework.http.codec.multipart.DefaultParts.Content.content.

Annotations

@Override

delete

back to summary

public Mono<Void> delete()

Implements org.springframework.http.codec.multipart.DefaultParts.Content.delete.

Annotations

@Override

transferTo

back to summary

public Mono<Void> transferTo(Path dest)

Implements org.springframework.http.codec.multipart.DefaultParts.Content.transferTo.

Annotations

@Override

pack-priv abstract Class DefaultParts

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private abstract Class DefaultParts.AbstractPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface DefaultParts.Content

Method Summary

Method Detail

private final Class DefaultParts.DefaultFilePart

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class DefaultParts.DefaultFormFieldPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultParts.DefaultPart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultParts.FileContent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultParts.FluxContent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail