org.pentaho.di.trans.steps.ssh.SSH Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kettle-engine Show documentation
Show all versions of kettle-engine Show documentation
Container pom for Pentaho Data Integration modules
The newest version!
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2017 by Hitachi Vantara : http://www.pentaho.com
*
*******************************************************************************
*
* Licensed 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.
*
******************************************************************************/
package org.pentaho.di.trans.steps.ssh;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.row.RowMeta;
import org.pentaho.di.core.row.RowMetaInterface;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.trans.Trans;
import org.pentaho.di.trans.TransMeta;
import org.pentaho.di.trans.step.BaseStep;
import org.pentaho.di.trans.step.StepDataInterface;
import org.pentaho.di.trans.step.StepInterface;
import org.pentaho.di.trans.step.StepMeta;
import org.pentaho.di.trans.step.StepMetaInterface;
import com.trilead.ssh2.Session;
/**
* Write commands to SSH *
*
* @author Samatar
* @since 03-Juin-2008
*
*/
public class SSH extends BaseStep implements StepInterface {
private static Class PKG = SSHMeta.class; // for i18n purposes, needed by Translator2!!
private SSHMeta meta;
private SSHData data;
public SSH( StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans ) {
super( stepMeta, stepDataInterface, copyNr, transMeta, trans );
}
@Override
public boolean processRow( StepMetaInterface smi, StepDataInterface sdi ) throws KettleException {
meta = (SSHMeta) smi;
data = (SSHData) sdi;
Object[] row;
if ( meta.isDynamicCommand() ) {
row = getRow();
if ( row == null ) {
setOutputDone();
return false;
}
if ( first ) {
first = false;
data.outputRowMeta = getInputRowMeta().clone();
data.nrInputFields = data.outputRowMeta.size();
meta.getFields( data.outputRowMeta, getStepname(), null, null, this, repository, metaStore );
data.nrOutputFields = data.outputRowMeta.size();
// Check if commands field is provided
if ( meta.isDynamicCommand() ) {
if ( Utils.isEmpty( meta.getcommandfieldname() ) ) {
throw new KettleException( BaseMessages.getString( PKG, "SSH.Error.CommandFieldMissing" ) );
}
// cache the position of the source filename field
data.indexOfCommand = data.outputRowMeta.indexOfValue( meta.getcommandfieldname() );
if ( data.indexOfCommand < 0 ) {
// The field is unreachable !
throw new KettleException( BaseMessages.getString( PKG, "SSH.Exception.CouldnotFindField", meta
.getcommandfieldname() ) );
}
}
}
} else {
if ( !data.wroteOneRow ) {
row = new Object[] {}; // empty row
incrementLinesRead();
data.wroteOneRow = true;
if ( first ) {
first = false;
data.outputRowMeta = new RowMeta();
data.nrInputFields = 0;
meta.getFields( data.outputRowMeta, getStepname(), null, null, this, repository, metaStore );
data.nrOutputFields = data.outputRowMeta.size();
data.commands = environmentSubstitute( meta.getCommand() );
}
} else {
setOutputDone(); // signal end to receiver(s)
return false;
}
}
RowMetaInterface imeta = getInputRowMeta();
if ( imeta == null ) {
imeta = new RowMeta();
this.setInputRowMeta( imeta );
}
// Reserve room
Object[] rowData = new Object[data.nrOutputFields];
for ( int i = 0; i < data.nrInputFields; i++ ) {
rowData[i] = row[i]; // no data is changed, clone is not needed here.
}
int index = data.nrInputFields;
Session session = null;
try {
if ( meta.isDynamicCommand() ) {
// get commands
data.commands = data.outputRowMeta.getString( row, data.indexOfCommand );
if ( Utils.isEmpty( data.commands ) ) {
throw new KettleException( BaseMessages.getString( PKG, "SSH.Error.MessageEmpty" ) );
}
}
// Open a session
session = data.conn.openSession();
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "SSH.Log.SessionOpened" ) );
}
// execute commands
if ( log.isDetailed() ) {
logDetailed( BaseMessages.getString( PKG, "SSH.Log.RunningCommand", data.commands ) );
}
session.execCommand( data.commands );
// Read Stdout, Sterr and exitStatus
SessionResult sessionresult = new SessionResult( session );
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "SSH.Log.CommandRunnedCommand", data.commands, sessionresult
.getStdOut(), sessionresult.getStdErr() ) );
}
// Add stdout to output
rowData[index++] = sessionresult.getStd();
if ( !Utils.isEmpty( data.stdTypeField ) ) {
// Add stdtype to output
rowData[index++] = sessionresult.isStdTypeErr();
}
if ( log.isRowLevel() ) {
logRowlevel( BaseMessages.getString( PKG, "SSH.Log.OutputLine", data.outputRowMeta.getString( rowData ) ) );
}
putRow( data.outputRowMeta, rowData );
if ( checkFeedback( getLinesRead() ) ) {
if ( log.isDetailed() ) {
logDetailed( BaseMessages.getString( PKG, "SSH.LineNumber", "" + getLinesRead() ) );
}
}
} catch ( Exception e ) {
boolean sendToErrorRow = false;
String errorMessage = null;
if ( getStepMeta().isDoingErrorHandling() ) {
sendToErrorRow = true;
errorMessage = e.toString();
} else {
logError( BaseMessages.getString( PKG, "SSH.ErrorInStepRunning" ) + e.getMessage() );
setErrors( 1 );
stopAll();
setOutputDone(); // signal end to receiver(s)
return false;
}
if ( sendToErrorRow ) {
// Simply add this row to the error row
putError( getInputRowMeta(), row, 1, errorMessage, null, "SSH001" );
}
} finally {
if ( session != null ) {
session.close();
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "SSH.Log.SessionClosed" ) );
}
}
}
return true;
}
@Override
public boolean init( StepMetaInterface smi, StepDataInterface sdi ) {
meta = (SSHMeta) smi;
data = (SSHData) sdi;
if ( super.init( smi, sdi ) ) {
String servername = environmentSubstitute( meta.getServerName() );
int nrPort = Const.toInt( environmentSubstitute( meta.getPort() ), 22 );
String username = environmentSubstitute( meta.getuserName() );
String password = Utils.resolvePassword( variables, meta.getpassword() );
String keyFilename = environmentSubstitute( meta.getKeyFileName() );
String passphrase = environmentSubstitute( meta.getPassphrase() );
int timeOut = Const.toInt( environmentSubstitute( meta.getTimeOut() ), 0 );
String proxyhost = environmentSubstitute( meta.getProxyHost() );
int proxyport = Const.toInt( environmentSubstitute( meta.getProxyPort() ), 0 );
String proxyusername = environmentSubstitute( meta.getProxyUsername() );
String proxypassword = environmentSubstitute( meta.getProxyPassword() );
// Check target server
if ( Utils.isEmpty( servername ) ) {
logError( BaseMessages.getString( PKG, "SSH.MissingServerName" ) );
}
// Check if username field is provided
if ( Utils.isEmpty( meta.getuserName() ) ) {
logError( BaseMessages.getString( PKG, "SSH.Error.UserNamedMissing" ) );
return false;
}
// Get output fields
data.stdOutField = environmentSubstitute( meta.getStdOutFieldName() );
if ( Utils.isEmpty( data.stdOutField ) ) {
logError( BaseMessages.getString( PKG, "SSH.Error.StdOutFieldNameMissing" ) );
return false;
}
data.stdTypeField = environmentSubstitute( meta.getStdErrFieldName() );
try {
// Open connection
data.conn =
SSHData.OpenConnection(
servername, nrPort, username, password, meta.isusePrivateKey(), keyFilename, passphrase, timeOut,
this, proxyhost, proxyport, proxyusername, proxypassword );
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "SSH.Log.ConnectionOpened" ) );
}
} catch ( Exception e ) {
logError( BaseMessages.getString( PKG, "SSH.Error.OpeningConnection", e.getMessage() ) );
return false;
}
return true;
}
return false;
}
@Override
public void dispose( StepMetaInterface smi, StepDataInterface sdi ) {
meta = (SSHMeta) smi;
data = (SSHData) sdi;
if ( data.conn != null ) {
data.conn.close();
if ( log.isDebug() ) {
logDebug( BaseMessages.getString( PKG, "SSH.Log.ConnectionClosed" ) );
}
}
super.dispose( smi, sdi );
}
}