AgentMessagingInterface.java

/**
 * Copyright 2014-2017 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.agent;

import net.roboconf.core.model.beans.Instance;
import net.roboconf.messaging.api.business.IAgentClient;

/**
 * @author Pierre-Yves Gibello - Linagora
 */
public interface AgentMessagingInterface {

	/**
	 * @return the client for the messaging server
	 */
	IAgentClient getMessagingClient();

	/**
	 * @return the application name
	 */
	String getApplicationName();

	/**
	 * @return the domain
	 */
	String getDomain();

	/**
	 * @return the scoped instance's
	 */
	Instance getScopedInstance();

	/**
	 * @return the scoped instance's path (as specified in the agent's configuration)
	 */
	String getScopedInstancePath();

	/**
	 * Forces the sending of a heart beat to the DM.
	 */
	void forceHeartbeatSending();

	/**
	 * Gives the status of an agent.
	 */
	String agentStatus();
}