nl.teslanet.mule.connectors.coap.internal.client

Interface CoapRequestBuilder

public interface CoapRequestBuilder

Builder for constructing requests on services that can be virtual or reside behind a proxy. In latter cases the eindpoint address will differ from the service address.

Method Summary

Modifier and Type	Method and Description
org.eclipse.californium.core.coap.Request	build() Build the CoAP request based on given parameters.
org.eclipse.californium.core.coap.Request	buildEmpty() Build an empty CoAP request based on given parameters.
URI	buildEndpointUri() Build the URI of the endpoint to address the request.
CoapMessageType	buildMessageType() Build the message type of the request.
org.eclipse.californium.core.coap.OptionSet	buildOptionSet() Build the options of the request.
CoapRequestCode	buildRequestCode() Build the code of the request.
URI	buildResourceUri() Build the URI of the resource to request.

Method Detail

buildResourceUri

URI buildResourceUri()
              throws InternalUriException

Build the URI of the resource to request.

Returns:

The resource URI.

Throws:

InternalUriException - When URI components cannot be assembled to a valid URI.

buildEndpointUri

URI buildEndpointUri()
              throws InternalUriException

Build the URI of the endpoint to address the request.

Returns:

The endpoint URI.

Throws:

InternalUriException - When URI components cannot be assembled to a valid URI.

build

org.eclipse.californium.core.coap.Request build()
                                         throws InternalInvalidRequestCodeException,
                                                InternalUriException,
                                                InternalRequestException,
                                                InternalInvalidOptionValueException,
                                                InternalUnkownOptionException

Build the CoAP request based on given parameters.

Returns:

The CoAP request.

Throws:

InternalInvalidRequestCodeException - When given requestCode is invalid.

InternalUriException - When parameters do not assemble to valid URI.

InternalRequestException - When given payload could not be added the request.

InternalUnkownOptionException - When an unknown other option alias is given.

InternalInvalidOptionValueException - When an invalid option value is given.

buildEmpty

org.eclipse.californium.core.coap.Request buildEmpty()
                                              throws InternalUriException

Build an empty CoAP request based on given parameters.

Returns:

The CoAP request.

Throws:

InternalUriException - When parameters do not assemble to valid URI.

buildMessageType

CoapMessageType buildMessageType()

Build the message type of the request.

Returns:

The message type of the request to build.

buildRequestCode

CoapRequestCode buildRequestCode()

Build the code of the request.

Returns:

The requestCode of the request to build.

buildOptionSet

org.eclipse.californium.core.coap.OptionSet buildOptionSet()

Build the options of the request.

Returns:

The options of the request to build.