org.jboss.as.plugin.Undeploy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-as-deploy-plugin
The newest version!
/*
 * 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.plugin;

import java.io.IOException;

import org.jboss.as.controller.client.helpers.standalone.DeploymentPlan;
import org.jboss.as.controller.client.helpers.standalone.DeploymentPlanBuilder;

/**
 * Undeploys the archived result of the project from application server.
 * 
 * Example Usage: {@literal
 *    
 *        
 *            ...
 *            
 *                org.jboss.as.plugins
 *                jboss-as-deploy-plugin
 *                1.0.0-SNAPSHOT
 *                
 *                    
 *                        package
 *                        
 *                            undeploy
 *                        
 *                    
 *                
 *            
 *            ...
 *        
 *    
 * }
 * 
 * 
 * @goal undeploy
 * 
 * @author James R. Perkins Jr. (jrp)
 */
public final class Undeploy extends AbstractDeployment {

    @Override
    public DeploymentPlan createPlan(final DeploymentPlanBuilder builder) throws IOException {
        DeploymentPlan plan = null;
        if (name() == null) {
            plan = builder.undeploy(filename()).remove(filename()).build();
        } else {
            plan = builder.undeploy(name()).remove(name()).build();
        }
        return plan;
    }

    @Override
    public String goal() {
        return "undeploy";
    }

}