org.parallelj.launching.transport.jmx.JmxOption Maven / Gradle / Ivy

Go to download
/*
 *     ParallelJ, framework for parallel computing
 *
 *     Copyright (C) 2010, 2011, 2012 Atos Worldline or third-party contributors as
 *     indicated by the @author tags or express copyright attribution
 *     statements applied by the authors.
 *
 *     This library is free software; you can redistribute it and/or
 *     modify it under the terms of the GNU Lesser General Public
 *     License as published by the Free Software Foundation; either
 *     version 2.1 of the License.
 *
 *     This library is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *     Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public
 *     License along with this library; if not, write to the Free Software
 *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
package org.parallelj.launching.transport.jmx;

import java.util.Map;


/**
 * Define an Option for remote launching using Jmx.
 */
public interface JmxOption {
	/**
	 * Return the name of the Option as it appears in the JmxConsole.
	 * 
	 * @return the name of the Option
	 */
	public String getName();

	/**
	 * Return the description of the Option as it appears in the JmxConsole.
	 * 
	 * @return the description of the Option
	 */
	public String getDescription();

	/**
	 * Process the Option.
	 * The JobDataMap is enriched with Options values according to the remote call.
	 * 
	 * @param jobDataMap
	 * @param value
	 */
	public void process(Map jobDataMap, String value);

}