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

Class ResourceRegistry

java.lang.Object

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

public class ResourceRegistry
extends Object

Registry of served resources and listeners on the resources. It maintains consistency of the callback relations they have.

Constructor Summary

Constructors

Constructor and Description
ResourceRegistry(org.eclipse.californium.core.server.resources.Resource root) Construct a registry.

Method Summary

Modifier and Type	Method and Description
void	add(OperationalListener operationalListener) Add a listener to the registry.
void	add(String parentUri, ResourceConfig resourceDesciption) Add a new resource to the registry based on given resource configuration.
void	add(String parentUri, ResourceParams resourceDesciption) Add a new resource to the registry based on given resource configuration.
List<ServedResource>	findResources(String uriPattern) Find all resources of that have matching uri's.
static String	getParentUri(String uri) Get the uri of the parent of a resource.
ServedResource	getResource(String uri) Get the resources from the registry with given uri.
static int	getUriDepth(String uri) Get the depth of resource hierarchy in an uri.
static String	getUriPath(String uri) Get the path part of an uri.
static String	getUriResourceName(String uri) Get the resource name part of an uri.
static int	matchUri(String uriPattern, String resourceUri) Establish the degree in which a resource uri matches an uriPattern.
void	remove(OperationalListener listener) Remove a listener from the registry.
void	remove(String uriPattern) Remove a resource from the registry
void	removeAll() Remove all resources from the registry
static boolean	uriHasWildcard(String uri) Establish whether the uri has a wildcard and is in fact a pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRegistry

public ResourceRegistry(org.eclipse.californium.core.server.resources.Resource root)
                 throws InternalResourceRegistryException

Construct a registry. The constructor initializes served resources and listener repositories.

Parameters:

root - Mandatory root resource.

Throws:

InternalResourceRegistryException - When the the root resource is null.

Method Detail

add

public void add(String parentUri,
                ResourceConfig resourceDesciption)
         throws InternalResourceUriException

Add a new resource to the registry based on given resource configuration. The resource will be added as a child of resource with given parentUri. When parentUri is null the resource will be added to the root.

Parameters:

parentUri - the uri of the parent of the new resource.

resourceDesciption - the definition of the resource to create

Throws:

InternalResourceUriException - the parent uri does not resolve to an existing resource or resource parameters are invalid.

add

public void add(String parentUri,
                ResourceParams resourceDesciption)
         throws InternalResourceUriException

Add a new resource to the registry based on given resource configuration. The resource will be added as a child of resource with given parentUri. When parentUri is null the resource will be added to the root.

Parameters:

parentUri - The uri of the parent of the new resource.

resourceDesciption - The definition of the resource to create.

Throws:

InternalResourceUriException - when the parent uri does not resolve to an existing resource.

removeAll

public void removeAll()

Remove all resources from the registry

remove

public void remove(String uriPattern)

Remove a resource from the registry

Parameters:

uriPattern - The uri pattern defining the resources to remove

add

public void add(OperationalListener operationalListener)
         throws InternalUriPatternException

Add a listener to the registry.

Parameters:

operationalListener - The listener to add

Throws:

InternalUriPatternException - When the listeners uri pattern is invalid.

remove

public void remove(OperationalListener listener)

Remove a listener from the registry.

Parameters:

listener - The listener to add

getResource

public ServedResource getResource(String uri)
                           throws InternalResourceUriException

Get the resources from the registry with given uri. A null uri, an empty string or "/" is interpreted as the root uri.

Parameters:

uri - The uri of the resource to get.

Returns:

The served resource that has given uri, or null when the root uri is given.

Throws:

InternalResourceUriException - The resource does not exist.

findResources

public List<ServedResource> findResources(String uriPattern)

Find all resources of that have matching uri's.

Parameters:

uriPattern - the pattern to match to.

Returns:

A list containing all served resource that match. The list is not thread safe.

matchUri

public static int matchUri(String uriPattern,
                           String resourceUri)
                    throws InternalUriPatternException

Establish the degree in which a resource uri matches an uriPattern. The degree is an indication how good the pattern matches. It can be used to compare the matching of a resource uri to different patterns. For example the resource "/one/two/three" will match to both patterns "/one/*" and "/one/two/*". The latter with an higher degree because it is more specific. The degree value returned is 0 when there is no match. An integer > 0 when there is a match to some degree. MAX_VALUE when there is a perfect match, which means the pattern equals the uri.

Parameters:

uriPattern - The pattern to match to.

resourceUri - The resource uri to do the matching on.

Returns:

The degree of matching.

Throws:

InternalUriPatternException - when the pattern given is invalid

getUriDepth

public static int getUriDepth(String uri)

Get the depth of resource hierarchy in an uri.

Parameters:

uri - the resource uri

Returns:

the depth of the uri

getUriPath

public static String getUriPath(String uri)

Get the path part of an uri. That is the uri without the resource name.

Parameters:

uri - The uri of the resouce.

Returns:

The path from the uri.

getUriResourceName

public static String getUriResourceName(String uri)

Get the resource name part of an uri. That is the uri without the path preceding the resource name.

Parameters:

uri - The uri of the resource.

Returns:

The resource name.

uriHasWildcard

public static boolean uriHasWildcard(String uri)
                              throws InternalUriPatternException

Establish whether the uri has a wildcard and is in fact a pattern.

Parameters:

uri - The uri of a resource.

Returns:

true when a wildcard is found, otherwise false.

Throws:

InternalUriPatternException

getParentUri

public static String getParentUri(String uri)

Get the uri of the parent of a resource.

Parameters:

uri - The uri of the resource to get the parent from.

Returns:

the uri of the parent.