Package org.springframework.pulsar.support.header

Class JsonPulsarHeaderMapper

java.lang.Object

org.springframework.pulsar.support.header.AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

org.springframework.pulsar.support.header.JsonPulsarHeaderMapper

All Implemented Interfaces:

PulsarHeaderMapper

public class JsonPulsarHeaderMapper
extends AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

A PulsarHeaderMapper implementation that writes headers as JSON.

Allows user to constrain which classes are "trusted" for deserialization as well as configure a list of classes to serialize with a simple "toString".

Author:

Chris Bono

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonPulsarHeaderMapper.JsonPulsarHeaderMapperBuilder
static final record	JsonPulsarHeaderMapper.NonTrustedHeaderType	Represents a header that could not be decoded due to an untrusted type.
static final record	JsonPulsarHeaderMapper.ToPulsarHeadersContext	Context used for AbstractPulsarHeaderMapper.toPulsarHeaders(org.springframework.messaging.MessageHeaders) (outbound) that includes the cumulative map of header name to classname for headers that are serialized with JSON.
static final record	JsonPulsarHeaderMapper.ToSpringHeadersContext	Context used for AbstractPulsarHeaderMapper.toSpringHeaders(org.apache.pulsar.client.api.Message<?>) (inbound) that includes the cumulative map of header name to classname for headers in the incoming message that were serialized with JSON.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_TYPES	Header name for java types of other headers.

Fields inherited from class org.springframework.pulsar.support.header.AbstractPulsarHeaderMapper

logger

Method Summary

Modifier and Type	Method	Description
static JsonPulsarHeaderMapper.JsonPulsarHeaderMapperBuilder	builder()	Construct a builder instance that can be used to construct a JsonPulsarHeaderMapper.
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected Set<String>	getToStringClasses()
protected Set<String>	getTrustedPackages()
protected boolean	matchesForInbound(String header)	Determine if a header name matches any of the currently configured list of inbound matchers.
protected void	toPulsarHeadersOnCompleted(MessageHeaders springHeaders, Map<String,String> pulsarHeaders, JsonPulsarHeaderMapper.ToPulsarHeadersContext context)	Called at the end of a successful AbstractPulsarHeaderMapper.toSpringHeaders(org.apache.pulsar.client.api.Message<?>) invocation.
protected JsonPulsarHeaderMapper.ToPulsarHeadersContext	toPulsarHeadersOnStarted(MessageHeaders springHeaders)	Called at the beginning of every AbstractPulsarHeaderMapper.toPulsarHeaders(org.springframework.messaging.MessageHeaders) invocation and the returned value is passed into each AbstractPulsarHeaderMapper.toPulsarHeaderValue(java.lang.String, java.lang.Object, ToPulsarHeadersContextType) invocation as well as the final AbstractPulsarHeaderMapper.toPulsarHeadersOnCompleted(org.springframework.messaging.MessageHeaders, java.util.Map<java.lang.String, java.lang.String>, ToPulsarHeadersContextType).
protected String	toPulsarHeaderValue(String name, Object rawValue, JsonPulsarHeaderMapper.ToPulsarHeadersContext context)	Determine the Pulsar header value to use for a Spring Messaging header.
protected JsonPulsarHeaderMapper.ToSpringHeadersContext	toSpringHeadersOnStarted(org.apache.pulsar.client.api.Message<?> pulsarMessage)	Called at the beginning of every AbstractPulsarHeaderMapper.toSpringHeaders(org.apache.pulsar.client.api.Message<?>) invocation and the returned value is passed into each AbstractPulsarHeaderMapper.toSpringHeaderValue(java.lang.String, java.lang.String, ToSpringHeadersContextType) invocation as well as the final AbstractPulsarHeaderMapper.toSpringHeadersOnCompleted(org.apache.pulsar.client.api.Message<?>, org.springframework.messaging.MessageHeaders, ToSpringHeadersContextType).
protected Object	toSpringHeaderValue(String name, String value, JsonPulsarHeaderMapper.ToSpringHeadersContext context)	Determine the Spring Messaging header value to use for a Pulsar header.
protected boolean	trusted(String requestedType)

Methods inherited from class org.springframework.pulsar.support.header.AbstractPulsarHeaderMapper

matchesForOutbound, toPulsarHeaders, toSpringHeaders, toSpringHeadersOnCompleted

Methods inherited from class java.lang.Object

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

Field Details

JSON_TYPES

public static final String JSON_TYPES

Header name for java types of other headers.

See Also:

• Constant Field Values

Method Details

builder

public static JsonPulsarHeaderMapper.JsonPulsarHeaderMapperBuilder builder()

Construct a builder instance that can be used to construct a JsonPulsarHeaderMapper.

Returns:

builder instance

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getTrustedPackages

protected Set<String> getTrustedPackages()

getToStringClasses

protected Set<String> getToStringClasses()

toPulsarHeadersOnStarted

protected JsonPulsarHeaderMapper.ToPulsarHeadersContext toPulsarHeadersOnStarted(MessageHeaders springHeaders)

Description copied from class: AbstractPulsarHeaderMapper

Called at the beginning of every AbstractPulsarHeaderMapper.toPulsarHeaders(org.springframework.messaging.MessageHeaders) invocation and the returned value is passed into each AbstractPulsarHeaderMapper.toPulsarHeaderValue(java.lang.String, java.lang.Object, ToPulsarHeadersContextType) invocation as well as the final AbstractPulsarHeaderMapper.toPulsarHeadersOnCompleted(org.springframework.messaging.MessageHeaders, java.util.Map<java.lang.String, java.lang.String>, ToPulsarHeadersContextType). Allows concrete implementations the ability to create an arbitrary context object and have it passed through the mapping process.

Overrides:

toPulsarHeadersOnStarted in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

springHeaders - the Spring Messaging headers that are being converted

Returns:

optional context to pass through the mapping invocation

toPulsarHeaderValue

protected String toPulsarHeaderValue(String name,
 Object rawValue,
 JsonPulsarHeaderMapper.ToPulsarHeadersContext context)

Description copied from class: AbstractPulsarHeaderMapper

Determine the Pulsar header value to use for a Spring Messaging header.

Specified by:

toPulsarHeaderValue in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

name - the Spring Messaging header name

rawValue - the Spring Messaging header value

context - the optional context used for the mapping invocation

Returns:

the Pulsar header value to use

toPulsarHeadersOnCompleted

protected void toPulsarHeadersOnCompleted(MessageHeaders springHeaders,
 Map<String,String> pulsarHeaders,
 JsonPulsarHeaderMapper.ToPulsarHeadersContext context)

Description copied from class: AbstractPulsarHeaderMapper

Called at the end of a successful AbstractPulsarHeaderMapper.toSpringHeaders(org.apache.pulsar.client.api.Message<?>) invocation. Allows concrete implementations the ability to do final logic/cleanup.

Overrides:

toPulsarHeadersOnCompleted in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

springHeaders - the Spring Messaging headers that were mapped

pulsarHeaders - the resulting map of Pulsar message headers

context - the optional context used for the mapping invocation

matchesForInbound

protected boolean matchesForInbound(String header)

Description copied from class: AbstractPulsarHeaderMapper

Determine if a header name matches any of the currently configured list of inbound matchers.

Overrides:

matchesForInbound in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

header - the name of the header to check

Returns:

whether the header matches for inbound

toSpringHeadersOnStarted

@NonNull
protected JsonPulsarHeaderMapper.ToSpringHeadersContext toSpringHeadersOnStarted(org.apache.pulsar.client.api.Message<?> pulsarMessage)

Description copied from class: AbstractPulsarHeaderMapper

Called at the beginning of every AbstractPulsarHeaderMapper.toSpringHeaders(org.apache.pulsar.client.api.Message<?>) invocation and the returned value is passed into each AbstractPulsarHeaderMapper.toSpringHeaderValue(java.lang.String, java.lang.String, ToSpringHeadersContextType) invocation as well as the final AbstractPulsarHeaderMapper.toSpringHeadersOnCompleted(org.apache.pulsar.client.api.Message<?>, org.springframework.messaging.MessageHeaders, ToSpringHeadersContextType). Allows concrete implementations the ability to create an arbitrary context object and have it passed through the mapping process.

Overrides:

toSpringHeadersOnStarted in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

pulsarMessage - the Pulsar message whose headers are being mapped

Returns:

optional context to pass through the mapping invocation

toSpringHeaderValue

protected Object toSpringHeaderValue(String name,
 String value,
 JsonPulsarHeaderMapper.ToSpringHeadersContext context)

Description copied from class: AbstractPulsarHeaderMapper

Determine the Spring Messaging header value to use for a Pulsar header.

Specified by:

toSpringHeaderValue in class AbstractPulsarHeaderMapper<JsonPulsarHeaderMapper.ToPulsarHeadersContext,JsonPulsarHeaderMapper.ToSpringHeadersContext>

Parameters:

name - the Pulsar header name

value - the Pulsar header value

context - the optional context used for the mapping invocation

Returns:

the Spring Messaging header value to use

trusted

protected boolean trusted(String requestedType)