Package com.solace.serdes.avro

Class AvroProperties

java.lang.Object

com.solace.serdes.common.resolver.config.BaseProperties

com.solace.serdes.common.SerdeProperties

com.solace.serdes.avro.AvroProperties

public class AvroProperties
extends SerdeProperties

A class for configuring Avro specific properties. This is used by AvroSerializer and AvroDeserializer.

See Also:

AvroSerializer.configure(Map), AvroDeserializer.configure(Map)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AvroProperties.AvroEncoding	Options for ENCODING_TYPE.
static class	AvroProperties.AvroRecordType	Options for RECORD_TYPE.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEREFERENCED_SCHEMA	Optional boolean flag that instructs the SERDES to request the dereferenced Avro schema from the registry.
static String	ENCODING_TYPE	Select the type of encoding for the AvroSerializer.
static String	RECORD_TYPE	Selects the type of record to be used for AvroDeserializer.

Fields inherited from class com.solace.serdes.common.SerdeProperties

DESERIALIZED_TYPE, EXPLICIT_SCHEMA_ID, SCHEMA_HEADER_IDENTIFIERS, SCHEMA_RESOLVER

Constructor Summary

Constructors

Constructor	Description
AvroProperties()	Constructs a new AvroProperties instance with default properties.
AvroProperties(Map<String,?> map)	Constructs a new AvroProperties instance with default properties then applies properties from the passed in map.

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	getDefaults()	Gets a copy of the default AvroProperties properties.
AvroProperties.AvroEncoding	getEncodingType()	Gets the encoding type for Avro serialization.
AvroProperties.AvroRecordType	getRecordType()	Gets the record type for Avro deserialization.
boolean	resolveDereferenced()	Retrieves the DEREFERENCED_SCHEMA boolean flag that determines whether the SERDES should request to have the Avro schema dereferenced from the registry.

Methods inherited from class com.solace.serdes.common.SerdeProperties

getDeserializedType, getExplicitSchemaId, getSchemaHeaderIdentifiers, getSchemaResolverClass

Methods inherited from class com.solace.serdes.common.resolver.config.BaseProperties

getConfig

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING_TYPE

public static final String ENCODING_TYPE

Select the type of encoding for the AvroSerializer. Valid values include AvroProperties.AvroEncoding or String representation of the AvroProperties.AvroEncoding enum.

See Also:

Constant Field Values

RECORD_TYPE

public static final String RECORD_TYPE

Selects the type of record to be used for AvroDeserializer. Valid values include AvroProperties.AvroRecordType or String representations of the AvroProperties.AvroRecordType enum.

See Also:

Constant Field Values

DEREFERENCED_SCHEMA

public static final String DEREFERENCED_SCHEMA

Optional boolean flag that instructs the SERDES to request the dereferenced Avro schema from the registry.

Important notes:

• If SchemaResolverProperties.FIND_LATEST_ARTIFACT is set to true, this property is ignored.
• When this property is enabled, referenced Avro schemas stored in the registry cannot be resolved. Therefore, only use dereferenced Avro schemas if this property is set to true.

See Also:

Constant Field Values

Constructor Detail

AvroProperties

public AvroProperties()

Constructs a new AvroProperties instance with default properties.

AvroProperties

public AvroProperties(Map<String,?> map)

Constructs a new AvroProperties instance with default properties then applies properties from the passed in map.

Parameters:

map - A map that is applied after the default properties are applied.

Method Detail

getDefaults

public static Map<String,Object> getDefaults()

Gets a copy of the default AvroProperties properties. This contains defaults defined in SerdeProperties.

Returns:

A copy of the default set properties.

See Also:

SerdeProperties

getEncodingType

public AvroProperties.AvroEncoding getEncodingType()

Gets the encoding type for Avro serialization. Defaults to BINARY.

Returns:

The Avro encoding type

Throws:

IllegalStateException - when the key AvroProperties.ENCODING_TYPE matches one of the following cases:

1. The value is neither a String nor a AvroProperties.AvroEncoding
2. The value is a String, but is not parsable as a AvroProperties.AvroEncoding

getRecordType

public AvroProperties.AvroRecordType getRecordType()

Gets the record type for Avro deserialization. Defaults to GENERIC_RECORD.

Returns:

The Avro record type

Throws:

IllegalStateException - when the key AvroProperties.RECORD_TYPE matches one of the following cases:

1. The value is neither a String nor a AvroProperties.AvroRecordType
2. The value is a String, but is not parsable as a AvroProperties.AvroRecordType

resolveDereferenced

public boolean resolveDereferenced()

Retrieves the DEREFERENCED_SCHEMA boolean flag that determines whether the SERDES should request to have the Avro schema dereferenced from the registry.

Returns:

The boolean value of the DEREFERENCED_SCHEMA boolean flag.