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

Class ClientOperations

java.lang.Object

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

public class ClientOperations
extends Object

This class is a container for CoAP client operations.

Constructor Summary

Constructors

Constructor and Description
ClientOperations()

Method Summary

Modifier and Type	Method and Description
Set<DiscoveredResource>	discover(Client client, DiscoverParams discoverParams) The Discover processor retrieves information about CoAP resources of a server.
void	observerAdd(Client client, ResponseHandlerParams responseHandlerParams, ObserverAddParams observerAddParams) The ObserverAdd processor creates an observer.
boolean	observerExists(Client client, ObserverExistsParams observerExistsParams) Establish whether an observer with given parameters exists.
Set<String>	observerList(Client client) This processor returns a list of observers.
void	observerRemove(Client client, ObserverRemoveParams observerRemoveParams) The ObserverRemove processor removes an observer.
boolean	ping(Client client, PingParams pingParams) The Ping processor checks whether a CoAP server is reachable.
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,CoapResponseAttributes>	request(Client client, RequestParams requestParams, RequestOptionsParams requestOptions) The Request Processor issues a request on a CoAP server.
void	requestAsync(Client client, ResponseHandlerParams responseHandlerParams, RequestParams requestParams, RequestOptionsParams requestOptions) The RequestAsync Processor issues a request on a CoAP server asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientOperations

public ClientOperations()

Method Detail

request

@MediaType(value="*/*",
           strict=false)
 @Throws(value=RequestErrorProvider.class)
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,CoapResponseAttributes> request(@Config
                                                                                                                                                                                                       Client client,
                                                                                                                                                                                                       @ParameterGroup(name="Request")
                                                                                                                                                                                                       RequestParams requestParams,
                                                                                                                                                                                                       @ParameterGroup(name="Request options") @Summary(value="The CoAP options to send with the request.") @Placement(tab="Options",order=1)
                                                                                                                                                                                                       RequestOptionsParams requestOptions)

The Request Processor issues a request on a CoAP server. The processor blocks until a response is received or a timeout occurs.

Parameters:

client - The client used for issuing the request.

requestParams - Builder that delivers the request parameters.

requestOptions - The CoAP options to send with the request.

Returns:

The result of the request which contains the received server response, if any.

requestAsync

@Throws(value=RequestAsyncErrorProvider.class)
public void requestAsync(@Config
                                                                        Client client,
                                                                        @ParameterGroup(name="Response handling")
                                                                        ResponseHandlerParams responseHandlerParams,
                                                                        @ParameterGroup(name="Request")
                                                                        RequestParams requestParams,
                                                                        @ParameterGroup(name="Request options") @Summary(value="The CoAP options to send with the request.") @Placement(tab="Options",order=1)
                                                                        RequestOptionsParams requestOptions)

The RequestAsync Processor issues a request on a CoAP server asynchronously. The processor doea not wait for the response and will not block. The handling of a response (if any) is delegated to the response handler.

Parameters:

client - The client used for issuing the request.

responseHandlerParams - Builder that delivers the response handler parameters.

requestParams - Builder that delivers the request parameters.

requestOptions - The CoAP options to send with the request.

ping

@Throws(value=PingErrorProvider.class)
public boolean ping(@Config
                                                           Client client,
                                                           @ParameterGroup(name="Ping address")
                                                           PingParams pingParams)

The Ping processor checks whether a CoAP server is reachable.

Parameters:

client - The client to use to issue the request.

pingParams - The request attributes to use.

Returns:

True when the server has responded, False otherwise.

discover

@Throws(value=DiscoverErrorProvider.class)
public Set<DiscoveredResource> discover(@Config
                                                                                   Client client,
                                                                                   @ParameterGroup(name="Discover address")
                                                                                   DiscoverParams discoverParams)

The Discover processor retrieves information about CoAP resources of a server.

Parameters:

client - The client to use to issue the request.

discoverParams - The attributes of the discover request

Returns:

The description of resources on the server that have been discovered.

observerAdd

@Throws(value=ObserverAddErrorProvider.class)
public void observerAdd(@Config
                                                                      Client client,
                                                                      @ParameterGroup(name="Notification handling")
                                                                      ResponseHandlerParams responseHandlerParams,
                                                                      @ParameterGroup(name="Observe request")
                                                                      ObserverAddParams observerAddParams)

The ObserverAdd processor creates an observer. A request to observe the specified resource is sent to the server. The client defaults are used to issue the request.

Parameters:

client - The client instance that the observer belongs to.

responseHandlerParams - Name of the response handler that will process the notification received from server.

observerAddParams - Parameters of the observe request. These will override client defaults.

observerRemove

@Throws(value=ObserverRemoveErrorProvider.class)
public void observerRemove(@Config
                                                                            Client client,
                                                                            @ParameterGroup(name="Observe request")
                                                                            ObserverRemoveParams observerRemoveParams)

The ObserverRemove processor removes an observer. A request to terminate observe the specified resource is sent to the server. The client defaults are used to issue the request.

Parameters:

client - The client instance that the observer belongs to.

observerRemoveParams - Parameters of the observe request. These will override client defaults.

observerExists

@Throws(value=ObserverExistsErrorProvider.class)
public boolean observerExists(@Config
                                                                               Client client,
                                                                               @ParameterGroup(name="Observer uri")
                                                                               ObserverExistsParams observerExistsParams)

Establish whether an observer with given parameters exists.

Parameters:

client - The client instance of which the observers are searched.

observerExistsParams - The the list of observer uri parameters.

Returns:

True when the observer exists, otherwise False.

observerList

public Set<String> observerList(@Config
                                Client client)

This processor returns a list of observers. The list contains the uri's of the active observers of the CoAP client.

Parameters:

client - The client instance of which the observers are listed.

Returns:

the set of observed uri's