net.roboconf.messaging.client.IAgentClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of roboconf-messaging Show documentation
The newest version!
/**
 * Copyright 2014-2015 Linagora, Université Joseph Fourier, Floralis
 *
 * The present code is developed in the scope of the joint LINAGORA -
 * Université Joseph Fourier - Floralis research program and is designated
 * as a "Result" pursuant to the terms and conditions of the LINAGORA
 * - Université Joseph Fourier - Floralis research program. Each copyright
 * holder of Results enumerated here above fully & independently holds complete
 * ownership of the complete Intellectual Property rights applicable to the whole
 * of said Results, and may freely exploit it in any manner which does not infringe
 * the moral rights of the other copyright holders.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.roboconf.messaging.client;

import java.io.IOException;

import net.roboconf.core.model.beans.Instance;

/**
 * A client for the agents.
 * 
 * Each agent must have its own and unique client.
 * 
 *
 * @author Vincent Zurczak - Linagora
 */
public interface IAgentClient extends IClient {

	/**
	 * Sets the application name.
	 */
	void setApplicationName( String applicationName );


	/**
	 * Sets the name of the root instance associated with the agent.
	 */
	void setRootInstanceName( String rootInstanceName );


	// Resolve exports

	/**
	 * Publishes the exports for a given instance.
	 * 
	 * This method indicates to other instances that they can use
	 * the variables exported by THIS instance.
	 * 
	 *
	 * @param instance the instance whose exports must be published
	 * @throws IOException if something went wrong
	 */
	void publishExports( Instance instance ) throws IOException;

	/**
	 * Publishes specific exports for a given instance.
	 * @param instance the instance whose exports must be published
	 * @param facetOrComponentName the prefix of the variables to publish
	 * @throws IOException if something went wrong
	 */
	void publishExports( Instance instance, String facetOrComponentName ) throws IOException;

	/**
	 * Un-publishes the exports for a given instance.
	 * 
	 * This method indicates to other instances that the variables exported
	 * by THIS instance cannot be used anymore.
	 * 
	 *
	 * @param instance the instance whose exports must be published
	 * @throws IOException if something went wrong
	 */
	void unpublishExports( Instance instance ) throws IOException;

	/**
	 * Configures the listener for requests from other agents.
	 * 
	 * Such requests aim at asking an agent to publish its exports.
	 * The agent will do so only if it exports a variable prefixed that
	 * is required by THIS instance.
	 * 
	 *
	 * @param command {@link ListenerCommand#START} to start listening, {@link ListenerCommand#STOP} to stop listening
	 * @param instance the instance that need exports from other agents
	 * @throws IOException if something went wrong
	 */
	void listenToRequestsFromOtherAgents( ListenerCommand command, Instance instance ) throws IOException;


	// Resolve imports

	/**
	 * Requests other agents to export their variables on the messaging server.
	 * 
	 * This should be called when a new instance is registered on the agent. It guarantees
	 * that any new instance can be notified about the instances located on other agents.
	 * 
	 *
	 * @param instance the instance that need exports from other agents
	 * @throws IOException if something went wrong
	 */
	void requestExportsFromOtherAgents( Instance instance ) throws IOException;

	/**
	 * Configures the listener for the exports from other agents.
	 * @param command {@link ListenerCommand#START} to start listening, {@link ListenerCommand#STOP} to stop listening
	 * @param instance the instance that determine which exports must be listened to
	 * @throws IOException if something went wrong
	 */
	void listenToExportsFromOtherAgents( ListenerCommand command, Instance instance ) throws IOException;
}