nl.teslanet.mule.connectors.coap.internal.server

Class ServerOperations

java.lang.Object

nl.teslanet.mule.connectors.coap.internal.server.ServerOperations

public class ServerOperations
extends Object

This class is a container for CoAP server operations.

Constructor Summary

Constructors

Constructor and Description
ServerOperations()

Method Summary

Modifier and Type	Method and Description
void	notify(Server server, String pathPattern) The Notify processor initiates notifications to observing clients.
void	resourceAdd(Server server, ResourceParams resourceParams) The Resource Add processor dynamically adds a new resource to the CoAP server.
boolean	resourceExists(Server server, String pathPattern) The Resource Exists processor checks whether the CoAP server has one or more resources matching given uri pattern.
Set<String>	resourceList(Server server, String pathPattern) Returns a list of uri's of the resources, that match given uri pattern.
void	resourceRemove(Server server, String pathPattern) The Resource Remove processor removes resources from the CoAP server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerOperations

public ServerOperations()

Method Detail

notify

@Throws(value=ServerOperationErrorProvider.class)
public void notify(@Config
                                                                     Server server,
                                                                     @Alias(value="pathPattern") @Summary(value="For resources that apply to the path-pattern notifications are issued.") @Example(value="/my_resources/*")
                                                                     String pathPattern)
                                                              throws InvalidResourceUriException

The Notify processor initiates notifications to observing clients. Use this when the resource content has changed. For every observing client and resource an internal get-request is issued on the listener concerned. The response that the listener flow will be used as notication as is sent to the observing client.

Parameters:

server - The server configuration name of which the resource(s) have changed content.

pathPattern - The path pattern specifies the resource(s) that have changed content. Wildcards can be used, like "/*" or "/some/deeper/resources/*".

Throws:

InvalidResourceUriException - Thrown when given uri pattern is invalid.

resourceAdd

@Throws(value=ServerOperationErrorProvider.class)
public void resourceAdd(@Config
                                                                          Server server,
                                                                          @ParameterGroup(name="Resource to add")
                                                                          ResourceParams resourceParams)
                                                                   throws InvalidResourceUriException

The Resource Add processor dynamically adds a new 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 must exist already. The resource is available to clients immediately, provided there is a listener configured which has an uri pattern that applies to it.

Parameters:

server - The configuration name of the CoAP server to add the resource to.

resourceParams - The builder that delivers the resource parameters.

Throws:

InvalidResourceUriException - When the uri has invalid value.

resourceRemove

@Throws(value=ServerOperationErrorProvider.class)
public void resourceRemove(@Config
                                                                             Server server,
                                                                             @Alias(value="pathPattern") @Summary(value="Resources that apply to the path-pattern are removed.") @Example(value="/resources/*")
                                                                             String pathPattern)
                                                                      throws InvalidResourceUriException

The Resource Remove processor removes resources from the CoAP server. All resources that apply to the uri pattern will be removed. Clients that observe a removed resource will be notified.

Parameters:

server - The name of the CoAP server instance to use.

pathPattern - The uri pattern of the resource(s) that will be deleted. Wildcards can be used, like "/*" or "/some/deeper/resources/*".

Throws:

InvalidResourceUriException - Thrown when given uri pattern is not valid.

resourceExists

@Throws(value=ServerOperationErrorProvider.class)
public boolean resourceExists(@Config
                                                                                Server server,
                                                                                @Alias(value="pathPattern") @Summary(value="If any resources that apply to the path-pattern exist true is retuned, otherwise false.") @Example(value="/resources/*")
                                                                                String pathPattern)
                                                                         throws InvalidResourceUriException

The Resource Exists processor checks whether the CoAP server has one or more resources matching given uri pattern.

Parameters:

server - The configuration name of the CoAP server instance to use.

pathPattern - The uri pattern of the resource(s) to be found. A wildcard can be used, e.g. "/tobefound/*".

Returns:

True when at least one resource is found to which the pattern applies, otherwise False.

Throws:

InvalidResourceUriException - When given resource uri is not valid

resourceList

@Throws(value=ServerOperationErrorProvider.class)
public Set<String> resourceList(@Config
                                                                                  Server server,
                                                                                  @Alias(value="pathPattern") @Summary(value="Get the set of paths of the resources that apply to the path-pattern.")
                                                                                  String pathPattern)
                                                                           throws InvalidResourceUriException

Returns a list of uri's of the resources, that match given uri pattern.

Parameters:

server - The server instance to list resources of.

pathPattern - The uri pattern of the resource(s) to be found. A wildcard can be used, e.g. "/tobefound/*".

Returns:

The list containing uri's of resources that apply to the parttern.

Throws:

InvalidResourceUriException - Thrown when given uri pattern is not valid.