org.eclipse.ditto.protocoladapter

Class DittoProtocolAdapter

java.lang.Object

org.eclipse.ditto.protocoladapter.DittoProtocolAdapter

All Implemented Interfaces:

ProtocolAdapter

public final class DittoProtocolAdapter
extends Object
implements ProtocolAdapter

Adapter for the Ditto protocol.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DittoProtocolAdapter(org.eclipse.ditto.signals.base.ErrorRegistry<org.eclipse.ditto.model.base.exceptions.DittoRuntimeException> errorRegistry, HeaderTranslator headerTranslator)

Method Summary

Modifier and Type	Method and Description
org.eclipse.ditto.signals.base.Signal<?>	fromAdaptable(Adaptable adaptable) Maps the given adaptable to the corresponding Signal, which can be a Command, CommandResponse or an Event.
static HeaderTranslator	getHeaderTranslator() Creates a default header translator for this protocol adapter.
HeaderTranslator	headerTranslator() Retrieve the header translator responsible for this protocol adapter.
static DittoProtocolAdapter	newInstance() Creates a new DittoProtocolAdapter instance.
static DittoProtocolAdapter	of(HeaderTranslator headerTranslator) Creates a new DittoProtocolAdapter instance with the given header translator.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.base.Command<?> command) Maps the given command to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.base.Command<?> command, TopicPath.Channel channel) Maps the given command to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.base.CommandResponse<?> commandResponse) Maps the given CommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.base.CommandResponse<?> commandResponse, TopicPath.Channel channel) Maps the given CommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.events.base.Event<?> event) Maps the given event to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.events.base.Event<?> event, TopicPath.Channel channel) Maps the given event to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.messages.MessageCommand<?,?> messageCommand) Maps the given messageCommand to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.messages.MessageCommandResponse<?,?> messageCommandResponse) Maps the given messageCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.base.Signal<?> signal) Maps the given Signal to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.ThingCommandResponse<?> thingCommandResponse) Maps the given ThingCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.ThingCommandResponse<?> thingCommandResponse, TopicPath.Channel channel) Maps the given ThingCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.ThingErrorResponse thingErrorResponse, TopicPath.Channel channel) Maps the given thingErrorResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.events.things.ThingEvent<?> thingEvent) Maps the given thingEvent to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.events.things.ThingEvent<?> thingEvent, TopicPath.Channel channel) Maps the given thingEvent to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommand<?> thingModifyCommand) Maps the given thingModifyCommand to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommand<?> thingModifyCommand, TopicPath.Channel channel) Maps the given thingModifyCommand to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommandResponse<?> thingModifyCommandResponse) Maps the given thingModifyCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommandResponse<?> thingModifyCommandResponse, TopicPath.Channel channel) Maps the given thingModifyCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand<?> thingQueryCommand) Maps the given thingQueryCommand to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand<?> thingQueryCommand, TopicPath.Channel channel) Maps the given thingQueryCommand to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommandResponse<?> thingQueryCommandResponse) Maps the given thingQueryCommandResponse to an Adaptable.
Adaptable	toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommandResponse<?> thingQueryCommandResponse, TopicPath.Channel channel) Maps the given thingQueryCommandResponse to an Adaptable.

Methods inherited from class java.lang.Object

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

Constructor Detail

DittoProtocolAdapter

protected DittoProtocolAdapter(org.eclipse.ditto.signals.base.ErrorRegistry<org.eclipse.ditto.model.base.exceptions.DittoRuntimeException> errorRegistry,
                               HeaderTranslator headerTranslator)

Method Detail

of

public static DittoProtocolAdapter of(HeaderTranslator headerTranslator)

Creates a new DittoProtocolAdapter instance with the given header translator.

Parameters:

headerTranslator - translator between external and Ditto headers.

newInstance

public static DittoProtocolAdapter newInstance()

Creates a new DittoProtocolAdapter instance.

Returns:

the instance.

getHeaderTranslator

public static HeaderTranslator getHeaderTranslator()

Creates a default header translator for this protocol adapter.

Returns:

the default header translator.

fromAdaptable

public org.eclipse.ditto.signals.base.Signal<?> fromAdaptable(Adaptable adaptable)

Description copied from interface: ProtocolAdapter

Maps the given adaptable to the corresponding Signal, which can be a Command, CommandResponse or an Event.

Specified by:

fromAdaptable in interface ProtocolAdapter

Parameters:

adaptable - the adaptable.

Returns:

the Signal.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.base.Signal<?> signal)

Description copied from interface: ProtocolAdapter

Maps the given Signal to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

signal - the signal.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.base.CommandResponse<?> commandResponse)

Description copied from interface: ProtocolAdapter

Maps the given CommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

commandResponse - the response.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.base.CommandResponse<?> commandResponse,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given CommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

commandResponse - the response.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.ThingCommandResponse<?> thingCommandResponse)

Description copied from interface: ProtocolAdapter

Maps the given ThingCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingCommandResponse - the response.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.ThingCommandResponse<?> thingCommandResponse,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given ThingCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingCommandResponse - the response.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.messages.MessageCommand<?,?> messageCommand)

Description copied from interface: ProtocolAdapter

Maps the given messageCommand to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

messageCommand - the messageCommand.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.messages.MessageCommandResponse<?,?> messageCommandResponse)

Description copied from interface: ProtocolAdapter

Maps the given messageCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

messageCommandResponse - the messageCommandResponse.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.base.Command<?> command)

Description copied from interface: ProtocolAdapter

Maps the given command to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

command - the command.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.base.Command<?> command,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given command to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

command - the command.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommand<?> thingModifyCommand)

Description copied from interface: ProtocolAdapter

Maps the given thingModifyCommand to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingModifyCommand - the command.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommand<?> thingModifyCommand,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingModifyCommand to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingModifyCommand - the command.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommandResponse<?> thingModifyCommandResponse)

Description copied from interface: ProtocolAdapter

Maps the given thingModifyCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingModifyCommandResponse - the response.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.modify.ThingModifyCommandResponse<?> thingModifyCommandResponse,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingModifyCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingModifyCommandResponse - the response.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand<?> thingQueryCommand)

Description copied from interface: ProtocolAdapter

Maps the given thingQueryCommand to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingQueryCommand - the command.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand<?> thingQueryCommand,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingQueryCommand to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingQueryCommand - the command.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommandResponse<?> thingQueryCommandResponse)

Description copied from interface: ProtocolAdapter

Maps the given thingQueryCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingQueryCommandResponse - the response.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.query.ThingQueryCommandResponse<?> thingQueryCommandResponse,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingQueryCommandResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingQueryCommandResponse - the response.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.commands.things.ThingErrorResponse thingErrorResponse,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingErrorResponse to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingErrorResponse - the error response.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.events.base.Event<?> event)

Description copied from interface: ProtocolAdapter

Maps the given event to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

event - the event.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.events.base.Event<?> event,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given event to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

event - the event.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.events.things.ThingEvent<?> thingEvent)

Description copied from interface: ProtocolAdapter

Maps the given thingEvent to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingEvent - the event.

Returns:

the adaptable.

toAdaptable

public Adaptable toAdaptable(org.eclipse.ditto.signals.events.things.ThingEvent<?> thingEvent,
                             TopicPath.Channel channel)

Description copied from interface: ProtocolAdapter

Maps the given thingEvent to an Adaptable.

Specified by:

toAdaptable in interface ProtocolAdapter

Parameters:

thingEvent - the event.

channel - the Channel (Twin/Live) to use.

Returns:

the adaptable.

headerTranslator

public HeaderTranslator headerTranslator()

Description copied from interface: ProtocolAdapter

Retrieve the header translator responsible for this protocol adapter.

Specified by:

headerTranslator in interface ProtocolAdapter

Returns:

the header translator.