org.eclipse.kura.cloudconnection.request

Interface RequestHandler

@ConsumerType
public interface RequestHandler

Implemented by services that want to implement remote resource management.

• doGet(org.eclipse.kura.cloudconnection.request.RequestHandlerContext, org.eclipse.kura.cloudconnection.message.KuraMessage) is used to implement a READ request for a resource identified in the supplied KuraMessage)
• doPut(org.eclipse.kura.cloudconnection.request.RequestHandlerContext, org.eclipse.kura.cloudconnection.message.KuraMessage) is used to implement a CREATE or UPDATE request for a resource identified in the supplied KuraMessage
• doDel(org.eclipse.kura.cloudconnection.request.RequestHandlerContext, org.eclipse.kura.cloudconnection.message.KuraMessage) is used to implement a DELETE request for a resource identified in the supplied KuraMessage
• doPost(org.eclipse.kura.cloudconnection.request.RequestHandlerContext, org.eclipse.kura.cloudconnection.message.KuraMessage) is used to implement other operations on a resource identified in the supplied KuraMessage
• doExec(org.eclipse.kura.cloudconnection.request.RequestHandlerContext, org.eclipse.kura.cloudconnection.message.KuraMessage) is used to perform application operation not necessary tied to a given resource.

Every request is also associated to a RequestHandlerContext that specifies the request context and can be used to send notification messages, keeping the link with the original cloud stack that started the interaction.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
default KuraMessage	doDel(RequestHandlerContext context, KuraMessage reqMessage) Used to implement a DELETE request for a resource identified by the supplied CloudletResources)
default KuraMessage	doExec(RequestHandlerContext context, KuraMessage reqMessage) Used to perform application operation not necessary tied to a given resource
default KuraMessage	doGet(RequestHandlerContext context, KuraMessage reqMessage) Used to implement a READ request for a resource identified by the supplied CloudletResources)
default KuraMessage	doPost(RequestHandlerContext context, KuraMessage reqMessage) Used to implement other operations on a resource identified by the supplied CloudletResources)
default KuraMessage	doPut(RequestHandlerContext context, KuraMessage reqMessage) Used to implement a CREATE or UPDATE request for a resource identified by the supplied CloudletResources)

Method Detail

doGet

default KuraMessage doGet(RequestHandlerContext context,
                          KuraMessage reqMessage)
                   throws KuraException

Used to implement a READ request for a resource identified by the supplied CloudletResources)

Parameters:

context - a request context that can be used, for example, to publish notification messages to the remote cloud platform

reqMessage - represents, as a KuraMessage, the received message

Returns:

the response to be provided back as KuraMessage

Throws:

KuraException - An exception is thrown in every condition where the request cannot be full fitted due to wrong request parameters or exceptions during processing

doPut

default KuraMessage doPut(RequestHandlerContext context,
                          KuraMessage reqMessage)
                   throws KuraException

Used to implement a CREATE or UPDATE request for a resource identified by the supplied CloudletResources)

Parameters:

context - a request context that can be used, for example, to publish notification messages to the remote cloud platform

reqMessage - represents as a KuraMessage the received message

Returns:

the response to be provided back as KuraMessage

Throws:

KuraException - An exception is thrown in every condition where the request cannot be full fitted due to wrong request parameters or exceptions during processing

doPost

default KuraMessage doPost(RequestHandlerContext context,
                           KuraMessage reqMessage)
                    throws KuraException

Used to implement other operations on a resource identified by the supplied CloudletResources)

Parameters:

context - a request context that can be used, for example, to publish notification messages to the remote cloud platform

reqMessage - represents as a KuraMessage the received message

Returns:

the response to be provided back as KuraMessage

Throws:

KuraException - An exception is thrown in every condition where the request cannot be full fitted due to wrong request parameters or exceptions during processing

doDel

default KuraMessage doDel(RequestHandlerContext context,
                          KuraMessage reqMessage)
                   throws KuraException

Used to implement a DELETE request for a resource identified by the supplied CloudletResources)

Parameters:

context - a request context that can be used, for example, to publish notification messages to the remote cloud platform

reqMessage - represents as a KuraMessage the received message

Returns:

the response to be provided back as KuraMessage

Throws:

KuraException - An exception is thrown in every condition where the request cannot be full fitted due to wrong request parameters or exceptions during processing

doExec

default KuraMessage doExec(RequestHandlerContext context,
                           KuraMessage reqMessage)
                    throws KuraException

Used to perform application operation not necessary tied to a given resource

Parameters:

context - a request context that can be used, for example, to publish notification messages to the remote cloud platform

reqMessage - represents as a KuraMessage the received message

Returns:

the response to be provided back as KuraMessage

Throws:

KuraException - An exception is thrown in every condition where the request cannot be full fitted due to wrong request parameters or exceptions during processing