Package com.opencqrs.esdb.client

Interface Marshaller

All Known Implementing Classes:

JacksonMarshaller

public interface Marshaller

Interface specifying operations for HTTP request/response marshalling.

See Also:

• JacksonMarshaller

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Marshaller.QueryResponseElement	Sealed interface representing a deserialized ND-JSON response line transformed via fromQueryResponseLine(String).
static interface	Marshaller.ResponseElement	Sealed interface representing a deserialized ND-JSON response line transformed via fromReadOrObserveResponseLine(String).

Method Summary

Modifier and Type	Method	Description
Health	fromHealthResponse(String response)	Used by EsdbClient.health() to transform the HTTP response body to a Health.
Map<String,Object>	fromJsonResponse(String response)	Used by EsdbClient operations to transform any generic HTTP JSON response.
Marshaller.QueryResponseElement	fromQueryResponseLine(String line)	Used by EsdbClient to transform an ND-JSON line from the HTTP response stream to a Marshaller.QueryResponseElement.
Marshaller.ResponseElement	fromReadOrObserveResponseLine(String line)	Used by EsdbClient to transform an ND-JSON line from the HTTP response stream to a Marshaller.ResponseElement.
List<Event>	fromWriteEventsResponse(String response)	Used by EsdbClient.write(List, List) to transform the HTTP response body to a list of Events.
String	toQueryRequest(String query)	Used by EsdbClient to transform the given parameters into a valid HTTP request body to be sent to the event store for query operations.
String	toReadOrObserveEventsRequest(String subject, Set<Option> options)	Used by EsdbClient to transform the given parameters into a valid HTTP request body toe be sent to the event store for read or observe operations.
String	toWriteEventsRequest(List<EventCandidate> eventCandidates, List<Precondition> preconditions)	Used by EsdbClient.write(List, List) to transform the given EventCandidates and Preconditions to a valid HTTP request body to be sent to the event store.

Method Details

fromJsonResponse

Map<String,Object> fromJsonResponse(String response)

Used by EsdbClient operations to transform any generic HTTP JSON response.

Parameters:

response - the JSON HTTP response body as string

Returns:

a map representing the JSON response content

fromHealthResponse

Health fromHealthResponse(String response)

Used by EsdbClient.health() to transform the HTTP response body to a Health.

Parameters:

response - the JSON HTTP response body as string

Returns:

the Health

toWriteEventsRequest

String toWriteEventsRequest(List<EventCandidate> eventCandidates,
 List<Precondition> preconditions)

Used by EsdbClient.write(List, List) to transform the given EventCandidates and Preconditions to a valid HTTP request body to be sent to the event store.

Parameters:

eventCandidates - the list of event candidates to include within the request body

preconditions - the preconditions to include within the request body

Returns:

the JSON HTTP request body as string

fromWriteEventsResponse

List<Event> fromWriteEventsResponse(String response)

Used by EsdbClient.write(List, List) to transform the HTTP response body to a list of Events.

Parameters:

response - the JSON HTTP response body as string

Returns:

the list of unmarshalled Events

toReadOrObserveEventsRequest

String toReadOrObserveEventsRequest(String subject,
 Set<Option> options)

Used by EsdbClient to transform the given parameters into a valid HTTP request body toe be sent to the event store for read or observe operations.

Parameters:

subject - the subject to include within the request body

options - the options to include within the request body

Returns:

the JSON HTTP request body as string

See Also:

• EsdbClient.read(String, Set, Consumer)
• EsdbClient.read(String, Set)
• EsdbClient.observe(String, Set, Consumer)

fromReadOrObserveResponseLine

Marshaller.ResponseElement fromReadOrObserveResponseLine(String line)

Used by EsdbClient to transform an ND-JSON line from the HTTP response stream to a Marshaller.ResponseElement.

Parameters:

line - the ND-JSON element as string

Returns:

an unmarshalled Marshaller.ResponseElement

toQueryRequest

String toQueryRequest(String query)

Used by EsdbClient to transform the given parameters into a valid HTTP request body to be sent to the event store for query operations.

Parameters:

query - the query

Returns:

the JSON HTTP request body as string

See Also:

• EsdbClient.query(String, RowHandler, ErrorHandler)

fromQueryResponseLine

Marshaller.QueryResponseElement fromQueryResponseLine(String line)

Used by EsdbClient to transform an ND-JSON line from the HTTP response stream to a Marshaller.QueryResponseElement.

Parameters:

line - the ND-JSON element as string

Returns:

an unmarshalled Marshaller.QueryResponseElement