Class PathSupport

java.lang.Object

io.helidon.http.media.PathSupport

All Implemented Interfaces:

NamedService, MediaSupport

public class PathSupport
extends Object
implements MediaSupport

Media support for Path. This needs to be a proper media support, as encoding should be provided when sending strings, and should be honored when parsing them.

Nested Class Summary

Nested classes/interfaces inherited from interface MediaSupport

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

Modifier and Type	Interface	Description
static final record	MediaSupport.ReaderResponse<T>	Reader response.
static enum	MediaSupport.SupportLevel	How does this provider support the entity type.
static final record	MediaSupport.WriterResponse<T>	Writer response.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathSupport(String name)	Create a named instance.

Method Summary

Modifier and Type	Method	Description
static MediaSupport	create()	Create a new media support for writing Path.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(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 Object

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

Methods inherited from interface MediaSupport

init

Modifier and Type	Method	Description
default 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.

Constructor Details

PathSupport

protected PathSupport(String name)

Create a named instance.

Parameters:

name - name of this instance

Method Details

create

public static MediaSupport create()

Create a new media support for writing Path.

Returns:

a new media support

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

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

Returns:

type of this service

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