CoAP Server Connector API Reference

<coap-server:config>

Configuration The CoAP server configuration contains attributes defining the CoAP endpoint and child elements that define CoAP resources that will be served. Add resources by adding "<coap-server:resource>" child-elements to the "<coap-server:config>" element. The resources can - in turn - contain other resources. This hierarchy of resources defines the CoAP ReST interface. Every resource element defines its name and the operations that are available on it. The operations on resources possible are Get, Post, Put, Delete and Observe. When the EarlyAck flag is set an acknowledgement is immediately sent back to the client, before processing the request and returning the response. Use this when processing takes longer than the acknowledgment-timeout of the client. Clients can refer to resources by their path in the hierarchy e.g. "/root/child", where the resource named "root" contains the resource named "child". The size and type attributes can be added to resources which will be reported to clients when they issue a Discovery request.
Example:
<coap-server:config name="CoAP_Server_Configuration"
   secure="true"
   keyStoreLocation="keyStore.jks"
   keyStorePassword="endPass"
   privateKeyAlias="server"
   trustStoreLocation="trustStore.jks"
   trustStorePassword="rootPass"
   trustedRootCertificateAlias="root"
   >
   <coap-server:resources>
      <coap-server:resource name="large" get="true" earlyAck="true" size="2345345" type="application/json"/>
      <coap-server:resource name="slow" get="true" earlyAck="true"/>
      <coap-server:resource name="alphabet" get="true" post="true" observe="true">
         <coap-server:resources>
         <coap-server:resource name="a" get="true" post="true" put="true" delete="true" observe="true" earlyAck="true" >
         <coap-server:resource name="b" get="true"/>
         <coap-server:resource name="c" get="true"/>
         </coap-server:resources>
      </coap-server:resource>
      <coap-server:resource name="hello" get="true" observe="true">
         <coap-server:resources>
         <coap-server:resource name="there" get="true"/>
         <coap-server:resource name="changeme" get="true" put="true" observe="true"/>
         <coap-server:resource name="deleteme" get="true" delete="true"/>
         <coap-server:resource name="collect" post="true" type="text/plain"/>
         </coap-server:resources>
      </coap-server:resource>
   </coap-server:resources>
</coap-server:config>


<coap-server:resource-changed>

The Resource Changed messageprocessor is used to trigger a notification to clients that observe the specified resource. The uri needs to be an existing resource defined in the coap-server configuration or a dynamically created resource. Wildcards can also be used, like "/*" or "/some/deeper/resources/*". The observing clients are notified by issuing an internal get-request for every client that gets processed by the listener on the resource concerned.
Example:
<coap-server:resource-changed config-ref="CoAP_Server_Configuration" uri="/hello/changeme"/>


<coap-server:add-resource>

The Add Resource messageprocessor is used to dynamically add a resource to the CoAP server. The uri needs to be a complete resource-path, including all parent resource(s). All parent resources in the path need to exist already. Requests on the resource can be done immediately, provided there is a listener configured for it, e.g. by means of a listener that has a wildcard uri (for the example below a listener with uri="/alphabet/*" would do).
Example:
<coap-server:add-resource config-ref="CoAP_Server_Configuration" uri="/alphabet/z" get="true" delete="true"/>

<coap-server:remove-resource>

The Remove Resource messageprocessor removes one or more resources from the server. A wildcard can be used, e.g. "/tobefound/*". All resources that apply to the uri will be removed. Clients that observe a resource that is removed will be notified.
Example:
<coap-server:remove-resource config-ref="CoAP_Server_Configuration" uri="/alphabet/z" />

<coap-server:resource-exists>

The <coap-server:resource-exists/> messageprocessor returns 'true' when a resource on the given uri is active, otherwise false. A wildcard can be used, e.g. "/tobefound/*". When at least one resource is found that applies to the uri, the Boolean 'true' is returned.

<coap-server:listen>

The Listen messageprocessor receives all incoming requests on the specified uri. The uri needs to be an existing resource defined in de coap-server configuration. Wildcards can also be used, like "/*" or "/some/deeper/resources/*". When multiple listeners apply for a resource, the listener with the most specific uri will get the requests on it. CoAP options of the request are added to the inbound-scope of the MuleMessage.
Example:
<flow name="coap-serverFlow1">
   <coap-server:listen uri="/alphabet/*" config-ref="CoAP_Server_Configuration"/>
   <set-variable variableName="method" value="#[ message.inboundProperties['coap.request.code']]"/>
   <set-variable variableName="uri" value="#[message.inboundProperties['coap.request.uri'] ]"/>
   <byte-array-to-string-transformer/>
   <logger level="INFO" message="#[payload]"/>
   <set-payload value="&lt;my_response&gt;Hi!&lt;/my_response&gt;" encoding="UTF-8" mimeType="application/xml"/>
   <set-property propertyName="coap.response.code" value="CONTENT" />
</flow>