/*
* JBoss, Home of Professional Open Source
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2008,
* @author JBoss Inc.
*/
package org.jboss.test.jbossts.taskdefs;
import java.util.Map;
/**
* General mechanism for running code during the execution of an ant target
*/
public interface ClientAction
{
/**
* Execute code in the context of an ant target
*
* @param config Configuration for this execution loaded from the ant script
* that triggered this action
* @param params Arbitary collection of name/value pairs passed in from the ant script
* that triggered this action
* @return true to indicate that the action completed successfully
* @see org.jboss.test.jbossts.taskdefs.ASClientTask
*/
boolean execute(ASTestConfig config, Map<String, String> params);
/**
* Cancel any executing operation
*
* @return true if the opeartion was cancelled
* @throws UnsupportedOperationException Not implemented
*/
boolean cancel() throws UnsupportedOperationException;
}