A B C D E F G J L M N P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractDeserializer<T,S> - Class in com.solace.serdes.common
-
Abstract base class for deserializers that convert byte arrays into objects of type T.
- AbstractSerializer<T,S> - Class in com.solace.serdes.common
-
A Serializer base class that processes the configuration objects defined in
SerdeProperties
. - add(SolaceTopicArtifactMapping) - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Adds a
SolaceTopicArtifactMapping
to theSolaceTopicProfile
. - ARTIFACT_RESOLVER_STRATEGY - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Property key for specifying a class that implements
ArtifactReferenceResolverStrategy
- artifactId(String) - Method in class com.solace.serdes.common.resolver.SchemaReference.Builder
-
Sets the artifact ID for the schema reference.
- artifactId(String) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the artifact ID for the artifact reference.
- artifactReference(Record<T>, ParsedSchema<S>) - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReferenceResolverStrategy
-
Resolves and returns the
ArtifactReference
for a given record. - artifactReference(Record<T>, ParsedSchema<S>) - Method in class com.solace.serdes.common.resolver.strategy.DestinationIdStrategy
- artifactReference(Record<T>, ParsedSchema<S>) - Method in class com.solace.serdes.common.resolver.strategy.SolaceTopicIdStrategy
- ArtifactReference - Interface in com.solace.serdes.common.resolver.strategy
-
Represents a reference to an Artifact in a schema registry.
- ArtifactReferenceBuilder - Class in com.solace.serdes.common.resolver.strategy
-
Builder class for creating ArtifactReference instances.
- ArtifactReferenceBuilder() - Constructor for class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Constructs a new ArtifactReferenceBuilder instance.
- ArtifactReferenceResolverStrategy<T,S> - Interface in com.solace.serdes.common.resolver.strategy
-
An interface used by the
SchemaResolver
to resolve anArtifactReference
. - artifactType() - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Retrieves the artifact type of the schema parser.
- artifactType() - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
- AUTH_PASSWORD - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
The Password of the Auth Service.
- AUTH_USERNAME - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
The Username of the Auth Service.
- AUTO_REGISTER_ARTIFACT - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Controls whether schemas should be automatically registered when they don't exist in the registry during serialization.
- AUTO_REGISTER_ARTIFACT_IF_EXISTS - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Controls the behavior when auto-registering an artifact that might already exist in the registry.
B
- BaseProperties - Class in com.solace.serdes.common.resolver.config
-
A base class for SERDES configuration properties.
- build() - Method in class com.solace.serdes.common.resolver.SchemaReference.Builder
-
Builds a new SchemaReference instance with the configured properties.
- build() - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Builds a new ArtifactReference instance with the configured properties.
- builder() - Static method in interface com.solace.serdes.common.resolver.SchemaReference
-
Creates a new Builder instance for constructing SchemaReference objects.
C
- CACHE_LATEST - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Controls the caching behavior of schema lookups that use 'latest' or no version.
- CACHE_TTL_MS - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Specifies the time-to-live (TTL) for cached schema artifacts in milliseconds.
- clear() - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Removes all mappings from the profile.
- close() - Method in class com.solace.serdes.common.AbstractDeserializer
-
Closes this
Deserializer
and any open Vertx connections. - close() - Method in class com.solace.serdes.common.AbstractSerializer
-
Closes this
Serializer
and any open Vertx connections. - close() - Method in class com.solace.serdes.common.resolver.DefaultSchemaResolver
- close() - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Closes this schema resolver and releases any system resources associated with it.
- com.solace.serdes.common - package com.solace.serdes.common
-
Provides common serialization and deserialization functionality used across different schema formats.
- com.solace.serdes.common.resolver - package com.solace.serdes.common.resolver
-
Provides schema resolution functionality for serializers and deserializers to interact with schema registries.
- com.solace.serdes.common.resolver.config - package com.solace.serdes.common.resolver.config
-
Provides configuration classes for schema resolvers, including properties for connecting to schema registries.
- com.solace.serdes.common.resolver.data - package com.solace.serdes.common.resolver.data
-
Provides data structures for representing records and metadata used in schema resolution.
- com.solace.serdes.common.resolver.strategy - package com.solace.serdes.common.resolver.strategy
-
Provides strategies for resolving artifact references based on record information for schema registry lookups.
- com.solace.serdes.common.version - package com.solace.serdes.common.version
-
Provides version information for the common serialization and deserialization module.
- com.solace.serdes.jsonschema - package com.solace.serdes.jsonschema
-
Provides serialization and deserialization functionality for JSON Schema formatted data.
- com.solace.serdes.jsonschema.version - package com.solace.serdes.jsonschema.version
-
Provides version information for the JSON Schema serialization and deserialization module.
- com.solace.serdes.registry.version - package com.solace.serdes.registry.version
-
Provides version information utilities for the Schema Registry SDK.
- configure(Map<String, ?>) - Method in class com.solace.serdes.common.AbstractDeserializer
-
Configures the deserializer with the given properties.
- configure(Map<String, ?>) - Method in class com.solace.serdes.common.AbstractSerializer
-
Configures the serializer with the given properties.
- configure(Map<String, ?>) - Method in class com.solace.serdes.common.resolver.DefaultSchemaResolver
- configure(Map<String, ?>) - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Configures this
SchemaResolver
with the given configuration properties. - configure(Map<String, ?>) - Method in class com.solace.serdes.jsonschema.JsonSchemaDeserializer
- configure(Map<String, ?>) - Method in class com.solace.serdes.jsonschema.JsonSchemaSerializer
- contentId(Long) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the content ID for the artifact reference.
- create() - Static method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Creates an empty
SolaceTopicProfile
instance. - create(String) - Static method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Creates mapping instance with generated artifact id.
- create(String, ArtifactReference) - Static method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Creates mapping instance with explicit
ArtifactReference
. - create(String, String) - Static method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Creates mapping instance with explicit artifact id.
- CREATE_VERSION - com.solace.serdes.common.resolver.config.SchemaResolverProperties.IfArtifactExists
-
Creates a new version of the existing artifact
D
- DefaultSchemaResolver<T,S> - Class in com.solace.serdes.common.resolver
-
Default implementation of the SchemaResolver interface for Solace Schema Registry.
- DefaultSchemaResolver() - Constructor for class com.solace.serdes.common.resolver.DefaultSchemaResolver
-
Constructs a DefaultSchemaResolver.
- deserialize(String, byte[]) - Method in class com.solace.serdes.common.AbstractDeserializer
-
Deserializes the given payload into an object of type T.
- deserialize(String, byte[], Map<String, Object>) - Method in class com.solace.serdes.common.AbstractDeserializer
-
Deserializes the given payload into an object of type T, using additional headers if provided.
- DESERIALIZED_TYPE - Static variable in class com.solace.serdes.common.SerdeProperties
-
An optional property when set explicitly checks if the deserialized type matches this property.
- DestinationIdStrategy<T,S> - Class in com.solace.serdes.common.resolver.strategy
-
A strategy for resolving artifact references based on destination names.
- DestinationIdStrategy() - Constructor for class com.solace.serdes.common.resolver.strategy.DestinationIdStrategy
-
Constructs a DestinationIdStrategy.
E
- EXPLICIT_ARTIFACT_ARTIFACT_ID - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Optional property that explicitly sets the artifactId used for querying an artifact in the registry.
- EXPLICIT_ARTIFACT_GROUP_ID - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Optional property that explicitly sets the groupId used for querying an artifact in the registry.
- EXPLICIT_ARTIFACT_VERSION - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Optional property that explicitly sets the version used for querying an artifact in the registry.
- EXPLICIT_SCHEMA_ID - Static variable in class com.solace.serdes.common.SerdeProperties
-
Property key for setting an explicit schema ID to be used during serialization.
F
- FAIL - com.solace.serdes.common.resolver.config.SchemaResolverProperties.IfArtifactExists
-
Fails the registration if the artifact already exists
- FIND_LATEST_ARTIFACT - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Optional boolean flag that determines whether serializer classes should attempt to locate the most recent artifact in the registry for the given groupId and artifactId combination.
- FIND_OR_CREATE_VERSION - com.solace.serdes.common.resolver.config.SchemaResolverProperties.IfArtifactExists
-
Uses the existing artifact if it exists, otherwise creates a new version
- findLatestArtifact() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the
SchemaResolverProperties.FIND_LATEST_ARTIFACT
boolean flag that determines whether serializer classes should attempt to locate the most recent artifact in the registry for the given groupId and artifactId combination.
G
- getArtifactId() - Method in interface com.solace.serdes.common.resolver.SchemaReference
-
Gets the artifact ID associated with this schema reference.
- getArtifactId() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getArtifactReference() - Method in interface com.solace.serdes.common.resolver.SchemaLookUpResults
-
Retrieves the artifact reference resulting from the lookup operation.
- getArtifactReference() - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Accessor for mapped
ArtifactReference
- getArtifactReferenceResolverStrategyClass() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves an instance of an ArtifactReferenceResolverStrategy.
- getAuthPassword() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the password for authentication with the Auth Service.
- getAuthUsername() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the username for authentication with the Auth Service.
- getAutoRegisterArtifact() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the auto-register artifact setting specified by the
SchemaResolverProperties.AUTO_REGISTER_ARTIFACT
configuration. - getAutoRegisterArtifactIfExists() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the behavior to use when auto-registering artifacts that might already exist.
- getCacheLatest() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the cache latest property specified by the
SchemaResolverProperties.CACHE_LATEST
configuration. - getCacheTTL() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the cache time-to-live (TTL) duration specified by the
SchemaResolverProperties.CACHE_TTL_MS
configuration in milliseconds. - getConfig() - Method in class com.solace.serdes.common.resolver.config.BaseProperties
-
Get current config map.
- getContentId() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getDefaults() - Static method in class com.solace.serdes.common.SerdeProperties
-
Gets a copy of the default SERDE properties.
- getDefaults() - Static method in class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Gets a copy of the default JsonSchemaProperties properties.
- getDeserializedType() - Method in class com.solace.serdes.common.SerdeProperties
-
Retrieves the expected Deserialized type as specified in the configuration.
- getDestinationName() - Method in interface com.solace.serdes.common.resolver.data.Metadata
-
Retrieves the destination name of this record.
- getExplicitArtifactArtifactId() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the
SchemaResolverProperties.EXPLICIT_ARTIFACT_ARTIFACT_ID
which is used to explicitly set the artifactId for querying an artifact in the registry. - getExplicitArtifactGroupId() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the
SchemaResolverProperties.EXPLICIT_ARTIFACT_GROUP_ID
which is used to explicitly set the groupId for querying an artifact in the registry. - getExplicitArtifactVersion() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the
SchemaResolverProperties.EXPLICIT_ARTIFACT_VERSION
which is used to explicitly set the version for querying an artifact in the registry. - getExplicitSchemaId() - Method in class com.solace.serdes.common.SerdeProperties
-
Gets the Explicit SchemeId.
- getGlobalId() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getGroupId() - Method in interface com.solace.serdes.common.resolver.SchemaReference
-
Gets the group ID associated with this schema reference.
- getGroupId() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getInfo() - Static method in interface com.solace.serdes.common.version.VersionInfo
-
Gets a VersionInfo instance.
- getInfo() - Static method in interface com.solace.serdes.jsonschema.version.VersionInfo
-
Gets a VersionInfo instance.
- getInfo() - Static method in interface com.solace.serdes.registry.version.VersionInfo
-
Gets a VersionInfo instance.
- getMappings() - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Returns an independent ordered list of
SolaceTopicArtifactMapping
instances. - getMetadata() - Method in interface com.solace.serdes.common.resolver.data.Record
-
Retrieves the metadata associated with this record.
- getModule() - Method in interface com.solace.serdes.common.version.VersionInfo
-
Gets the module name of the artifact.
- getModule() - Method in interface com.solace.serdes.jsonschema.version.VersionInfo
-
Gets the module name of the artifact.
- getModule() - Method in interface com.solace.serdes.registry.version.VersionInfo
-
Gets the module name of the artifact.
- getName() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getParsedSchema() - Method in interface com.solace.serdes.common.resolver.SchemaLookUpResults
-
Retrieves the parsed schema resulting from the lookup operation.
- getPayload() - Method in interface com.solace.serdes.common.resolver.data.Record
-
Retrieves the payload of this record.
- getRawSchema() - Method in interface com.solace.serdes.common.resolver.ParsedSchema
-
Retrieves the schema as raw bytes.
- getReferenceName() - Method in interface com.solace.serdes.common.resolver.SchemaReference
-
Gets the name of this schema reference.
- getReferencesByName() - Method in interface com.solace.serdes.common.resolver.ParsedSchema
-
Retrieves a map of direct references.
- getRegistryUrl() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the URL of the Solace Schema Registry.
- getRequestAttemptBackoff() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the backoff time in milliseconds between retry attempts when communicating with the schema registry.
- getRequestAttempts() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the number of attempts to make when communicating with the schema registry before giving up.
- getRevision() - Method in interface com.solace.serdes.common.version.VersionInfo
-
Gets the SCM revision identifier (Git commit hash) of the build.
- getRevision() - Method in interface com.solace.serdes.jsonschema.version.VersionInfo
-
Gets the SCM revision identifier (Git commit hash) of the build.
- getRevision() - Method in interface com.solace.serdes.registry.version.VersionInfo
-
Gets the SCM revision identifier (Git commit hash) of the build.
- getSchema() - Method in interface com.solace.serdes.common.resolver.ParsedSchema
-
Retrieves the underlying schema object.
- getSchemaFromData(Record<T>) - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
- getSchemaFromData(Record<U>) - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Extracts the schema from a given data record.
- getSchemaFromLocation(String) - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Retrieves a schema from a specified location in the Java classpath.
- getSchemaFromLocation(String) - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
-
Retrieves a schema from a specified location in the Java classpath.
- getSchemaHeaderIdentifiers() - Method in class com.solace.serdes.common.SerdeProperties
-
Retrieves the schema header identifiers as specified in the configuration.
- getSchemaLocation() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Gets the configured classpath resource path to the schema.
- getSchemaReference() - Method in interface com.solace.serdes.common.resolver.ParsedSchema
-
Retrieves the schema reference for this parsed schema.
- getSchemaReferenceContext() - Method in interface com.solace.serdes.common.resolver.ParsedSchema
-
Retrieves all transitive references in the order to upload.
- getSchemaResolverClass() - Method in class com.solace.serdes.common.SerdeProperties
-
Retrieves a SchemaResolver for the specified schema type.
- getStrategyTopicProfile() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the
SolaceTopicProfile
object specified by theSchemaResolverProperties.STRATEGY_TOPIC_PROFILE
configuration. - getTopicExpression() - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Accessor for the topic expression
- getTrustStorePassword() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Gets the password for the trust store.
- getTrustStorePath() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Gets the path to the trust store file.
- getTypeProperty() - Method in class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Gets the JSON schema property name that contains the Java type class path for deserialization.
- getUseCachedOnError() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Retrieves the use cached on error property specified by the
SchemaResolverProperties.USE_CACHED_ON_ERROR
configuration. - getValidateCertificate() - Method in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Gets the certificate validation setting.
- getValidateSchema() - Method in class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Gets whether JSON schema validation is enabled for serialization and deserialization.
- getValidationMessages() - Method in exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Returns a list of the specific validation error messages associated with this exception.
- getVersion() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReference
- getVersion() - Method in interface com.solace.serdes.common.version.VersionInfo
-
Gets the version string of the artifact.
- getVersion() - Method in interface com.solace.serdes.jsonschema.version.VersionInfo
-
Gets the version string of the artifact.
- getVersion() - Method in interface com.solace.serdes.registry.version.VersionInfo
-
Gets the version string of the artifact.
- globalId(Long) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the global ID for the artifact reference.
- groupId(String) - Method in class com.solace.serdes.common.resolver.SchemaReference.Builder
-
Sets the group ID for the schema reference.
- groupId(String) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the group ID for the artifact reference.
J
- JsonSchemaDeserializer<T> - Class in com.solace.serdes.jsonschema
-
A deserializer for JsonSchema-formatted data that converts byte arrays into objects of type T.
- JsonSchemaDeserializer() - Constructor for class com.solace.serdes.jsonschema.JsonSchemaDeserializer
-
Constructs a new JsonSchemaDeserializer with default configuration.
- JsonSchemaParser<T> - Class in com.solace.serdes.jsonschema
-
Parser for JSON Schema.
- JsonSchemaParser() - Constructor for class com.solace.serdes.jsonschema.JsonSchemaParser
-
Constructs a new JsonSchemaParser with default configuration.
- JsonSchemaProperties - Class in com.solace.serdes.jsonschema
-
A class for configuring json schema properties.
- JsonSchemaProperties() - Constructor for class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Constructs a new JsonSchemaProperties instance with default properties.
- JsonSchemaProperties(Map<String, ?>) - Constructor for class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Constructs a new JsonSchemaProperties instance with default properties then applies properties from the passed in map.
- JsonSchemaSerializer<T> - Class in com.solace.serdes.jsonschema
-
A Json Schema serializer that converts objects of type T into byte arrays.
- JsonSchemaSerializer() - Constructor for class com.solace.serdes.jsonschema.JsonSchemaSerializer
-
Constructs a new JsonSchemaSerializer with default configuration.
- JsonSchemaValidationException - Exception in com.solace.serdes.jsonschema
-
Exception thrown when validation of serialized data against the schema fails.
- JsonSchemaValidationException() - Constructor for exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Constructs a new SerializationValidationException with no message.
- JsonSchemaValidationException(String) - Constructor for exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Constructs a new SerializationValidationException with the specified message.
- JsonSchemaValidationException(String, Throwable) - Constructor for exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Constructs a new SerializationValidationException with the specified message and cause.
- JsonSchemaValidationException(String, List<String>) - Constructor for exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Constructs a new JsonSchemaValidationException with the specified detail message and a list of specific validation error messages.
- JsonSchemaValidationException(Throwable) - Constructor for exception com.solace.serdes.jsonschema.JsonSchemaValidationException
-
Constructs a new SerializationValidationException with the specified cause.
L
- loadSchema() - Method in interface com.solace.serdes.common.resolver.strategy.ArtifactReferenceResolverStrategy
-
Determines whether to load and provide the parsed schema to the
ArtifactReferenceResolverStrategy.artifactReference(Record, ParsedSchema)
method. - loadSchema() - Method in class com.solace.serdes.common.resolver.strategy.DestinationIdStrategy
M
- match(String) - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicArtifactMapping
-
Method for matching a given destination name to a topic expression.
- Metadata - Interface in com.solace.serdes.common.resolver.data
-
Represents metadata associated with a record.
N
- name(String) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the name for the artifact reference.
P
- parse(byte[], Map<String, byte[]>) - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Parses a raw schema from a byte array, considering any referenced schemas.
- parse(byte[], Map<String, byte[]>) - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
- ParsedSchema<S> - Interface in com.solace.serdes.common.resolver
-
An interface representing a parsed schema.
R
- Record<T> - Interface in com.solace.serdes.common.resolver.data
-
Represents a record containing the destination name and a payload of a generic type.
- referenceName(String) - Method in class com.solace.serdes.common.resolver.SchemaReference.Builder
-
Sets the reference name for the schema reference.
- REGISTRY_URL - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
The URL of the Schema Registry.
- remove(int) - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Removes a
SolaceTopicArtifactMapping
at the specified index. - remove(SolaceTopicArtifactMapping) - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Removes the specified
SolaceTopicArtifactMapping
. - remove(String) - Method in interface com.solace.serdes.common.resolver.strategy.SolaceTopicProfile
-
Removes the first
SolaceTopicArtifactMapping
that matches the given topic expression. - REQUEST_ATTEMPT_BACKOFF_MS - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Specifies the backoff time in milliseconds between retry attempts when communicating with the schema registry.
- REQUEST_ATTEMPTS - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Specifies the number of attempts to make when communicating with the schema registry before giving up.
- resolveSchema(Record<T>) - Method in class com.solace.serdes.common.resolver.DefaultSchemaResolver
- resolveSchema(Record<T>) - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Resolves a schema based on the given record.
- resolveSchema(ArtifactReference) - Method in class com.solace.serdes.common.resolver.DefaultSchemaResolver
- resolveSchema(ArtifactReference) - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Resolves a schema based on the given artifact reference.
S
- SCHEMA_HEADER_IDENTIFIERS - Static variable in class com.solace.serdes.common.SerdeProperties
-
Property key for setting one or more schema header identifiers to be encoded in the serializer headers.
- SCHEMA_ID - com.solace.serdes.common.SchemaHeaderId
-
Represents the schema identifier as a
long
value. - SCHEMA_ID - Static variable in class com.solace.serdes.common.SerdeHeaders
-
A long valued schema ID used by the schema registry to uniquely identify a schema.
- SCHEMA_ID_STRING - com.solace.serdes.common.SchemaHeaderId
-
Represents the schema identifier as a
String
value. - SCHEMA_ID_STRING - Static variable in class com.solace.serdes.common.SerdeHeaders
-
A String valued schema ID used by the schema registry to uniquely identify a schema.
- SCHEMA_LOCATION - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Specifies the classpath resource path to the schema to be used for validation.
- SCHEMA_RESOLVER - Static variable in class com.solace.serdes.common.SerdeProperties
-
Property key for specifying a custom schema resolver implementation.
- SchemaHeaderId - Enum in com.solace.serdes.common
-
An ENUM for configuring which schema identifier to use in the serializer headers.
- SchemaLookUpResults<S> - Interface in com.solace.serdes.common.resolver
-
An interface representing the results of a schema lookup operation.
- SchemaParser<S,U> - Interface in com.solace.serdes.common.resolver
-
Represents a generic schema parser interface.
- SchemaReference - Interface in com.solace.serdes.common.resolver
-
Represents a reference to a schema in the Solace Schema Registry.
- SchemaReference.Builder - Class in com.solace.serdes.common.resolver
-
Builder class for creating SchemaReference instances.
- SchemaResolver<T,S> - Interface in com.solace.serdes.common.resolver
-
An interface for resolving schemas.
- SchemaResolverProperties - Class in com.solace.serdes.common.resolver.config
-
A class for configuring Schema Resolver properties.
- SchemaResolverProperties() - Constructor for class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Constructs a new SchemaResolverProperties instance with default properties.
- SchemaResolverProperties(Map<String, ?>) - Constructor for class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Constructs a new SchemaResolverProperties instance with default properties then applies properties from the passed in map.
- SchemaResolverProperties.IfArtifactExists - Enum in com.solace.serdes.common.resolver.config
-
Enumeration for controlling the behavior when registering an artifact that might already exist in the schema registry.
- SerdeHeaders - Class in com.solace.serdes.common
-
A class that contains header properties.
- SerdeProperties - Class in com.solace.serdes.common
-
A class for configuring common properties.
- SerdeProperties() - Constructor for class com.solace.serdes.common.SerdeProperties
-
Constructs a new SerdeProperties instance with default properties.
- SerdeProperties(Map<String, ?>) - Constructor for class com.solace.serdes.common.SerdeProperties
-
Constructs a new SerdeProperties instance with default properties then applies properties from the passed in map.
- serialize(String, T) - Method in class com.solace.serdes.common.AbstractSerializer
-
Serializes the given object.
- serialize(String, T, Map<String, Object>) - Method in class com.solace.serdes.common.AbstractSerializer
-
Serializes the given object and adds the schema ID to the headers.
- setClient(RegistryClient) - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Sets the client for this
SchemaResolver
. - setSchemaParser(SchemaParser<S, T>) - Method in class com.solace.serdes.common.resolver.DefaultSchemaResolver
- setSchemaParser(SchemaParser<S, T>) - Method in interface com.solace.serdes.common.resolver.SchemaResolver
-
Sets the schema parser for the
SchemaResolver
. - SolaceTopicArtifactMapping - Interface in com.solace.serdes.common.resolver.strategy
-
Interface to describe a mapping between a Solace topic expression and schema registry artifact reference.
- SolaceTopicIdStrategy<T,S> - Class in com.solace.serdes.common.resolver.strategy
-
A strategy for resolving artifact references based on Solace topic patterns.
- SolaceTopicIdStrategy(SolaceTopicProfile) - Constructor for class com.solace.serdes.common.resolver.strategy.SolaceTopicIdStrategy
-
Constructs a new SolaceTopicIdStrategy with the specified topic profile.
- SolaceTopicProfile - Interface in com.solace.serdes.common.resolver.strategy
-
A
SolaceTopicProfile
is a collection ofSolaceTopicArtifactMapping
instances. - STRATEGY_TOPIC_PROFILE - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Optional property that specifies a
SolaceTopicProfile
object used by theSolaceTopicIdStrategy
to map topics to artifact references. - supportsGetSchemaFromData() - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Flag that indicates if
SchemaParser.getSchemaFromData(Record)
is implemented or not. - supportsGetSchemaFromData() - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
- supportsGetSchemaFromLocation() - Method in interface com.solace.serdes.common.resolver.SchemaParser
-
Flag that indicates if
SchemaParser.getSchemaFromLocation(String)
is implemented or not. - supportsGetSchemaFromLocation() - Method in class com.solace.serdes.jsonschema.JsonSchemaParser
-
Indicates that this parser supports retrieving schemas from classpath resources.
T
- TRUST_STORE_PASSWORD - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Property key for specifying the password of the trust store.
- TRUST_STORE_PATH - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Property key for specifying the path to the trust store file.
- TYPE_PROPERTY - Static variable in class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Specifies the JSON schema property name that contains the Java type class path for deserialization.
U
- USE_CACHED_ON_ERROR - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Controls whether to use cached schemas when schema registry lookup errors occur.
V
- VALIDATE_CERTIFICATE - Static variable in class com.solace.serdes.common.resolver.config.SchemaResolverProperties
-
Property key for enabling or disabling certificate validation.
- VALIDATE_SCHEMA - Static variable in class com.solace.serdes.jsonschema.JsonSchemaProperties
-
Boolean flag that enables JSON schema validation during serialization/deserialization.
- valueOf(String) - Static method in enum com.solace.serdes.common.resolver.config.SchemaResolverProperties.IfArtifactExists
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.solace.serdes.common.SchemaHeaderId
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.solace.serdes.common.resolver.config.SchemaResolverProperties.IfArtifactExists
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.solace.serdes.common.SchemaHeaderId
-
Returns an array containing the constants of this enum type, in the order they are declared.
- version(String) - Method in class com.solace.serdes.common.resolver.strategy.ArtifactReferenceBuilder
-
Sets the version for the artifact reference.
- VersionInfo - Interface in com.solace.serdes.common.version
-
Provides access to the artifact's version and build revision information.
- VersionInfo - Interface in com.solace.serdes.jsonschema.version
-
Provides access to the artifact's version and build revision information.
- VersionInfo - Interface in com.solace.serdes.registry.version
-
Provides access to the artifact's version and build revision information.
All Classes All Packages