org.eclipse.ditto.protocoladapter

Interface ProtocolAdapter

All Known Implementing Classes:

DittoProtocolAdapter

public interface ProtocolAdapter

A protocol adapter provides methods for mapping Signal instances to an Adaptable.

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.
HeaderTranslator	headerTranslator() Retrieve the header translator responsible for this protocol adapter.
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.

Method Detail

fromAdaptable

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.

Parameters:

adaptable - the adaptable.

Returns:

the Signal.

toAdaptable

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

Maps the given Signal to an Adaptable.

Parameters:

signal - the signal.

Returns:

the adaptable.

Throws:

UnknownSignalException - if the passed Signal was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given CommandResponse to an Adaptable.

Parameters:

commandResponse - the response.

Returns:

the adaptable.

Throws:

UnknownCommandResponseException - if the passed CommandResponse was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given CommandResponse to an Adaptable.

Parameters:

commandResponse - the response.

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

Returns:

the adaptable.

Throws:

UnknownCommandResponseException - if the passed CommandResponse was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given ThingCommandResponse to an Adaptable.

Parameters:

thingCommandResponse - the response.

Returns:

the adaptable.

Throws:

UnknownCommandResponseException - if the passed ThingCommandResponse was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given ThingCommandResponse to an Adaptable.

Parameters:

thingCommandResponse - the response.

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

Returns:

the adaptable.

Throws:

UnknownCommandResponseException - if the passed ThingCommandResponse was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given messageCommand to an Adaptable.

Parameters:

messageCommand - the messageCommand.

Returns:

the adaptable.

Throws:

UnknownCommandException - if the passed MessageCommand was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given messageCommandResponse to an Adaptable.

Parameters:

messageCommandResponse - the messageCommandResponse.

Returns:

the adaptable.

Throws:

UnknownCommandException - if the passed MessageCommandResponse was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given command to an Adaptable.

Parameters:

command - the command.

Returns:

the adaptable.

Throws:

UnknownCommandException - if the passed Command was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given command to an Adaptable.

Parameters:

command - the command.

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

Returns:

the adaptable.

Throws:

UnknownCommandException - if the passed Command was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given thingModifyCommand to an Adaptable.

Parameters:

thingModifyCommand - the command.

Returns:

the adaptable.

toAdaptable

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

Maps the given thingModifyCommand to an Adaptable.

Parameters:

thingModifyCommand - the command.

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

Returns:

the adaptable.

toAdaptable

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

Maps the given thingModifyCommandResponse to an Adaptable.

Parameters:

thingModifyCommandResponse - the response.

Returns:

the adaptable.

toAdaptable

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

Maps the given thingModifyCommandResponse to an Adaptable.

Parameters:

thingModifyCommandResponse - the response.

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

Returns:

the adaptable.

toAdaptable

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

Maps the given thingQueryCommand to an Adaptable.

Parameters:

thingQueryCommand - the command.

Returns:

the adaptable.

toAdaptable

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

Maps the given thingQueryCommand to an Adaptable.

Parameters:

thingQueryCommand - the command.

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

Returns:

the adaptable.

toAdaptable

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

Maps the given thingQueryCommandResponse to an Adaptable.

Parameters:

thingQueryCommandResponse - the response.

Returns:

the adaptable.

toAdaptable

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

Maps the given thingQueryCommandResponse to an Adaptable.

Parameters:

thingQueryCommandResponse - the response.

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

Returns:

the adaptable.

toAdaptable

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

Maps the given thingErrorResponse to an Adaptable.

Parameters:

thingErrorResponse - the error response.

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

Returns:

the adaptable.

toAdaptable

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

Maps the given event to an Adaptable.

Parameters:

event - the event.

Returns:

the adaptable.

Throws:

UnknownEventException - if the passed Event was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given event to an Adaptable.

Parameters:

event - the event.

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

Returns:

the adaptable.

Throws:

UnknownEventException - if the passed Event was not supported by the ProtocolAdapter

toAdaptable

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

Maps the given thingEvent to an Adaptable.

Parameters:

thingEvent - the event.

Returns:

the adaptable.

toAdaptable

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

Maps the given thingEvent to an Adaptable.

Parameters:

thingEvent - the event.

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

Returns:

the adaptable.

headerTranslator

HeaderTranslator headerTranslator()

Retrieve the header translator responsible for this protocol adapter.

Returns:

the header translator.