Module io.helidon.http.media.multipart

Package io.helidon.http.media.multipart

Class MultiPartSupport

java.lang.Object

io.helidon.http.media.multipart.MultiPartSupport

All Implemented Interfaces:

NamedService, NamedService, MediaSupport

public class MultiPartSupport
extends Object
implements MediaSupport

Media support implementation for support of multipart.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.http.media.MediaSupport

MediaSupport.ReaderResponse<T>, MediaSupport.SupportLevel, MediaSupport.WriterResponse<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BOUNDARY	The default boundary used for encoding multipart messages.

Method Summary

Modifier and Type	Method	Description
static MediaSupport	create(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use create(io.helidon.config.Config) instead
static MediaSupport	create(Config config, String name)	Deprecated, for removal: This API element is subject to removal in a future version. use create(io.helidon.config.Config, String) instead
static MediaSupport	create(Config config)	Creates a new MultiPartSupport.
static MediaSupport	create(Config config, String name)	Creates a new named MultiPartSupport.
void	init(MediaContext context)	Once all providers are discovered/configured and context is established, the MediaContext calls this method on all providers to allow sub-resolution of readers and writers.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders)	Reader for an entity.
<T> MediaSupport.ReaderResponse<T>	reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Client response reader.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response writer.
<T> MediaSupport.WriterResponse<T>	writer(GenericType<T> type, WritableHeaders<?> requestHeaders)	Client request writer.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BOUNDARY

public static final String DEFAULT_BOUNDARY

The default boundary used for encoding multipart messages.

See Also:

• Constant Field Values

Method Details

create

@Deprecated(since="4.4.0",
            forRemoval=true)
public static MediaSupport create(Config config)

Deprecated, for removal: This API element is subject to removal in a future version.

use create(io.helidon.config.Config) instead

Creates a new MultiPartSupport.

Parameters:

config - must not be null

Returns:

a new MultiPartSupport

create

public static MediaSupport create(Config config)

Creates a new MultiPartSupport.

Parameters:

config - must not be null

Returns:

a new MultiPartSupport

create

@Deprecated(since="4.4.0",
            forRemoval=true)
public static MediaSupport create(Config config,
 String name)

Deprecated, for removal: This API element is subject to removal in a future version.

use create(io.helidon.config.Config, String) instead

Creates a new named MultiPartSupport.

Parameters:

config - must not be null

name - name of the multi-part support

Returns:

a new MultiPartSupport

create

public static MediaSupport create(Config config,
 String name)

Creates a new named MultiPartSupport.

Parameters:

config - must not be null

name - name of the multi-part support

Returns:

a new MultiPartSupport

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Specified by:

type in interface NamedService

Returns:

type of this service

init

public void init(MediaContext context)

Description copied from interface: MediaSupport

Once all providers are discovered/configured and context is established, the MediaContext calls this method on all providers to allow sub-resolution of readers and writers.

Specified by:

init in interface MediaSupport

Parameters:

context - media context context

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders)

Description copied from interface: MediaSupport

Reader for an entity.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - headers belonging to this entity (such as server request headers), expected to have content type

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 Headers requestHeaders,
 WritableHeaders<?> responseHeaders)

Description copied from interface: MediaSupport

Server response writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

writer response, whether this type is supported or not

reader

public <T> MediaSupport.ReaderResponse<T> reader(GenericType<T> type,
 Headers requestHeaders,
 Headers responseHeaders)

Description copied from interface: MediaSupport

Client response reader.

Specified by:

reader in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

responseHeaders - response headers

Returns:

reader response, whether this type is supported or not

writer

public <T> MediaSupport.WriterResponse<T> writer(GenericType<T> type,
 WritableHeaders<?> requestHeaders)

Description copied from interface: MediaSupport

Client request writer.

Specified by:

writer in interface MediaSupport

Type Parameters:

T - type

Parameters:

type - type of entity

requestHeaders - request headers

Returns:

writer response, whether this type is supported or not