ApiDynamicActionImplementor.java

package org.zaproxy.zap.extension.api;

import java.util.HashMap;
import java.util.Map;

import net.sf.json.JSONObject;

/**
 * The ApiDynamicActionImplementor is used for actions that are loaded dynamically.
 */
public abstract class ApiDynamicActionImplementor extends ApiElement {

	/**
	 * Instantiates a new api dynamic action implementor.
	 * 
	 * @param name the name
	 * @param mandatoryParamNames the mandatory param names, or <code>null</code> if there are no
	 *            mandatory parameters
	 * @param optionalParamNames the optional param names, or <code>null</code> if there are no
	 *            optional parameters
	 */
	public ApiDynamicActionImplementor(String name, String[] mandatoryParamNames, String[] optionalParamNames) {
		super(name, mandatoryParamNames, optionalParamNames);
	}

	/**
	 * Handle the execution of the action.
	 * 
	 * @param params the params
	 * @throws ApiException the api exception
	 */
	public abstract void handleAction(JSONObject params) throws ApiException;

	/**
	 * Builds an {@link ApiResponse} describing the parameters of this action.
	 * 
	 * @return the api response set
	 */
	public ApiResponse buildParamsDescription() {
		ApiResponseList configParams = new ApiResponseList("methodConfigParams");
		for (String param : this.getMandatoryParamNames())
			configParams.addItem(buildParamMap(param, true));
		for (String param : this.getOptionalParamNames())
			configParams.addItem(buildParamMap(param, false));
		return configParams;
	}

	/**
	 * Builds a {@code ApiResponseSet} with the given parameter name and whether or not it is mandatory.
	 *
	 * @param paramName the name of the parameter
	 * @param mandatory {@code true} if the parameter is mandatory, {@code false} otherwise
	 * @return the {@code ApiResponseSet} with the name and mandatory fields
	 */
	private static ApiResponseSet<String> buildParamMap(String paramName, boolean mandatory) {
		Map<String, String> m = new HashMap<>();
		m.put("name", paramName);
		m.put("mandatory", mandatory ? "true" : "false");
		return new ApiResponseSet<String>("param", m);
	}

}