org.apache.maven.wagon.providers.ssh.sshapi

Class ScpWagon

java.lang.Object

org.apache.maven.wagon.AbstractWagon

org.apache.maven.wagon.StreamWagon

org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

org.apache.maven.wagon.providers.ssh.sshapi.ScpWagon

All Implemented Interfaces:

org.apache.maven.wagon.CommandExecutor, org.apache.maven.wagon.providers.ssh.SshWagon, org.apache.maven.wagon.StreamingWagon, org.apache.maven.wagon.Wagon

Direct Known Subclasses:

ScpCommandExecutor

public class ScpWagon
extends AbstractSSHAPIWagon

SCP protocol wagon.

Note that this implementation is not thread-safe, and multiple channels can not be used on the session at the same time.

See http://blogs.sun.com/janp/entry/how_the_scp_protocol_works for information on how the SCP protocol works.

Version:

$Id: ScpWagon.java 1174063 2011-09-22 11:22:43Z olamy $

Field Summary

Fields inherited from class org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

EXEC_CHANNEL, session, sshTool

Fields inherited from class org.apache.maven.wagon.AbstractWagon

authenticationInfo, DEFAULT_BUFFER_SIZE, interactive, proxyInfo, repository, sessionEventSupport, transferEventSupport

Fields inherited from interface org.apache.maven.wagon.CommandExecutor

ROLE

Fields inherited from interface org.apache.maven.wagon.Wagon

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ScpWagon()

Method Summary

Modifier and Type	Method and Description
protected void	cleanupGetTransfer(org.apache.maven.wagon.resource.Resource resource)
protected void	cleanupPutTransfer(org.apache.maven.wagon.resource.Resource resource)
void	fillInputData(org.apache.maven.wagon.InputData inputData)
void	fillOutputData(org.apache.maven.wagon.OutputData outputData)
protected void	finishGetTransfer(org.apache.maven.wagon.resource.Resource resource, java.io.InputStream input, java.io.OutputStream output)
protected void	finishPutTransfer(org.apache.maven.wagon.resource.Resource resource, java.io.InputStream input, java.io.OutputStream output)
java.lang.String	getOctalMode(org.apache.maven.wagon.repository.RepositoryPermissions permissions) Get the octal mode given a RepositoryPermissions.
protected void	getTransfer(org.apache.maven.wagon.resource.Resource resource, java.io.OutputStream output, java.io.InputStream input, boolean closeInput, int maxSize)
protected java.lang.String	readLine(java.io.InputStream in)
protected static void	sendEom(java.io.OutputStream out)

Methods inherited from class org.apache.maven.wagon.providers.ssh.sshapi.AbstractSSHAPIWagon

closeConnection, executeCommand, executeCommand, getFileList, getInteractiveUserInfo, getKnownHostsProvider, handleGetException, openConnectionInternal, putDirectory, resourceExists, setInteractiveUserInfo, setKnownHostsProvider, supportsDirectoryCopy

Methods inherited from class org.apache.maven.wagon.StreamWagon

checkInputStream, checkOutputStream, get, getIfNewer, getIfNewerToStream, getInputStream, getOutputStream, getToStream, put, putFromStream, putFromStream, putFromStream

Methods inherited from class org.apache.maven.wagon.AbstractWagon

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, fireGetCompleted, fireGetInitiated, fireGetStarted, firePutCompleted, firePutInitiated, firePutStarted, fireSessionConnectionRefused, fireSessionDebug, fireSessionDisconnected, fireSessionDisconnecting, fireSessionError, fireSessionLoggedIn, fireSessionLoggedOff, fireSessionOpened, fireSessionOpening, fireTransferDebug, fireTransferError, fireTransferProgress, getAuthenticationInfo, getPath, getPermissionsOverride, getProxyInfo, getProxyInfo, getReadTimeout, getRepository, getSessionEventSupport, getTimeout, getTransfer, getTransfer, getTransfer, getTransfer, getTransfer, getTransferEventSupport, hasSessionListener, hasTransferListener, isInteractive, openConnection, postProcessListeners, putTransfer, putTransfer, removeSessionListener, removeTransferListener, setInteractive, setPermissionsOverride, setReadTimeout, setSessionEventSupport, setTimeout, setTransferEventSupport, transfer, transfer, transfer, transfer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.wagon.Wagon

addSessionListener, addTransferListener, connect, connect, connect, connect, connect, connect, disconnect, get, getIfNewer, getReadTimeout, getRepository, getTimeout, hasSessionListener, hasTransferListener, isInteractive, openConnection, put, removeSessionListener, removeTransferListener, setInteractive, setReadTimeout, setTimeout

Constructor Detail

ScpWagon

public ScpWagon()

Method Detail

cleanupPutTransfer

protected void cleanupPutTransfer(org.apache.maven.wagon.resource.Resource resource)

Overrides:

cleanupPutTransfer in class org.apache.maven.wagon.AbstractWagon

finishPutTransfer

protected void finishPutTransfer(org.apache.maven.wagon.resource.Resource resource,
                                 java.io.InputStream input,
                                 java.io.OutputStream output)
                          throws org.apache.maven.wagon.TransferFailedException

Overrides:

finishPutTransfer in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

finishGetTransfer

protected void finishGetTransfer(org.apache.maven.wagon.resource.Resource resource,
                                 java.io.InputStream input,
                                 java.io.OutputStream output)
                          throws org.apache.maven.wagon.TransferFailedException

Overrides:

finishGetTransfer in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

cleanupGetTransfer

protected void cleanupGetTransfer(org.apache.maven.wagon.resource.Resource resource)

Overrides:

cleanupGetTransfer in class org.apache.maven.wagon.AbstractWagon

getTransfer

protected void getTransfer(org.apache.maven.wagon.resource.Resource resource,
                           java.io.OutputStream output,
                           java.io.InputStream input,
                           boolean closeInput,
                           int maxSize)
                    throws org.apache.maven.wagon.TransferFailedException

Overrides:

getTransfer in class org.apache.maven.wagon.AbstractWagon

Throws:

org.apache.maven.wagon.TransferFailedException

readLine

protected java.lang.String readLine(java.io.InputStream in)
                             throws java.io.IOException

Throws:

java.io.IOException

sendEom

protected static void sendEom(java.io.OutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

fillInputData

public void fillInputData(org.apache.maven.wagon.InputData inputData)
                   throws org.apache.maven.wagon.TransferFailedException,
                          org.apache.maven.wagon.ResourceDoesNotExistException

Specified by:

fillInputData in class org.apache.maven.wagon.StreamWagon

Throws:

org.apache.maven.wagon.TransferFailedException

org.apache.maven.wagon.ResourceDoesNotExistException

fillOutputData

public void fillOutputData(org.apache.maven.wagon.OutputData outputData)
                    throws org.apache.maven.wagon.TransferFailedException

Specified by:

fillOutputData in class org.apache.maven.wagon.StreamWagon

Throws:

org.apache.maven.wagon.TransferFailedException

getOctalMode

public java.lang.String getOctalMode(org.apache.maven.wagon.repository.RepositoryPermissions permissions)

Get the octal mode given a RepositoryPermissions.

Parameters:

permissions - permissions

Returns:

octal code