org.coos.messaging.LinkManager Maven / Gradle / Ivy

Go to download
/**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 */
package org.coos.messaging;

import java.util.Vector;

/**
 * The LinkManager, Both Endpoints and Routers are LinkManagers.
 * 
 * @author Knut Eilif Husa, Tellu AS
 */
public interface LinkManager {

	/**
	 * Adds a Link to this LinkManager
	 * 
	 * @param destinationUuid
	 *            the unique identifier of the destination of this Link
	 * @param link
	 *            the link
	 * @throws ConnectingException
	 *             thrown if this LinkManager is not able to add the Link, i.e.
	 *             there is a configuration mismatch
	 */
	void addLink(String destinationUuid, Link link) throws ConnectingException;

	/**
	 * The Default processor of this LinkManager,
	 * 
	 * @return the default Processor
	 */
	Processor getDefaultProcessor();

	/**
	 * returns the link associated with the supplied destination Uuid
	 * 
	 * @param destinationUuid
	 *            the destination uuid
	 * @return the link
	 */
	Link getLink(String destinationUuid);

	/**
	 * Removes the link associated with the supplied destinationUuid uuid
	 * 
	 * @param destinationUuid
	 *            the endpoint uuid
	 * @return the link
	 */

	void removeLink(String destinationUuid);

	/**
	 * Removes Link by the unique identifier of this Link
	 * 
	 * @param linkId
	 */
	void removeLinkById(String linkId);

	/**
	 * Sets a set of aliases on a link.
	 * 
	 * @param linkAliases
	 *            - A vector of alias strings
	 * @param link
	 *            - the link to set the aliases on
	 * @throws ProcessorException
	 */
	void setLinkAliases(Vector linkAliases, Link link) throws ProcessorException;

}