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

Class AbstractResource

java.lang.Object

org.eclipse.californium.core.CoapResource

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

All Implemented Interfaces:

org.eclipse.californium.core.server.resources.ObservableResource, org.eclipse.californium.core.server.resources.Resource

Direct Known Subclasses:

ServedResource, VirtualResource

public class AbstractResource
extends org.eclipse.californium.core.CoapResource

The AbstractResource class represents a CoAP resource that is active on the server. A ServedResource object handles all requests from clients on the CoAP resource.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CSV_REGEX Regular expression for splitting comma separated values.
protected boolean	earlyAck Flag that indicates whether the resource should acknowledge before processing the request.
protected static org.slf4j.Marker	ERROR_RESPONSE_MARKER Marker for logging error responses.
protected static String	NO_LISTENER_LOG_FORMAT No listener message log format.

Constructor Summary

Constructors

Constructor and Description
AbstractResource(String name, boolean visible) Resource constructor.

Method Summary

Modifier and Type	Method and Description
protected CoapRequestAttributesImpl	createRequestAttributes(org.eclipse.californium.core.server.resources.CoapExchange coapExchange) Create request attributes.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getDeleteCallback() Get the Mule MessageSource callback for Delete requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getFetchCallback() Get the Mule MessageSource callback for Fetch requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getGetCallback() Get the Mule MessageSource callback for Get requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getIpatchCallback() Get the Mule MessageSource callback for Ipatch requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getPatchCallback() Get the Mule MessageSource callback for Patch requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getPostCallback() Get the Mule MessageSource callback for Post requests.
org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes>	getPutCallback() Get the Mule MessageSource callback for Put requests.
protected void	handleRequest(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> callback, org.eclipse.californium.core.server.resources.CoapExchange exchange, CoapResponseCode defaultCoapResponseCode) Generic handler for processing requests.
void	setDeleteCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Delete requests.
void	setFetchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Fetch requests.
void	setGetCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Get requests.
void	setIpatchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Ipatch requests.
void	setPatchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Patch requests.
void	setPostCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Post requests.
void	setPutCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback) set the Mule callback for this resource for Put requests.

Methods inherited from class org.eclipse.californium.core.CoapResource

add, add, add, addObserver, addObserveRelation, changed, changed, checkObserveRelation, clearAndNotifyObserveRelations, clearAndNotifyObserveRelations, clearObserveRelations, delete, delete, execute, executeAndWait, getAttributes, getChild, getChildren, getExecutor, getName, getNotificationSequenceNumber, getObserverCount, getObserveType, getParent, getPath, getURI, handleDELETE, handleFETCH, handleGET, handleIPATCH, handlePATCH, handlePOST, handlePUT, handleRequest, isCachable, isObservable, isVisible, notifyObserverRelations, removeObserver, removeObserveRelation, setAttributes, setName, setObservable, setObserveType, setParent, setPath, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_RESPONSE_MARKER

protected static final org.slf4j.Marker ERROR_RESPONSE_MARKER

Marker for logging error responses.

NO_LISTENER_LOG_FORMAT

protected static final String NO_LISTENER_LOG_FORMAT

No listener message log format.

See Also:

Constant Field Values

CSV_REGEX

protected static final String CSV_REGEX

Regular expression for splitting comma separated values.

See Also:

Constant Field Values

earlyAck

protected boolean earlyAck

Flag that indicates whether the resource should acknowledge before processing the request.

Constructor Detail

AbstractResource

public AbstractResource(String name,
                        boolean visible)

Resource constructor.

Parameters:

name - The name of the resource.

visible - Resource visibility to customers.

Method Detail

handleRequest

protected void handleRequest(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> callback,
                             org.eclipse.californium.core.server.resources.CoapExchange exchange,
                             CoapResponseCode defaultCoapResponseCode)

Generic handler for processing requests.

Parameters:

callback - The callback of the Mule flow that will process the request.

exchange - The CoAP exchange context of the request.

defaultCoapResponseCode - The response code that will be used when the Mule flow hasn't set one.

createRequestAttributes

protected CoapRequestAttributesImpl createRequestAttributes(org.eclipse.californium.core.server.resources.CoapExchange coapExchange)
                                                     throws InternalInvalidOptionValueException,
                                                            InternalInvalidMessageTypeException,
                                                            InternalInvalidRequestCodeException

Create request attributes.

Parameters:

coapExchange -

Returns:

The attributes to add to the mule message.

Throws:

InternalInvalidOptionValueException - When request options could not be interpreted.

InternalInvalidMessageTypeException - When request type could not be interpreted.

InternalInvalidRequestCodeException - When request code could not be interpreted.

setGetCallback

public void setGetCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Get requests.

getGetCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getGetCallback()

Get the Mule MessageSource callback for Get requests.

Returns:

the callback

setPostCallback

public void setPostCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Post requests.

getPostCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getPostCallback()

Get the Mule MessageSource callback for Post requests.

Returns:

the callback

setPutCallback

public void setPutCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Put requests.

getPutCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getPutCallback()

Get the Mule MessageSource callback for Put requests.

Returns:

the callback

setDeleteCallback

public void setDeleteCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Delete requests.

getDeleteCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getDeleteCallback()

Get the Mule MessageSource callback for Delete requests.

Returns:

the callback

setFetchCallback

public void setFetchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Fetch requests.

getFetchCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getFetchCallback()

Get the Mule MessageSource callback for Fetch requests.

Returns:

the callback

setPatchCallback

public void setPatchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Patch requests.

getPatchCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getPatchCallback()

Get the Mule MessageSource callback for Patch requests.

Returns:

the callback

setIpatchCallback

public void setIpatchCallback(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> sourceCallback)

set the Mule callback for this resource for Ipatch requests.

getIpatchCallback

public org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,CoapRequestAttributes> getIpatchCallback()

Get the Mule MessageSource callback for Ipatch requests.

Returns:

the callback