protoj.lang
Class ScpFeature

java.lang.Object
  extended by protoj.lang.ScpFeature

public final class ScpFeature
extends java.lang.Object

This feature is used to remotely copy the project archive generated by ProjectArchive.

Author:
Ashley Williams

Constructor Summary
ScpFeature(StandardProject project)
          Creates an instance with the owning parent project and also the plug-in runnable responsible for further configuration.
 
Method Summary
 void copyProjectArchive(java.lang.String toDir, java.lang.String password)
          Copies the project tar file to the remote location using simple password authentication.
 void copyProjectArchive(java.lang.String toDir, java.lang.String passphrase, java.lang.String keyFile)
          Copies the project tar file to the remote location using key based authentication.
 org.apache.tools.ant.taskdefs.optional.ssh.Scp getAntScp()
          The underlying scp ant object for fine grained customization.
 java.lang.String getKeyFile()
          The location of the private key when key based authentication is used.
 StandardProject getProject()
          The parent project of this feature.
 java.lang.String getToDir()
          The toDir of the remote machine.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScpFeature

public ScpFeature(StandardProject project)
Creates an instance with the owning parent project and also the plug-in runnable responsible for further configuration.

Parameters:
project -
Method Detail

copyProjectArchive

public void copyProjectArchive(java.lang.String toDir,
                               java.lang.String password)
Copies the project tar file to the remote location using simple password authentication. The toDir parameter takes the form @:.

Parameters:
toDir -
password -

copyProjectArchive

public void copyProjectArchive(java.lang.String toDir,
                               java.lang.String passphrase,
                               java.lang.String keyFile)
Copies the project tar file to the remote location using key based authentication. The toDir parameter takes the form @:.

Parameters:
toDir -
passphrase -
keyFile -

getProject

public StandardProject getProject()
The parent project of this feature.

Returns:

getAntScp

public org.apache.tools.ant.taskdefs.optional.ssh.Scp getAntScp()
The underlying scp ant object for fine grained customization.

Returns:

getToDir

public java.lang.String getToDir()
The toDir of the remote machine.

Returns:

getKeyFile

public java.lang.String getKeyFile()
The location of the private key when key based authentication is used.

Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object