net.roboconf.dm.management.api.IAutonomicMngr Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of roboconf-dm Show documentation
There is a newer version: 0.9.1
/**
 * Copyright 2015-2016 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.dm.management.api;

import net.roboconf.core.model.beans.Application;
import net.roboconf.core.model.beans.Instance;
import net.roboconf.dm.management.ManagedApplication;
import net.roboconf.messaging.api.messages.from_agent_to_dm.MsgNotifAutonomic;

/**
 * An API related to autonomic stuff.
 * 
 * It must be invoked every time a rule-based decision must be made in the DM.
 * 
 *
 * @author Vincent Zurczak - Linagora
 */
public interface IAutonomicMngr {

	/**
	 * Loads the rules of a given application.
	 * @param app a non-null application
	 */
	void loadApplicationRules( Application app );


	/**
	 * Unloads the rules of a given application.
	 * @param app a non-null application
	 */
	void unloadApplicationRules( Application app );


	/**
	 * Refreshes the rules of a given application.
	 * @param app a non-null application
	 * @param ruleFileName the name of a rule file to reload, null to refresh them all
	 */
	void refreshApplicationRules( Application app, String ruleFileName );


	/**
	 * Machines created by the autonomic may be deleted by hand.
	 * 
	 * In such a case, we should update the VM counter.
	 * 
	 * @param rootInstance a root instance
	 */
	void notifyVmWasDeletedByHand( Instance rootInstance );


	/**
	 * @return the number of root instances created by the autonomic
	 */
	int getAutonomicInstancesCount();


	/**
	 * Reacts upon autonomic monitoring message (a.k.a "autonomic event").
	 * @param event the autonomic event message
	 */
	void handleEvent( ManagedApplication ma, MsgNotifAutonomic event );
}