org.moskito.controlagent.endpoints.rmi.AgentService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moskito-control-agent-rmi-endpoint Show documentation

The newest version!

package org.moskito.controlagent.endpoints.rmi;

import net.anotheria.anoprise.metafactory.Service;
import net.anotheria.moskito.core.config.MoskitoConfiguration;
import org.distributeme.annotation.DistributeMe;
import org.moskito.controlagent.data.accumulator.AccumulatorHolder;
import org.moskito.controlagent.data.accumulator.AccumulatorListItem;
import org.moskito.controlagent.data.info.SystemInfo;
import org.moskito.controlagent.data.nowrunning.EntryPoint;
import org.moskito.controlagent.data.status.StatusHolder;
import org.moskito.controlagent.data.threshold.ThresholdDataItem;

import java.util.List;
import java.util.Map;

/**
 * AgentService is the base for distribution and a distributeme wrapper for the Agent.
 *
 * @author lrosenberg
 * @since 09.04.14 13:50
 */
@DistributeMe(moskitoSupport = false, agentsSupport = false)
public interface AgentService extends Service{

	/**
	 * Returns info about this app and its environment
	 * @return app info object
	 * @throws AgentServiceException on
	 */
	SystemInfo getSystemInfo() throws AgentServiceException;

	/**
	 * Returns the current status.
	 * @return
	 * @throws AgentServiceException
	 */
	StatusHolder getThresholdStatus() throws AgentServiceException;

	/**
	 * Returns the list of contained thresholds.
	 * @return
	 * @throws AgentServiceException
	 */
	List getThresholds() throws AgentServiceException;

	/**
	 * Returns the list of available accumulators.
	 * @return
	 * @throws AgentServiceException
	 */
	List getAvailableAccumulators() throws AgentServiceException;

	/**
	 * Returns accumulator data
	 * @param accumulatorNames
	 * @return
	 * @throws AgentServiceException
	 */
	Map getAccumulatorsData(List accumulatorNames) throws AgentServiceException;

	/**
	 * Returns component's config.
	 *
	 * @return {@link MoskitoConfiguration}
	 * @throws AgentServiceException on errors
	 */
	MoskitoConfiguration getConfig() throws AgentServiceException;

	/**
	 * Returns currently running objects.
	 * @return
	 * @throws AgentServiceException
	 */
	List getNowRunningInfo() throws AgentServiceException;

}