org.eclipse.californium.core

Class CoapClient

java.lang.Object

org.eclipse.californium.core.CoapClient

public class CoapClient
extends java.lang.Object

The Class CoapClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoapClient.Builder The Builder can be used to build a CoapClient if the URI's pieces are available in separate strings.

Constructor Summary

Constructors

Constructor and Description
CoapClient() Constructs a new CoapClient that has no destination URI yet.
CoapClient(java.lang.String uri) Constructs a new CoapClient that sends requests to the specified URI.
CoapClient(java.lang.String scheme, java.lang.String host, int port, java.lang.String... path) Constructs a new CoapClient with the specified scheme, host, port and path as URI.
CoapClient(java.net.URI uri) Constructs a new CoapClient that sends request to the specified URI.

Method Summary

Modifier and Type	Method and Description
void	advanced(CoapHandler handler, Request request) Sends an advanced asynchronous request that has to be configured by the developer.
CoapResponse	advanced(Request request) Sends an advanced synchronous request that has to be configured by the developer.
CoapResponse	delete() Sends a DELETE request and waits for the response.
void	delete(CoapHandler handler) Sends a DELETE request and invokes the specified handler when a response arrives.
java.util.Set<WebLink>	discover()
java.util.Set<WebLink>	discover(java.lang.String query)
CoapResponse	get() Sends a GET request and blocks until the response is available.
void	get(CoapHandler handler) Sends a GET request and invokes the specified handler when a response arrives.
void	get(CoapHandler handler, int accept) Sends aGET request with the specified Accept option and invokes the handler when a response arrives.
CoapResponse	get(int accept) Sends a GET request with the specified Accept option and blocks until the response is available.
Endpoint	getEndpoint() Gets the endpoint this client uses.
long	getTimeout() Gets the timeout.
java.lang.String	getURI() Gets the destination URI of this client.
CoapObserveRelation	observe(CoapHandler handler) Sends an observe request and invokes the specified handler each time a notification arrives.
CoapObserveRelation	observe(CoapHandler handler, int accept) Sends an observe request with the specified Accept option and invokes the specified handler each time a notification arrives.
CoapObserveRelation	observeAndWait(CoapHandler handler) Sends an observe request and waits until it has been established whereupon the specified handler is invoked when a notification arrives.
CoapObserveRelation	observeAndWait(CoapHandler handler, int accept) Sends an observe request with the specified Accept option and waits until it has been established whereupon the specified handler is invoked when a notification arrives.
boolean	ping() Performs a CoAP ping using the default timeout for requests.
boolean	ping(long timeout) Performs a CoAP ping and gives up after the given number of milliseconds.
CoapResponse	post(byte[] payload, int format) Sends a POST request with the specified payload and the specified content format option and blocks until the response is available.
CoapResponse	post(byte[] payload, int format, int accept) Sends a POST request with the specified payload, the specified content format and the specified Accept option and blocks until the response is available.
void	post(CoapHandler handler, byte[] payload, int format) Sends a POST request with the specified payload and the specified content format and invokes the specified handler when a response arrives.
void	post(CoapHandler handler, byte[] payload, int format, int accept) Sends a POST request with the specified payload, the specified content format and accept and invokes the specified handler when a response arrives.
void	post(CoapHandler handler, java.lang.String payload, int format) Sends a POST request with the specified payload and the specified content format and invokes the specified handler when a response arrives.
void	post(CoapHandler handler, java.lang.String payload, int format, int accept) Sends a POST request with the specified payload, the specified content format and accept and invokes the specified handler when a response arrives.
CoapResponse	post(java.lang.String payload, int format) Sends a POST request with the specified payload and the specified content format option and blocks until the response is available.
CoapResponse	post(java.lang.String payload, int format, int accept) Sends a POST request with the specified payload, the specified content format and the specified Accept option and blocks until the response is available.
CoapResponse	put(byte[] payload, int format) Sends a PUT request with payload and required Content-Format and blocks until the response is available.
void	put(CoapHandler handler, byte[] payload, int format) Sends a PUT request with the specified payload and the specified content format and invokes the specified handler when a response arrives.
void	put(CoapHandler handler, java.lang.String payload, int format) Sends a PUT request with the specified payload and the specified content format and invokes the specified handler when a response arrives.
CoapResponse	put(java.lang.String payload, int format) Sends a PUT request with payload and required Content-Format and blocks until the response is available.
CoapResponse	putIfMatch(byte[] payload, int format, byte[]... etags) Sends a PUT request with with the specified ETags in the If-Match option and blocks until the response is available.
void	putIfMatch(CoapHandler handler, byte[] payload, int format, byte[]... etags)
void	putIfMatch(CoapHandler handler, java.lang.String payload, int format, byte[]... etags)
CoapResponse	putIfMatch(java.lang.String payload, int format, byte[]... etags) Sends a PUT request with with the specified ETags in the If-Match option and blocks until the response is available.
CoapResponse	putIfNoneMatch(byte[] payload, int format) Sends a PUT request with the If-None-Match option set and blocks until the response is available.
void	putIfNoneMatch(CoapHandler handler, byte[] payload, int format)
CoapResponse	putIfNoneMatch(java.lang.String payload, int format) Sends a PUT request with the If-None-Match option set and blocks until the response is available.
CoapClient	setEndpoint(Endpoint endpoint) Sets the endpoint this client is supposed to use.
CoapClient	setExecutor(java.util.concurrent.ExecutorService executor) Sets the executor service for this client.
CoapClient	setTimeout(long timeout) Sets the timeout how long synchronous method calls will wait until they give up and return anyways.
CoapClient	setURI(java.lang.String uri) Sets the destination URI of this client.
void	shutdown() Stops the client-specific executor service to cleanly exit programs.
CoapClient	useCONs() Let the client use Confirmable requests.
CoapClient	useEarlyNegotiation(int size) Let the client use early negotiation for the blocksize (16, 32, 64, 128, 256, 512, or 1024).
CoapClient	useExecutor() Sets a single-threaded executor to this client.
CoapClient	useLateNegotiation() Let the client use late negotiation for the block size (default).
CoapClient	useNONs() Let the client use Non-Confirmable requests.
CoapResponse	validate(byte[]... etags)
void	validate(CoapHandler handler, byte[]... etags)

Methods inherited from class java.lang.Object

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

Constructor Detail

CoapClient

public CoapClient()

Constructs a new CoapClient that has no destination URI yet.

CoapClient

public CoapClient(java.lang.String uri)

Constructs a new CoapClient that sends requests to the specified URI.

Parameters:

uri - the uri

CoapClient

public CoapClient(java.net.URI uri)

Constructs a new CoapClient that sends request to the specified URI.

Parameters:

uri - the uri

CoapClient

public CoapClient(java.lang.String scheme,
                  java.lang.String host,
                  int port,
                  java.lang.String... path)

Constructs a new CoapClient with the specified scheme, host, port and path as URI.

Parameters:

scheme - the scheme

host - the host

port - the port

path - the path

Method Detail

getTimeout

public long getTimeout()

Gets the timeout.

Returns:

the timeout

setTimeout

public CoapClient setTimeout(long timeout)

Sets the timeout how long synchronous method calls will wait until they give up and return anyways. The value 0 is equal to infinity.

Parameters:

timeout - the timeout

Returns:

the CoAP client

getURI

public java.lang.String getURI()

Gets the destination URI of this client.

Returns:

the uri

setURI

public CoapClient setURI(java.lang.String uri)

Sets the destination URI of this client.

Parameters:

uri - the uri

Returns:

the CoAP client

useExecutor

public CoapClient useExecutor()

Sets a single-threaded executor to this client. All handlers will be invoked by this executor. Note that the client executor uses a user thread (not a daemon thread) that needs to be stopped to exit the program.

Returns:

the CoAP client

setExecutor

public CoapClient setExecutor(java.util.concurrent.ExecutorService executor)

Sets the executor service for this client. All handlers will be invoked by this executor.

Parameters:

executor - the executor service

Returns:

the CoAP client

getEndpoint

public Endpoint getEndpoint()

Gets the endpoint this client uses.

Returns:

the endpoint

setEndpoint

public CoapClient setEndpoint(Endpoint endpoint)

Sets the endpoint this client is supposed to use.

Parameters:

endpoint - the endpoint

Returns:

the CoAP client

useCONs

public CoapClient useCONs()

Let the client use Confirmable requests.

Returns:

the CoAP client

useNONs

public CoapClient useNONs()

Let the client use Non-Confirmable requests.

Returns:

the CoAP client

useEarlyNegotiation

public CoapClient useEarlyNegotiation(int size)

Let the client use early negotiation for the blocksize (16, 32, 64, 128, 256, 512, or 1024). Other values will be matched to the closest logarithm dualis.

Parameters:

size - the preferred block size

Returns:

the CoAP client

useLateNegotiation

public CoapClient useLateNegotiation()

Let the client use late negotiation for the block size (default).

Returns:

the CoAP client

ping

public boolean ping()

Performs a CoAP ping using the default timeout for requests.

Returns:

success of the ping

ping

public boolean ping(long timeout)

Performs a CoAP ping and gives up after the given number of milliseconds.

Parameters:

timeout - the time to wait for a pong in ms

Returns:

success of the ping

discover

public java.util.Set<WebLink> discover()

discover

public java.util.Set<WebLink> discover(java.lang.String query)

get

public CoapResponse get()

Sends a GET request and blocks until the response is available.

Returns:

the CoAP response

get

public CoapResponse get(int accept)

Sends a GET request with the specified Accept option and blocks until the response is available.

Parameters:

accept - the Accept option

Returns:

the CoAP response

get

public void get(CoapHandler handler)

Sends a GET request and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

get

public void get(CoapHandler handler,
                int accept)

Sends aGET request with the specified Accept option and invokes the handler when a response arrives.

Parameters:

handler - the Response handler

accept - the Accept option

post

public CoapResponse post(java.lang.String payload,
                         int format)

Sends a POST request with the specified payload and the specified content format option and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

Returns:

the CoAP response

post

public CoapResponse post(byte[] payload,
                         int format)

Sends a POST request with the specified payload and the specified content format option and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

Returns:

the CoAP response

post

public CoapResponse post(java.lang.String payload,
                         int format,
                         int accept)

Sends a POST request with the specified payload, the specified content format and the specified Accept option and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

accept - the Accept option

Returns:

the CoAP response

post

public CoapResponse post(byte[] payload,
                         int format,
                         int accept)

Sends a POST request with the specified payload, the specified content format and the specified Accept option and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

accept - the Accept option

Returns:

the CoAP response

post

public void post(CoapHandler handler,
                 java.lang.String payload,
                 int format)

Sends a POST request with the specified payload and the specified content format and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

post

public void post(CoapHandler handler,
                 byte[] payload,
                 int format)

Sends a POST request with the specified payload and the specified content format and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

post

public void post(CoapHandler handler,
                 java.lang.String payload,
                 int format,
                 int accept)

Sends a POST request with the specified payload, the specified content format and accept and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

accept - the Accept option

post

public void post(CoapHandler handler,
                 byte[] payload,
                 int format,
                 int accept)

Sends a POST request with the specified payload, the specified content format and accept and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

accept - the Accept option

put

public CoapResponse put(java.lang.String payload,
                        int format)

Sends a PUT request with payload and required Content-Format and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

Returns:

the CoAP response

put

public CoapResponse put(byte[] payload,
                        int format)

Sends a PUT request with payload and required Content-Format and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

Returns:

the CoAP response

putIfMatch

public CoapResponse putIfMatch(java.lang.String payload,
                               int format,
                               byte[]... etags)

Sends a PUT request with with the specified ETags in the If-Match option and blocks until the response is available.

Parameters:

payload - the payload string

format - the Content-Format

etags - the ETags for the If-Match option

Returns:

the CoAP response

putIfMatch

public CoapResponse putIfMatch(byte[] payload,
                               int format,
                               byte[]... etags)

Sends a PUT request with with the specified ETags in the If-Match option and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

etags - the ETags for the If-Match option

Returns:

the CoAP response

putIfNoneMatch

public CoapResponse putIfNoneMatch(java.lang.String payload,
                                   int format)

Sends a PUT request with the If-None-Match option set and blocks until the response is available.

Parameters:

payload - the payload string

format - the Content-Format

Returns:

the CoAP response

putIfNoneMatch

public CoapResponse putIfNoneMatch(byte[] payload,
                                   int format)

Sends a PUT request with the If-None-Match option set and blocks until the response is available.

Parameters:

payload - the payload

format - the Content-Format

Returns:

the CoAP response

put

public void put(CoapHandler handler,
                java.lang.String payload,
                int format)

Sends a PUT request with the specified payload and the specified content format and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

put

public void put(CoapHandler handler,
                byte[] payload,
                int format)

Sends a PUT request with the specified payload and the specified content format and invokes the specified handler when a response arrives.

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

putIfMatch

public void putIfMatch(CoapHandler handler,
                       java.lang.String payload,
                       int format,
                       byte[]... etags)

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

etags - the ETags for the If-Match option

putIfMatch

public void putIfMatch(CoapHandler handler,
                       byte[] payload,
                       int format,
                       byte[]... etags)

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

etags - the ETags for the If-Match option

putIfNoneMatch

public void putIfNoneMatch(CoapHandler handler,
                           byte[] payload,
                           int format)

Parameters:

handler - the Response handler

payload - the payload

format - the Content-Format

delete

public CoapResponse delete()

Sends a DELETE request and waits for the response.

Returns:

the CoAP response

delete

public void delete(CoapHandler handler)

Sends a DELETE request and invokes the specified handler when a response arrives.

Parameters:

handler - the response handler

validate

public CoapResponse validate(byte[]... etags)

validate

public void validate(CoapHandler handler,
                     byte[]... etags)

advanced

public CoapResponse advanced(Request request)

Sends an advanced synchronous request that has to be configured by the developer.

Parameters:

request - the custom request

Returns:

the CoAP response

advanced

public void advanced(CoapHandler handler,
                     Request request)

Sends an advanced asynchronous request that has to be configured by the developer.

Parameters:

handler - the response handler

request - the custom request

observeAndWait

public CoapObserveRelation observeAndWait(CoapHandler handler)

Sends an observe request and waits until it has been established whereupon the specified handler is invoked when a notification arrives.

Parameters:

handler - the Response handler

Returns:

the CoAP observe relation

observeAndWait

public CoapObserveRelation observeAndWait(CoapHandler handler,
                                          int accept)

Sends an observe request with the specified Accept option and waits until it has been established whereupon the specified handler is invoked when a notification arrives.

Parameters:

handler - the Response handler

accept - the Accept option

Returns:

the CoAP observe relation

observe

public CoapObserveRelation observe(CoapHandler handler)

Sends an observe request and invokes the specified handler each time a notification arrives.

Parameters:

handler - the Response handler

Returns:

the CoAP observe relation

observe

public CoapObserveRelation observe(CoapHandler handler,
                                   int accept)

Sends an observe request with the specified Accept option and invokes the specified handler each time a notification arrives.

Parameters:

handler - the Response handler

accept - the Accept option

Returns:

the CoAP observe relation

shutdown

public void shutdown()

Stops the client-specific executor service to cleanly exit programs. Only needed if useExecutor() or setExecutor(ExecutorService) are used (i.e., a client-specific executor service was set).