ITargetHandlerResolver.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.dm.management.api;

import java.util.Map;

import net.roboconf.target.api.TargetException;
import net.roboconf.target.api.TargetHandler;

/**
 * An interface to define how we resolve deployment handlers.
 * <p>
 * This interface was defined to easily mock targets (e.g. cloud infrastructures)
 * for tests. We can thus easily inject any target handler.
 * </p>
 *
 * @author Vincent Zurczak - Linagora
 */
public interface ITargetHandlerResolver {

	/**
	 * Finds the right target handler based on properties.
	 * @param targetProperties a non-null map of target properties
	 * @return a handler for a deployment target
	 * @throws TargetException if no handler was found
	 */
	TargetHandler findTargetHandler( Map<String,String> targetProperties ) throws TargetException;
}