Package org.infinispan.protostream.config

Interface Configuration

All Known Implementing Classes:

ConfigurationImpl

public interface Configuration

Configuration interface for the ProtoStream library. This object is not mutable once built. Use the Configuration.Builder in order to create a new instance.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Configuration.AnnotationsConfig
static interface	Configuration.Builder
static enum	Configuration.SchemaValidation

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_NESTED_DEPTH
static final String	TYPE_ID_ANNOTATION	The name of the TypeId annotation.

Method Summary

Modifier and Type	Method	Description
Configuration.AnnotationsConfig	annotationsConfig()
static Configuration.Builder	builder()
boolean	logOutOfSequenceReads()	Flag that indicates in out of sequence reads should be logged as warnings.
boolean	logOutOfSequenceWrites()	Flag that indicates in out of sequence writes should be logged as warnings.
int	maxNestedMessageDepth()	The max nested message depth to apply to all GeneratedMarshallerBases.
Configuration.SchemaValidation	schemaValidation()	The type of validation done when updating schemas in the SerializationContext.
boolean	wrapCollectionElements()

Field Details

DEFAULT_MAX_NESTED_DEPTH

static final int DEFAULT_MAX_NESTED_DEPTH

See Also:

• Constant Field Values

TYPE_ID_ANNOTATION

static final String TYPE_ID_ANNOTATION

The name of the TypeId annotation. This optional annotation defines a unique positive integer type identifier for each message or enum type. This can be used alternatively instead of the fully qualified type name during marshalling of a WrappedMessage to save bandwidth. Values in range [0..65535] are reserved for internal use by Protostream and related projects from the Infinispan organisation.

This annotation is pre-defined in all configurations. You do not have to define it manually.

See Also:

• Constant Field Values

Method Details

logOutOfSequenceReads

boolean logOutOfSequenceReads()

Flag that indicates in out of sequence reads should be logged as warnings. This is true by default.

logOutOfSequenceWrites

boolean logOutOfSequenceWrites()

Flag that indicates in out of sequence writes should be logged as warnings. This is true by default.

maxNestedMessageDepth

int maxNestedMessageDepth()

The max nested message depth to apply to all GeneratedMarshallerBases. This value is used as way to avoid recurring on circular dependencies without the need to maintain the list of already visited entities. Default to DEFAULT_MAX_NESTED_DEPTH

schemaValidation

Configuration.SchemaValidation schemaValidation()

The type of validation done when updating schemas in the SerializationContext. Default to Configuration.SchemaValidation.STRICT

wrapCollectionElements

boolean wrapCollectionElements()

annotationsConfig

Configuration.AnnotationsConfig annotationsConfig()

builder

static Configuration.Builder builder()