org.eclipse.californium.core.server.resources.Resource Java Examples

@Override
public void deliverRequest(final Exchange exchange) {
	Request request = exchange.getRequest();
	List<String> path = request.getOptions().getUriPath();
	final Resource resource = findResource(path);
	if (resource != null) {
		checkForObserveOption(exchange, resource);
		
		// Get the executor and let it process the request
		Executor executor = resource.getExecutor();
		if (executor != null) {
			exchange.setCustomExecutor();
			executor.execute(new Runnable() {
				public void run() {
					resource.handleRequest(exchange);
				} });
		} else {
			resource.handleRequest(exchange);
		}
	} else {
		LOGGER.info("Did not find resource " + path.toString() + " requested by " + request.getSource()+":"+request.getSourcePort());
		exchange.sendResponse(new Response(ResponseCode.NOT_FOUND));
	}
}
 

public static void serializeTree(Resource resource, List<String> queries, StringBuilder buffer) {
	// add the current resource to the buffer
	if (resource.isVisible()
			&& LinkFormat.matches(resource, queries)) {
		buffer.append(LinkFormat.serializeResource(resource));
	}
	
	// sort by resource name
	List<Resource> childs = new ArrayList<Resource>(resource.getChildren());
	Collections.sort(childs, new Comparator<Resource>() {
	    @Override
	    public int compare(Resource o1, Resource o2) {
	        return o1.getName().compareTo(o2.getName());
	    }
	});
	
	for (Resource child:childs) {
		serializeTree(child, queries, buffer);
	}
}
 

public synchronized void setName(String name) {
	if (name == null)
		throw new NullPointerException();
	String old = this.name;
	
	// adjust parent if in tree
	Resource parent = getParent();
	if (parent!=null) {
		synchronized (parent) {
			parent.delete(this);
			this.name = name;
			parent.add(this);
		}
	} else {
		this.name = name;
	}
	adjustChildrenPath();
	
	for (ResourceObserver obs:observers)
		obs.changedName(old);
}
 

public static void serializeTree(Resource resource, List<String> queries, StringBuilder buffer) {
	// add the current resource to the buffer
	if (resource.isVisible()
			&& LinkFormat.matches(resource, queries)) {
		buffer.append(LinkFormat.serializeResource(resource));
	}
	
	// sort by resource name
	List<Resource> childs = new ArrayList<Resource>(resource.getChildren());
	Collections.sort(childs, new Comparator<Resource>() {
	    @Override
	    public int compare(Resource o1, Resource o2) {
	        return o1.getName().compareTo(o2.getName());
	    }
	});
	
	for (Resource child:childs) {
		serializeTree(child, queries, buffer);
	}
}
 

@Override
public void deliverRequest(final Exchange exchange) {
	Request request = exchange.getRequest();
	List<String> path = request.getOptions().getUriPath();
	final Resource resource = findResource(path);
	if (resource != null) {
		checkForObserveOption(exchange, resource);
		
		// Get the executor and let it process the request
		Executor executor = resource.getExecutor();
		if (executor != null) {
			exchange.setCustomExecutor();
			executor.execute(new Runnable() {
				public void run() {
					resource.handleRequest(exchange);
				} });
		} else {
			resource.handleRequest(exchange);
		}
	} else {
		LOGGER.info("Did not find resource " + path.toString() + " requested by " + request.getSource()+":"+request.getSourcePort());
		exchange.sendResponse(new Response(ResponseCode.NOT_FOUND));
	}
}
 

/**
 * Verifies that the adapter registers resources as part of the start-up process.
 *
 * @param ctx The helper to use for running async tests on vertx.
 */
@Test
public void testStartRegistersResources(final VertxTestContext ctx) {

    // GIVEN an adapter
    final CoapServer server = getCoapServer(false);
    // and a set of resources
    final Resource resource = mock(Resource.class);

    final AbstractVertxBasedCoapAdapter<CoapAdapterProperties> adapter = getAdapter(server, true, s -> {});
    adapter.setResources(Collections.singleton(resource));

    // WHEN starting the adapter
    final Promise<Void> startupTracker = Promise.promise();
    startupTracker.future().onComplete(ctx.succeeding(s -> {
        // THEN the resources have been registered with the server
        final ArgumentCaptor<VertxCoapResource> resourceCaptor = ArgumentCaptor.forClass(VertxCoapResource.class);
        ctx.verify(() -> {
            verify(server).add(resourceCaptor.capture());
            assertThat(resourceCaptor.getValue().getWrappedResource()).isEqualTo(resource);
        });
        ctx.completeNow();
    }));
    adapter.start(startupTracker);

}
 

public synchronized void setName(String name) {
	if (name == null)
		throw new NullPointerException();
	String old = this.name;
	
	// adjust parent if in tree
	Resource parent = getParent();
	if (parent!=null) {
		synchronized (parent) {
			parent.delete(this);
			this.name = name;
			parent.add(this);
		}
	} else {
		this.name = name;
	}
	adjustChildrenPath();
	
	for (ResourceObserver obs:observers)
		obs.changedName(old);
}
 

@Override
public synchronized void add(Resource child) {
	if (child.getName() == null)
		throw new NullPointerException("Child must have a name");
	if (child.getParent() != null)
		child.getParent().delete(child);
	children.put(child.getName(), child);
	child.setParent(this);
	for (ResourceObserver obs:observers)
		obs.addedChild(child);
}
 

public static StringBuilder serializeResource(Resource resource) {
	StringBuilder buffer = new StringBuilder();
	buffer.append("<")
		.append(resource.getPath())
		.append(resource.getName())
		.append(">")
		.append(LinkFormat.serializeAttributes(resource.getAttributes()))
		.append(",");
	return buffer;
}
 

@Override
public synchronized boolean delete(Resource child) {
	Resource deleted = delete(child.getName());
	if (deleted == child) {
		child.setParent(null);
		child.setPath(null);
		for (ResourceObserver obs : observers)
			obs.removedChild(child);
		return true;
	}
	return false;
}
 

/**
 * Add a resource to the server.
 * @param resources the resource(s)
 * @return the server
 */
@Override
public CoapServer add(Resource... resources) {
	for (Resource r:resources)
		root.add(r);
	return this;
}
 

/**
 * Delete this resource from its parents and notify all observing CoAP
 * clients that this resource is no longer accessible.
 */
public synchronized void delete() {
	Resource parent = getParent();
	if (parent != null) {
		parent.delete(this);
	}
	
	if (isObservable()) {
		clearAndNotifyObserveRelations(ResponseCode.NOT_FOUND);
	}
}
 

/**
 * Delete this resource from its parents and notify all observing CoAP
 * clients that this resource is no longer accessible.
 */
public synchronized void delete() {
	Resource parent = getParent();
	if (parent != null) {
		parent.delete(this);
	}
	
	if (isObservable()) {
		clearAndNotifyObserveRelations(ResponseCode.NOT_FOUND);
	}
}
 

@Override
public synchronized boolean delete(Resource child) {
	Resource deleted = delete(child.getName());
	if (deleted == child) {
		child.setParent(null);
		child.setPath(null);
		for (ResourceObserver obs : observers)
			obs.removedChild(child);
		return true;
	}
	return false;
}
 

@Override
public synchronized void add(Resource child) {
	if (child.getName() == null)
		throw new NullPointerException("Child must have a name");
	if (child.getParent() != null)
		child.getParent().delete(child);
	children.put(child.getName(), child);
	child.setParent(this);
	for (ResourceObserver obs:observers)
		obs.addedChild(child);
}
 

/**
 * Constructs a new resource with the specified name and makes it visible to
 * clients if the flag is true.
 * 
 * @param name the name
 * @param visible if the resource is visible
 */
public CoapResource(String name, boolean visible) {
	this.name = name;
	this.path = "";
	this.visible = visible;
	this.attributes = new ResourceAttributes();
	this.children = new ConcurrentHashMap<String, Resource>();
	this.observers = new CopyOnWriteArrayList<ResourceObserver>();
	this.observeRelations = new ObserveRelationContainer();
	this.notificationOrderer = new ObserveNotificationOrderer();
}
 

/**
 * Constructs a new observe relation.
 * 
 * @param endpoint the observing endpoint
 * @param resource the observed resource
 * @param exchange the exchange that tries to establish the observe relation
 */
public ObserveRelation(ObservingEndpoint endpoint, Resource resource, Exchange exchange) {
	if (endpoint == null)
		throw new NullPointerException();
	if (resource == null)
		throw new NullPointerException();
	if (exchange == null)
		throw new NullPointerException();
	this.endpoint = endpoint;
	this.resource = resource;
	this.exchange = exchange;
	this.established = false;
	
	this.key = getSource().toString() + "#" + exchange.getRequest().getTokenString();
}
 

/**
 * Constructs a new resource with the specified name and makes it visible to
 * clients if the flag is true.
 * 
 * @param name the name
 * @param visible if the resource is visible
 */
public CoapResource(String name, boolean visible) {
	this.name = name;
	this.path = "";
	this.visible = visible;
	this.attributes = new ResourceAttributes();
	this.children = new ConcurrentHashMap<String, Resource>();
	this.observers = new CopyOnWriteArrayList<ResourceObserver>();
	this.observeRelations = new ObserveRelationContainer();
	this.notificationOrderer = new ObserveNotificationOrderer();
}
 

/**
 * Constructs a new observe relation.
 * 
 * @param endpoint the observing endpoint
 * @param resource the observed resource
 * @param exchange the exchange that tries to establish the observe relation
 */
public ObserveRelation(ObservingEndpoint endpoint, Resource resource, Exchange exchange) {
	if (endpoint == null)
		throw new NullPointerException();
	if (resource == null)
		throw new NullPointerException();
	if (exchange == null)
		throw new NullPointerException();
	this.endpoint = endpoint;
	this.resource = resource;
	this.exchange = exchange;
	this.established = false;
	
	this.key = getSource().toString() + "#" + exchange.getRequest().getTokenString();
}
 

/**
 * Verifies that the resources registered with the adapter are always
 * executed on the adapter's vert.x context.
 *
 * @param ctx The helper to use for running async tests on vertx.
 */
@Test
public void testResourcesAreRunOnVertxContext(final VertxTestContext ctx) {

    // GIVEN an adapter
    final Context context = vertx.getOrCreateContext();
    final CoapServer server = getCoapServer(false);
    // with a resource
    final Promise<Void> resourceInvocation = Promise.promise();
    final Resource resource = new CoapResource("test") {

        @Override
        public void handleGET(final CoapExchange exchange) {
            ctx.verify(() -> assertThat(Vertx.currentContext()).isEqualTo(context));
            resourceInvocation.complete();
        }
    };

    final AbstractVertxBasedCoapAdapter<CoapAdapterProperties> adapter = getAdapter(server, true, s -> {});
    adapter.setResources(Collections.singleton(resource));

    final Promise<Void> startupTracker = Promise.promise();
    adapter.init(vertx, context);
    adapter.start(startupTracker);

    startupTracker.future()
        .compose(ok -> {
            // WHEN the resource receives a GET request
            final Request request = new Request(Code.GET);
            final Exchange getExchange = new Exchange(request, Origin.REMOTE, mock(Executor.class));
            final ArgumentCaptor<VertxCoapResource> resourceCaptor = ArgumentCaptor.forClass(VertxCoapResource.class);
            verify(server).add(resourceCaptor.capture());
            resourceCaptor.getValue().handleRequest(getExchange);
            // THEN the resource's handler has been run on the adapter's vert.x event loop
            return resourceInvocation.future();
        })
        .onComplete(ctx.completing());
}
 

/**
 * Searches in the resource tree for the specified path. A parent resource
 * may accept requests to subresources, e.g., to allow addresses with
 * wildcards like <code>coap://example.com:5683/devices/*</code>
 * 
 * @param list the path as list of resource names
 * @return the resource or null if not found
 */
private Resource findResource(List<String> list) {
	LinkedList<String> path = new LinkedList<String>(list);
	Resource current = root;
	
	while (!path.isEmpty() && current != null) {
		String name = path.removeFirst();
		current = current.getChild(name);
		if(current != null && current.isAllChildFilter()) {	
			break;
		}
	}
	
	return current;
}
 

public static String serializeTree(Resource resource) {
	StringBuilder buffer = new StringBuilder();
	List<String> noQueries = Collections.emptyList();
	
	// only include children, not the entry point itself
	for (Resource child:resource.getChildren()) {
		serializeTree(child, noQueries, buffer);
	}
	
	if (buffer.length()>1)
		buffer.delete(buffer.length()-1, buffer.length());
	return buffer.toString();
}
 

/**
 * Searches in the resource tree for the specified path. A parent resource
 * may accept requests to subresources, e.g., to allow addresses with
 * wildcards like <code>coap://example.com:5683/devices/*</code>
 * 
 * @param list the path as list of resource names
 * @return the resource or null if not found
 */
private Resource findResource(List<String> list) {
	LinkedList<String> path = new LinkedList<String>(list);
	Resource current = root;
	
	while (!path.isEmpty() && current != null) {
		String name = path.removeFirst();
		current = current.getChild(name);
		if(current != null && current.isAllChildFilter()) {	
			break;
		}
	}
	
	return current;
}
 

public static String serializeTree(Resource resource) {
	StringBuilder buffer = new StringBuilder();
	List<String> noQueries = Collections.emptyList();
	
	// only include children, not the entry point itself
	for (Resource child:resource.getChildren()) {
		serializeTree(child, noQueries, buffer);
	}
	
	if (buffer.length()>1)
		buffer.delete(buffer.length()-1, buffer.length());
	return buffer.toString();
}
 

public static StringBuilder serializeResource(Resource resource) {
	StringBuilder buffer = new StringBuilder();
	buffer.append("<")
		.append(resource.getPath())
		.append(resource.getName())
		.append(">")
		.append(LinkFormat.serializeAttributes(resource.getAttributes()))
		.append(",");
	return buffer;
}
 

/**
 * Add a resource to the server.
 * @param resources the resource(s)
 * @return the server
 */
@Override
public CoapServer add(Resource... resources) {
	for (Resource r:resources)
		root.add(r);
	return this;
}
 

public static boolean matches(Resource resource, List<String> queries) {
	
	if (resource==null) return false;
	if (queries==null || queries.size()==0) return true;
	
	ResourceAttributes attributes = resource.getAttributes();
	String path = resource.getPath()+resource.getName();
	
	for (String s : queries) {
		int delim = s.indexOf("=");
		if (delim != -1) {
			
			// split name-value-pair
			String attrName = s.substring(0, delim);
			String expected = s.substring(delim+1);

			if (attrName.equals(LinkFormat.LINK)) {
				if (expected.endsWith("*")) {
					return path.startsWith(expected.substring(0, expected.length()-1));
				} else {
					return path.equals(expected);
				}
			} else if (attributes.containsAttribute(attrName)) {
				// lookup attribute value
				for (String actual : attributes.getAttributeValues(attrName)) {
				
					// get prefix length according to "*"
					int prefixLength = expected.indexOf('*');
					if (prefixLength >= 0 && prefixLength < actual.length()) {
				
						// reduce to prefixes
						expected = expected.substring(0, prefixLength);
						actual = actual.substring(0, prefixLength);
					}
					
					// handle case like rt=[Type1 Type2]
					if (actual.indexOf(" ") > -1) { // if contains white space
						String[] parts = actual.split(" ");
						for (String part : parts) { // check each part for match
							if (part.equals(expected)) {
								return true;
							}
						}
					}
					
					// compare strings
					if (expected.equals(actual)) {
						return true;
					}
				}
			}
		} else {
			// flag attribute
			if (attributes.getAttributeValues(s).size()>0) {
				return true;
			}
		}
	}
	return false;
}
 

public void setParent(Resource parent) {
	this.parent = parent;
	if (parent != null)
		this.path = parent.getPath()  + parent.getName() + "/";
	adjustChildrenPath();
}
 

public static boolean matches(Resource resource, List<String> queries) {
	
	if (resource==null) return false;
	if (queries==null || queries.size()==0) return true;
	
	ResourceAttributes attributes = resource.getAttributes();
	String path = resource.getPath()+resource.getName();
	
	for (String s : queries) {
		int delim = s.indexOf("=");
		if (delim != -1) {
			
			// split name-value-pair
			String attrName = s.substring(0, delim);
			String expected = s.substring(delim+1);

			if (attrName.equals(LinkFormat.LINK)) {
				if (expected.endsWith("*")) {
					return path.startsWith(expected.substring(0, expected.length()-1));
				} else {
					return path.equals(expected);
				}
			} else if (attributes.containsAttribute(attrName)) {
				// lookup attribute value
				for (String actual : attributes.getAttributeValues(attrName)) {
				
					// get prefix length according to "*"
					int prefixLength = expected.indexOf('*');
					if (prefixLength >= 0 && prefixLength < actual.length()) {
				
						// reduce to prefixes
						expected = expected.substring(0, prefixLength);
						actual = actual.substring(0, prefixLength);
					}
					
					// handle case like rt=[Type1 Type2]
					if (actual.indexOf(" ") > -1) { // if contains white space
						String[] parts = actual.split(" ");
						for (String part : parts) { // check each part for match
							if (part.equals(expected)) {
								return true;
							}
						}
					}
					
					// compare strings
					if (expected.equals(actual)) {
						return true;
					}
				}
			}
		} else {
			// flag attribute
			if (attributes.getAttributeValues(s).size()>0) {
				return true;
			}
		}
	}
	return false;
}
 

@Override // should be used for read-only
public Collection<Resource> getChildren() {
	return children.values();
}