nl.teslanet.mule.transport.coap.client

Class CoapClientConnector

java.lang.Object

nl.teslanet.mule.transport.coap.client.CoapClientConnector

@Connector(name="coap-client",
           friendlyName="CoAP Client",
           schemaVersion="1.0",
           minMuleVersion="3.8.0",
           schemaLocation="http://www.teslanet.nl/schema/mule/coap-client/1.0/mule-coap-client.xsd",
           keywords="coap")
public class CoapClientConnector
extends Object

Mule CoAP connector - CoapClient. The CoapClient Connector can be used in Mule applications to implement CoAP clients as defined in http://tools.ietf.org/html/rfc7252. A CoAP client issues requests on resources that reside on a CoAP server. On these resources GET, POST, PUT, DELETE and Observer requests can be issued from Mule applications using this Connector. The client CoAP endpoint has a number of configuration parameters that can be used to tune behavior of the connector. Apart from host and port, these parameters have sensible defaults and need only to be set for specific needs.

Constructor Summary

Constructors

Constructor and Description
CoapClientConnector()

Method Summary

Methods

Modifier and Type	Method and Description
org.mule.api.MuleEvent	asyncDelete(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters, String responseHandler) Async-Delete messageprocessor asynchronously deletes a CoAP resource on a Server.
org.mule.api.MuleEvent	asyncGet(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters, String responseHandler) Async-Get messageprocessor asynchronously retrieves the contents of a CoAP resource from a Server.
org.mule.api.MuleEvent	asyncPost(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters, String responseHandler) Async-Put messageprocessor asynchronously delivers contents to a CoAP resource on a Server.
org.mule.api.MuleEvent	asyncPut(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters, String responseHandler) Async-Put messageprocessor asynchronously changes the contents of a CoAP resource on a Server.
org.mule.api.MuleEvent	delete(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters) Delete messageprocessor deletes a CoAP resource on a Server.
Set<org.eclipse.californium.core.WebLink>	discover(Boolean confirmable, String host, Integer port, List<String> queryParameters) Discover message-processor retrieves information about CoAP resources from a server.
org.mule.api.MuleEvent	get(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters) Get messageprocessor retrieves the contents of a CoAP resource from a Server.
CoAPClientConfig	getConfig() Gets the Connector configuration.
org.mule.api.MuleContext	getMuleContext() Gets the Mule context.
String	getUri(String host, Integer port, String path, String query) Get a String object containing the uri of the given CoAP resource.
URI	getURI(String host, Integer port, String path, String query) Get an URI object describing the given CoAP resource.
void	handleResponse(org.mule.api.callback.SourceCallback callback, String handlerName) Handle-Response messagesource handles responses on asynchronous requests that reference this handler.
List<String>	listObservations() List-Observations messageprocessor retrieves the list of active dynamic observations on a CoAP resource.
void	observe(org.mule.api.callback.SourceCallback callback, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters) Observe messagesource observes a CoAP resource on a Server.
Boolean	ping(String host, Integer port) The Ping messageprocessor checks whether a CoAP resource is reachable.
org.mule.api.MuleEvent	post(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters) Post messageprocessor delivers contents to a CoAP resource on a Server.
org.mule.api.MuleEvent	put(org.mule.api.MuleEvent event, Boolean confirmable, String host, Integer port, String path, List<String> queryParameters) Put messageprocessor changes the contents of a CoAP resource on a Server.
void	setConfig(CoAPClientConfig config) Sets the Connector configuration.
void	setMuleContext(org.mule.api.MuleContext context) Sets the The Mule context.
void	startConnector() The startConnector method creates an CoAP endpoint using the configuration parameters.
void	startObserve(Boolean confirmable, String host, Integer port, String path, List<String> queryParameters, String responseHandler) Start-observe messageprocessor dynamically initiates observation of a CoAP resource on a Server.
void	stopConnector() The stopConnector method terminates the CoAP endpoint.
void	stopObserve(String host, Integer port, String path, List<String> queryParameters) Stop-observe messageprocessor ends a dynamically set observation of a CoAP resource on a Server.
void	test() Test connectivity

Methods inherited from class java.lang.Object

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

Constructor Detail

CoapClientConnector

public CoapClientConnector()

Method Detail

test

@TestConnectivity
public void test()
          throws MalformedUriException,
                 org.mule.api.ConnectionException

Test connectivity

Throws:

MalformedUriException - cannot form valid uri with given parameters

org.mule.api.ConnectionException - server could not be reached

startConnector

@Start
public void startConnector()
                    throws org.mule.api.ConnectionException

The startConnector method creates an CoAP endpoint using the configuration parameters.

Throws:

org.mule.api.ConnectionException - The CoAP endpoint could not be created.

stopConnector

@Stop
public void stopConnector()

The stopConnector method terminates the CoAP endpoint. Resources are freed. Observing clients will be notified using a proactive cancel.

ping

@Processor
public Boolean ping(@Optional
                     String host,
                     @Optional
                     Integer port)
             throws MalformedUriException

The Ping messageprocessor checks whether a CoAP resource is reachable.

Parameters:

host - The host to ping. Overrides the connector setting.

port - The port the host listens on. Overrides the connector setting.

Returns:

true when ping was successful, otherwise false.

Throws:

MalformedUriException - cannot form valid uri with given parameters

discover

@Processor
public Set<org.eclipse.californium.core.WebLink> discover(@Default(value="true")
                                                           Boolean confirmable,
                                                           @Optional
                                                           String host,
                                                           @Optional
                                                           Integer port,
                                                           @Optional
                                                           List<String> queryParameters)
                                                   throws MalformedUriException

Discover message-processor retrieves information about CoAP resources from a server. The host and port are optional parameters that override Connector configuration

Parameters:

confirmable - When true (default), requests are sent confirmable.

host - The host address of the server.

port - The port the server is listening on.

queryParameters - The optional query-parameters for discovery.

Returns:

A Set of Weblinks describing the resources on the server. When the retrieval of the set of Weblinks failed, null is returned.

Throws:

MalformedUriException - cannot form valid uri with given parameters

get

@Processor
public org.mule.api.MuleEvent get(org.mule.api.MuleEvent event,
                                   @Default(value="true")
                                   Boolean confirmable,
                                   @Optional
                                   String host,
                                   @Optional
                                   Integer port,
                                   String path,
                                   @Optional
                                   List<String> queryParameters)
                           throws MalformedUriException,
                                  HandlerException

Get messageprocessor retrieves the contents of a CoAP resource from a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Returns:

On success the contents of the CoAP resource is returned in a byte array( byte[] ) as message payload. Otherwise the payload will be empty.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

asyncGet

@Processor
public org.mule.api.MuleEvent asyncGet(org.mule.api.MuleEvent event,
                                        @Default(value="true")
                                        Boolean confirmable,
                                        @Optional
                                        String host,
                                        @Optional
                                        Integer port,
                                        String path,
                                        @Optional
                                        List<String> queryParameters,
                                        String responseHandler)
                                throws MalformedUriException,
                                       HandlerException

Async-Get messageprocessor asynchronously retrieves the contents of a CoAP resource from a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

responseHandler - Name of the handler that will process the returned response.

Returns:

The MuleMessage is returned unchanged.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

put

@Processor
public org.mule.api.MuleEvent put(org.mule.api.MuleEvent event,
                                   @Default(value="true")
                                   Boolean confirmable,
                                   @Optional
                                   String host,
                                   @Optional
                                   Integer port,
                                   String path,
                                   @Optional
                                   List<String> queryParameters)
                           throws MalformedUriException,
                                  HandlerException

Put messageprocessor changes the contents of a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Returns:

On success the response payload - if any - is returned in a byte array( byte[] ) as message payload. Otherwise the payload will be empty.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

asyncPut

@Processor
public org.mule.api.MuleEvent asyncPut(org.mule.api.MuleEvent event,
                                        @Default(value="true")
                                        Boolean confirmable,
                                        @Optional
                                        String host,
                                        @Optional
                                        Integer port,
                                        String path,
                                        @Optional
                                        List<String> queryParameters,
                                        String responseHandler)
                                throws MalformedUriException,
                                       HandlerException

Async-Put messageprocessor asynchronously changes the contents of a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

responseHandler - Name of the handler that will process the returned response.

Returns:

The MuleMessage is returned unchanged.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

post

@Processor
public org.mule.api.MuleEvent post(org.mule.api.MuleEvent event,
                                    @Default(value="true")
                                    Boolean confirmable,
                                    @Optional
                                    String host,
                                    @Optional
                                    Integer port,
                                    String path,
                                    @Optional
                                    List<String> queryParameters)
                            throws MalformedUriException,
                                   HandlerException

Post messageprocessor delivers contents to a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Returns:

On success the response payload - if any - is returned in a byte array( byte[] ) as message payload. Otherwise the payload will be empty.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

asyncPost

@Processor
public org.mule.api.MuleEvent asyncPost(org.mule.api.MuleEvent event,
                                         @Default(value="true")
                                         Boolean confirmable,
                                         @Optional
                                         String host,
                                         @Optional
                                         Integer port,
                                         String path,
                                         @Optional
                                         List<String> queryParameters,
                                         String responseHandler)
                                 throws MalformedUriException,
                                        HandlerException

Async-Put messageprocessor asynchronously delivers contents to a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

responseHandler - Name of the handler that will process the returned response.

Returns:

The MuleMessage is returned unchanged.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

delete

@Processor
public org.mule.api.MuleEvent delete(org.mule.api.MuleEvent event,
                                      @Default(value="true")
                                      Boolean confirmable,
                                      @Optional
                                      String host,
                                      @Optional
                                      Integer port,
                                      String path,
                                      @Optional
                                      List<String> queryParameters)
                              throws MalformedUriException,
                                     HandlerException

Delete messageprocessor deletes a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Returns:

On success the response payload - if any - is returned in a byte array( byte[] ) as message payload. Otherwise the payload will be empty.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

asyncDelete

@Processor
public org.mule.api.MuleEvent asyncDelete(org.mule.api.MuleEvent event,
                                           @Default(value="true")
                                           Boolean confirmable,
                                           @Optional
                                           String host,
                                           @Optional
                                           Integer port,
                                           String path,
                                           @Optional
                                           List<String> queryParameters,
                                           String responseHandler)
                                   throws MalformedUriException,
                                          HandlerException

Async-Delete messageprocessor asynchronously deletes a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true the server must confirm the request.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

responseHandler - Name of the handler that will process the returned response.

Returns:

The MuleMessage is returned unchanged.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

startObserve

@Processor
public void startObserve(@Default(value="true")
                          Boolean confirmable,
                          @Optional
                          String host,
                          @Optional
                          Integer port,
                          String path,
                          @Optional
                          List<String> queryParameters,
                          String responseHandler)
                  throws MalformedUriException,
                         HandlerException

Start-observe messageprocessor dynamically initiates observation of a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true (default), requests are sent confirmable.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

responseHandler - Name of the handler that will process the resource updates received from server.

Throws:

MalformedUriException - cannot form valid uri with given parameters

HandlerException - response handler with given name not found

stopObserve

@Processor
public void stopObserve(@Optional
                         String host,
                         @Optional
                         Integer port,
                         String path,
                         @Optional
                         List<String> queryParameters)
                 throws MalformedUriException

Stop-observe messageprocessor ends a dynamically set observation of a CoAP resource on a Server. The resource url can be set, overriding connector configuration.

Parameters:

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Throws:

MalformedUriException - cannot form valid uri with given parameters

listObservations

@Processor
public List<String> listObservations()

List-Observations messageprocessor retrieves the list of active dynamic observations on a CoAP resource. The list contains the CoAP resource url that is being observed dynamically.

Parameters:

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Returns:

The List of urls of active dynamic observations.

Throws:

Exception - Is thrown when an unexpected error occurs

observe

@Source
public void observe(org.mule.api.callback.SourceCallback callback,
                  @Default(value="true")
                  Boolean confirmable,
                  @Optional
                  String host,
                  @Optional
                  Integer port,
                  String path,
                  @Optional
                  List<String> queryParameters)
             throws MalformedUriException

Observe messagesource observes a CoAP resource on a Server. The observation is static - meaning the observation will be active as long as the Mule-flow is running. The resource url can be set, overriding connector configuration.

Parameters:

confirmable - When true (default), requests are sent confirmable.

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

queryParameters - List of query parameters.

Throws:

MalformedUriException - no valid uri could be formed with given parameters

Exception - Is thrown when an unexpected error occurs

handleResponse

@Source
public void handleResponse(org.mule.api.callback.SourceCallback callback,
                         String handlerName)
                    throws HandlerException

Handle-Response messagesource handles responses on asynchronous requests that reference this handler. The Handler can process the responses of multiple requests and it the type of requests can differ. So one Handler could be used to process responses to asynchronous Get, Put, Post, Delete or Observe requests.

Parameters:

handlerName - The name of the hander. Used by asynchronous requests to reference the handler.

Throws:

HandlerException

Exception - Is thrown when an unexpected

getURI

public URI getURI(String host,
         Integer port,
         String path,
         String query)
           throws MalformedUriException

Get an URI object describing the given CoAP resource.

Parameters:

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

query - String containing query parameters.

Returns:

The URI object.

Throws:

MalformedUriException - cannot form valid uri with given parameters

getUri

public String getUri(String host,
            Integer port,
            String path,
            String query)
              throws MalformedUriException

Get a String object containing the uri of the given CoAP resource.

Parameters:

host - The host address of the server.

port - The port the server is listening on.

path - The path of the resource.

query - String containing query parameters.

Returns:

The String containing the uri.

Throws:

MalformedUriException - cannot form valid uri with given parameters

getMuleContext

public org.mule.api.MuleContext getMuleContext()

Gets the Mule context.

Returns:

The Mule context.

setMuleContext

public void setMuleContext(org.mule.api.MuleContext context)

Sets the The Mule context. The context will be set by Mule on application start.

Parameters:

context - The Mule context.

getConfig

public CoAPClientConfig getConfig()

Gets the Connector configuration.

Returns:

The Connector configuration.

setConfig

public void setConfig(CoAPClientConfig config)

Sets the Connector configuration. The configuration object will be set by Mule on application start.

Parameters:

config - The Connector configuration.