org.codehaus.mojo.wagon.SshExecMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wagon-maven-plugin Show documentation

Maven plugin that can be used to access various operations on a given URL using a supported maven wagon. Supports recursive upload, download, and list directory content functionality.

The newest version!

package org.codehaus.mojo.wagon;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.wagon.CommandExecutor;
import org.apache.maven.wagon.Streams;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.WagonException;
import org.apache.maven.wagon.providers.ssh.jsch.AbstractJschWagon;

/**
 * Executes a list of commands against a given server.
 */
@Mojo( name = "sshexec")
public class SshExecMojo
    extends AbstractSingleWagonMojo
{

    /**
     * The commands that we will execute.
     */
    @Parameter(required = true)
    private String[] commands;

    /**
     * Allow option not to fail the build on error.
     */
    @Parameter(defaultValue = "true")
    private boolean failOnError = true;

    /**
     * Option to display remote command's outputs.
     */
    @Parameter(defaultValue = "false")
    private boolean displayCommandOutputs = true;

    @Override
    protected void execute( final Wagon wagon )
        throws MojoExecutionException
    {
        if ( commands != null )
        {
            for ( String command : commands )
            {
                try
                {
                    Streams stream;
                    if ( wagon instanceof AbstractJschWagon )
                    {
                        stream = ( (AbstractJschWagon) wagon ).executeCommand( command, true, false );
                    } else
                    {
                        stream = ( (CommandExecutor) wagon ).executeCommand( command, false );
                    }
                    this.getLog().info( "sshexec: " + command + " ..." );
                    if ( displayCommandOutputs )
                    {
                        System.out.println( stream.getOut() );
                        System.out.println( stream.getErr() );
                    }
                } catch ( final WagonException e )
                {
                    if ( this.failOnError )
                    {
                        throw new MojoExecutionException( "Unable to execute remote command", e );
                    }
                    else
                    {
                        this.getLog().warn( e );
                    }
                }

            }
        }
    }
}