/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This 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, or (at your option) any later version.
*
* This software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.controller.client.helpers.standalone;
import java.io.Serializable;
import java.util.List;
import java.util.UUID;
/**
* Encapsulates a set of actions a {@link ServerDeploymentManager} should
* take to update the set of deployment content available for deployment in the
* server and/or change the content deployed in the server.
*
* @author Brian Stansberry
*/
public interface DeploymentPlan extends Serializable {
/**
* Gets the unique id of the plan.
*
* @return the id. Will not be <code>null</code>
*/
UUID getId();
/**
* Gets the list of deployment actions that are part of the deployment plan,
* in the order in which they were added to the plan.
*
* @return the actions. Will not be <code>null</code>
*/
List<DeploymentAction> getDeploymentActions();
/**
* Gets whether all <code>deploy</code>, <code>undeploy</code>, <code>replace</code>
* or <code>remove</code> operations associated with the deployment plan
* should be rolled back in case of a failure in any of them.
*
* @return <code>true</code> if all operations should be rolled back if
* any of them fail
*/
boolean isGlobalRollback();
/**
* Gets whether the deployment plan is organized around a shutdown of the server.
*
* @return <code>true</code> if the plan will be organized around a shutdown,
* <code>false</code> otherwise
*/
boolean isShutdown();
/**
* Gets whether the deployment plan is organized around
* a graceful shutdown of the server, where potentially long-running in-process
* work is given time to complete before shutdown proceeds.
*
* @return <code>true</code> if the plan will be organized around a graceful shutdown,
* <code>false</code> otherwise
*/
boolean isGracefulShutdown();
/**
* Gets the maximum period, in ms, the deployment plan is configured to
* wait for potentially long-running in-process work ito complete before
* shutdown proceeds.
*
* @return the period in ms, or <code>-1</code> if {@link #isGracefulShutdown()}
* would return <code>true</code>
*/
long getGracefulShutdownTimeout();
}