org.eclipse.californium.core.server.resources.ResourceObserver Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2015 Institute for Pervasive Computing, ETH Zurich and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 * 
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *    http://www.eclipse.org/org/documents/edl-v10.html.
 * 
 * Contributors:
 *    Matthias Kovatsch - creator and main architect
 *    Martin Lanter - architect and re-implementation
 *    Dominique Im Obersteg - parsers and initial implementation
 *    Daniel Pauli - parsers and initial implementation
 *    Kai Hudalla - logging
 ******************************************************************************/
package org.eclipse.californium.core.server.resources;

import org.eclipse.californium.core.observe.ObserveRelation;

/**
 * This interface implements Java's observe design pattern for a resource.
 * Notice that it has nothing to do with CoAP's observe relations. A
 * ResourceObserver can be added to a {@link Resource} which should invoke the
 * specified methods if a corresponding event occurs.
 */
public interface ResourceObserver {

	/**
	 * Invoked when the name of the resource has changed.
	 * 
	 * @param old the old name
	 */
	public void changedName(String old);
	
	/**
	 * Invoked when the Path of the resource has changed.
	 *
	 * @param old the old path
	 */
	public void changedPath(String old);
	
	/**
	 *Invoked when a child has been added to the resource.
	 *
	 * @param child the child
	 */
	public void addedChild(Resource child);
	
	/**
	 * Invoked when a child has been removed from the resource.
	 *
	 * @param child the child
	 */
	public void removedChild(Resource child);
	
	/**
	 * Invoked when a CoAP observe relation has been established with the
	 * resource.
	 * 
	 * @param relation the relation
	 */
	public void addedObserveRelation(ObserveRelation relation);
	
	/**
	 * Invoked when a CoAP observe relation has been canceled with the
	 * resource
	 *  
	 * @param relation the relation
	 */
	public void removedObserveRelation(ObserveRelation relation);
}