org.eclipse.californium.proxy.resources

Class ProxyCacheResource

java.lang.Object

org.eclipse.californium.core.CoapResource

org.eclipse.californium.proxy.resources.ProxyCacheResource

All Implemented Interfaces:

Resource, CacheResource

public class ProxyCacheResource
extends CoapResource
implements CacheResource

Resource to handle the caching in the proxy.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.californium.core.server.resources.Resource

Resource.ResourceTreeBuilder

Constructor Summary

Constructors

Constructor and Description
ProxyCacheResource() Instantiates a new proxy cache resource.
ProxyCacheResource(boolean enabled) Instantiates a new proxy cache resource.

Method Summary

Modifier and Type	Method and Description
void	cacheResponse(Request request, Response response) Puts in cache an entry or, if already present, refreshes it.
com.google.common.cache.CacheStats	getCacheStats()
Response	getResponse(Request request) Retrieves the response in the cache that matches the request passed, null otherwise.
void	handleDELETE(CoapExchange exchange) Handles the DELETE request in the given CoAPExchange.
void	handleGET(CoapExchange exchange) Handles the GET request in the given CoAPExchange.
void	handlePOST(CoapExchange exchange) Handles the POST request in the given CoAPExchange.
void	invalidateRequest(Request request)
boolean	isEnabled()
void	setEnabled(boolean enabled)

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

add, add, add, addObserver, addObserveRelation, changed, checkObserveRelation, clearAndNotifyObserveRelations, clearObserveRelations, createClient, createClient, createClient, delete, execute, executeAndWait, getAttributes, getChild, getChildren, getEndpoints, getExecutor, getName, getObserverCount, getParent, getPath, getURI, handlePUT, handleRequest, isCachable, isObservable, isVisible, remove, remove, removeObserver, removeObserveRelation, setName, setObservable, setObserveType, setParent, setPath, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyCacheResource

public ProxyCacheResource()

Instantiates a new proxy cache resource.

ProxyCacheResource

public ProxyCacheResource(boolean enabled)

Instantiates a new proxy cache resource.

Method Detail

cacheResponse

public void cacheResponse(Request request,
                          Response response)

Puts in cache an entry or, if already present, refreshes it. The method first checks the response code, only the 2.xx codes are cached by coap. In case of 2.01, 2.02, and 2.04 response codes it invalidates the possibly present response. In case of 2.03 it updates the freshness of the response with the max-age option provided. In case of 2.05 it creates the key and caches the response if the max-age option is higher than zero.

Specified by:

cacheResponse in interface CacheResource

getCacheStats

public com.google.common.cache.CacheStats getCacheStats()

Specified by:

getCacheStats in interface CacheResource

getResponse

public Response getResponse(Request request)

Retrieves the response in the cache that matches the request passed, null otherwise. The method creates the key for the cache starting from the request and checks if the cache contains it. If present, the method updates the max-age of the linked response to consider the time passed in the cache (according to the freshness model) and returns it. On the contrary, if the response has passed its expiration time, it is invalidated and the method returns null.

Specified by:

getResponse in interface CacheResource

Parameters:

request - the request

Returns:

the cached response or null in case it is not present

invalidateRequest

public void invalidateRequest(Request request)

Specified by:

invalidateRequest in interface CacheResource

handleDELETE

public void handleDELETE(CoapExchange exchange)

Description copied from class: CoapResource

Handles the DELETE request in the given CoAPExchange. By default it responds with a 4.05 (Method Not Allowed). Override this method to respond differently to DELETE requests. The response code to a DELETE request should be a Deleted (2.02).

Overrides:

handleDELETE in class CoapResource

Parameters:

exchange - the CoapExchange for the simple API

handleGET

public void handleGET(CoapExchange exchange)

Description copied from class: CoapResource

Handles the GET request in the given CoAPExchange. By default it responds with a 4.05 (Method Not Allowed). Override this method to respond differently to GET requests. Possible response codes for GET requests are Content (2.05) and Valid (2.03).

Overrides:

handleGET in class CoapResource

Parameters:

exchange - the CoapExchange for the simple API

handlePOST

public void handlePOST(CoapExchange exchange)

Description copied from class: CoapResource

Handles the POST request in the given CoAPExchange. By default it responds with a 4.05 (Method Not Allowed). Override this method to respond differently to POST requests. Possible response codes for POST requests are Created (2.01), Changed (2.04), and Deleted (2.02).

Overrides:

handlePOST in class CoapResource

Parameters:

exchange - the CoapExchange for the simple API

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)