Package org.eclipse.ditto.protocoladapter

The Ditto Protocol Adapter provides a wrapper for the Ditto internal protocol. This package provides the corresponding interfaces as well as implementations.

Please note that Ditto Protocol Adapter is designed for immutability. Therefore each object is immutable and thus thread safe. If interfaces provide methods for altering an object then invoking this method does not change the state of that object but a new object with the altered state is returned instead. This is the same behavior like it is shown by java.lang.String for example.

Interface Summary

Interface	Description
AcknowledgementTopicPathBuilder	Builder to create a topic path for Acknowledgements.
Adaptable	An Adaptable can be mapped to and from a Command, CommandResponse or Event.
AdaptableBuilder	A builder to create Adaptable instances.
Adapter<T extends org.eclipse.ditto.model.base.json.Jsonifiable<?>>	An Adapter maps objects of type Adapter to an Adaptable and vice versa.
CommandsTopicPathBuilder	Builder to create a topic path for commands.
ErrorResponseAdapter<T extends org.eclipse.ditto.signals.commands.base.ErrorResponse<?>>	An Adapter mixin for error responses.
EventAdapter<T extends org.eclipse.ditto.signals.events.base.Event<?>>	An Adapter maps objects of type EventAdapter to an Adaptable and vice versa.
EventsTopicPathBuilder	Builder to create a topic path for events.
JsonifiableAdaptable	Adaptable which is also Jsonifiable (e.g.
JsonifiableMapper<T extends org.eclipse.ditto.model.base.json.Jsonifiable>	Functional interface for mapping an Adaptable to JsonifiableMapper.
MessagePath	Represent the path field of Ditto protocol messages.
MessagesTopicPathBuilder	Builder to create a topic path for messages.
ModifyCommandAdapter<T extends org.eclipse.ditto.signals.commands.base.Command<?>>	An Adapter mixin for modify commands.
ModifyCommandResponseAdapter<T extends org.eclipse.ditto.signals.commands.base.CommandResponse<?>>	An Adapter mixin for modify command responses.
Payload	Represents the Payload of an Adaptable.
PayloadBuilder	A builder to create Payload instances.
PayloadPathMatcher	Matches and maps the path to an internal command name.
ProtocolAdapter	A protocol adapter provides methods for mapping Signal instances to an Adaptable.
QueryCommandAdapter<T extends org.eclipse.ditto.signals.commands.base.Command<?>>	An Adapter mixin for query commands.
QueryCommandResponseAdapter<T extends org.eclipse.ditto.signals.commands.base.CommandResponse<?>>	An Adapter mixin for retrieve command responses.
SearchTopicPathBuilder	Builder to create a topic path for commands.
TopicPath	Represents the path of a topic for the Ditto Protocol.
TopicPathBuildable	Provides a build method to actually build a topic path.
TopicPathBuilder	A builder to create TopicPath instances.

Class Summary

Class	Description
AbstractAdapter<T extends org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>>	Abstract implementation of Adapter to provide common functionality.
AbstractErrorResponseAdapter<T extends org.eclipse.ditto.signals.commands.base.ErrorResponse<T>>	Adapter for mapping a ErrorResponse to and from an Adaptable.
DefaultPayloadPathMatcher	Utility class for matching Payload path.
DittoEncodingHelper	Utility for encoding/decoding parts used in names / IDs in Ditto, e.g.
DittoProtocolAdapter	Adapter for the Ditto protocol.
HeaderTranslator	Utility for translating Headers from external sources or to external sources.
JsonifiableAdaptable.JsonFields	Json Fields of the Jsonifiable PlainJsonAdaptable.
Payload.JsonFields	Json Fields of the Jsonifiable Payload.
ProtocolFactory	Factory for the Protocol Adapter library.
UnknownChannelException.Builder	A mutable builder with a fluent API for a UnknownChannelException.
UnknownCommandException.Builder	A mutable builder with a fluent API for a UnknownCommandException.
UnknownCommandResponseException.Builder	A mutable builder with a fluent API for a UnknownCommandResponseException.
UnknownEventException.Builder	A mutable builder with a fluent API for a UnknownEventException.
UnknownPathException.Builder	A mutable builder with a fluent API for a UnknownPathException.
UnknownSignalException.Builder	A mutable builder with a fluent API for a UnknownSignalException.
UnknownTopicPathException.Builder	A mutable builder with a fluent API for a UnknownTopicPathException.

Enum Summary

Enum	Description
TopicPath.Action	An enumeration of topic path actions.
TopicPath.Channel	An enumeration of topic path channel.
TopicPath.Criterion	An enumeration of topic path criteria.
TopicPath.Group	An enumeration of topic path groups.
TopicPath.SearchAction	An enumeration of topic path search-actions.

Exception Summary

Exception	Description
UnknownChannelException	Thrown if a TopicPath.Channel is not supported in combination with the provided Signal.
UnknownCommandException	Thrown if a Command is not supported.
UnknownCommandResponseException	Thrown if a CommandResponse is not supported.
UnknownEventException	Thrown if a Event is not supported.
UnknownPathException	Thrown if a path does not correspond to any known command, response or event.
UnknownSignalException	Thrown if a Signal is not supported.
UnknownTopicPathException	Thrown if a TopicPath is not supported.