root
API
Generated with
root/org.apache.pekko.serialization.jackson/JacksonObjectMapperProvider

JacksonObjectMapperProvider

org.apache.pekko.serialization.jackson.JacksonObjectMapperProvider
See theJacksonObjectMapperProvider companion object
final class JacksonObjectMapperProvider(system: ExtendedActorSystem) extends Extension

Registry of shared ObjectMapper instances, each with its unique bindingName.

Attributes

Companion
object
Graph
Supertypes
trait Extension
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def create(bindingName: String, jsonFactory: Option[JsonFactory]): ObjectMapper

Scala API: Creates a new instance of a Jackson ObjectMapper with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

Scala API: Creates a new instance of a Jackson ObjectMapper with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

Value parameters

bindingName

name of this ObjectMapper

jsonFactory

optional JsonFactory such as CBORFactory, for plain JSON None (defaults) can be used

Attributes

See also
def create(bindingName: String, jsonFactory: Optional[JsonFactory]): ObjectMapper

Java API: Creates a new instance of a Jackson ObjectMapper with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

Java API: Creates a new instance of a Jackson ObjectMapper with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

Value parameters

bindingName

name of this ObjectMapper

jsonFactory

optional JsonFactory such as CBORFactory, for plain JSON None (defaults) can be used

Attributes

See also
def getOrCreate(bindingName: String, jsonFactory: Option[JsonFactory]): ObjectMapper

Scala API: Returns an existing Jackson ObjectMapper that was created previously with this method, or creates a new instance.

Scala API: Returns an existing Jackson ObjectMapper that was created previously with this method, or creates a new instance.

The ObjectMapper is created with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

The returned ObjectMapper must not be modified, because it may already be in use and such modifications are not thread-safe.

Value parameters

bindingName

name of this ObjectMapper

jsonFactory

optional JsonFactory such as CBORFactory, for plain JSON None (defaults) can be used

Attributes

def getOrCreate(bindingName: String, jsonFactory: Optional[JsonFactory]): ObjectMapper

Java API: Returns an existing Jackson ObjectMapper that was created previously with this method, or creates a new instance.

Java API: Returns an existing Jackson ObjectMapper that was created previously with this method, or creates a new instance.

The ObjectMapper is created with sensible defaults and modules configured in pekko.serialization.jackson.jackson-modules. It's using JacksonObjectMapperProviderSetup if the ActorSystem is started with such pekko.actor.setup.ActorSystemSetup.

The returned ObjectMapper must not be modified, because it may already be in use and such modifications are not thread-safe.

Value parameters

bindingName

name of this ObjectMapper

jsonFactory

optional JsonFactory such as CBORFactory, for plain JSON None (defaults) can be used

Attributes

Generated with