package rocks.inspectit.shared.all.cmr.service;

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

import rocks.inspectit.shared.all.communication.message.IAgentMessage;
import rocks.inspectit.shared.all.exception.BusinessException;
import rocks.inspectit.shared.all.instrumentation.classcache.Type;
import rocks.inspectit.shared.all.instrumentation.config.impl.AgentConfig;
import rocks.inspectit.shared.all.instrumentation.config.impl.InstrumentationDefinition;
import rocks.inspectit.shared.all.instrumentation.config.impl.JmxAttributeDescriptor;

/**
 * Interface for agent communication with the CMR.
 *
 * @author Ivan Senic
 *
 */
@ServiceInterface(exporter = ServiceExporterType.RMI, serviceId = 4)
public interface IAgentService {

	/**
	 * Registers the agent with the CMR. The CMR will answer with the {@link AgentConfig} containing
	 * all necessary information for the agent initialization.
	 *
	 * @param definedIPs
	 *            The list of all network interfaces.
	 * @param agentName
	 *            The self-defined name of the inspectIT Agent.
	 * @param version
	 *            The version the agent is currently running with.
	 * @return {@link AgentConfig}.
	 * @throws BusinessException
	 *             When no environment can be located for the agent based on the mapping settings.
	 */
	AgentConfig register(List<String> definedIPs, String agentName, String version) throws BusinessException;

	/**
	 * Unregisters the platform in the CMR by sending the agent id.
	 *
	 * @param platformIdent
	 *            Id of the agent.
	 *
	 * @throws BusinessException
	 *             If un-registration fails.
	 */
	void unregister(long platformIdent) throws BusinessException;

	/**
	 * Analyzes the given type and adds instrumentation points if necessary, returning the
	 * instrumentation result so that instrumentation can be performed on the agent.
	 *
	 * @param platformIdent
	 *            Id of the agent.
	 * @param hash
	 *            Class hash code.
	 * @param type
	 *            Parsed {@link Type} representing class being loaded on the agent.
	 * @return Instrumentation definition containing method instrumentation configs or
	 *         <code>null</code> if nothing should be instrumented.
	 * @throws BusinessException
	 *             If agent with specified id does not exist.
	 */
	InstrumentationDefinition analyze(long platformIdent, String hash, Type type) throws BusinessException;

	/**
	 * Informs the CMR that the methods have been instrumented on the agent.
	 *
	 * @param platformId
	 *            Id of the agent.
	 * @param methodToSensorMap
	 *            map containing method id as key and applied sensor IDs
	 */
	void instrumentationApplied(long platformId, Map<Long, long[]> methodToSensorMap);

	/**
	 * Analyzes the given {@link JmxAttributeDescriptor} and decides which ones will be monitored,
	 * based on the current configuration.
	 *
	 * @param platformIdent
	 *            Id of the agent sending the descriptors.
	 * @param attributeDescriptors
	 *            {@link JmxAttributeDescriptor}s that are available on the agent for monitoring.
	 * @return Collection of {@link JmxAttributeDescriptor} to be monitored with their correctly set
	 *         IDs.
	 * @throws BusinessException
	 *             If agent with given ID does not exist.
	 */
	Collection<JmxAttributeDescriptor> analyzeJmxAttributes(long platformIdent, Collection<JmxAttributeDescriptor> attributeDescriptors) throws BusinessException;

	/**
	 * Fetches all {@link IAgentMessage} which are available at the CMR. The returned list is
	 * an ordered list, ordered by time (ascending -> index 0 is the oldest).
	 *
	 * @param platformId
	 *            Id of the agent.
	 * @return List of {@link IAgentMessage}s.
	 */
	List<IAgentMessage<?>> fetchAgentMessages(long platformId);
}