AbstractJschWagon (Apache Maven Wagon :: Providers

java.lang.Object
- org.apache.maven.wagon.AbstractWagon
- - org.apache.maven.wagon.StreamWagon
  - - org.apache.maven.wagon.providers.ssh.jsch.AbstractJschWagon

All Implemented Interfaces:

CommandExecutor, SshWagon, StreamingWagon, Wagon

Direct Known Subclasses:

ScpWagon, SftpWagon
```
public abstract class AbstractJschWagon
extends StreamWagon
implements SshWagon, CommandExecutor
```
AbstractJschWagon

Field Summary

Fields
Modifier and Type Field and Description

protected static String EXEC_CHANNEL

protected com.jcraft.jsch.Session session

protected ScpHelper 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

Fields
Modifier and Type	Field and Description
`protected static String`	`EXEC_CHANNEL`
`protected com.jcraft.jsch.Session`	`session`
`protected ScpHelper`	`sshTool`

Constructor Summary

Constructors
Constructor and Description

AbstractJschWagon()

Constructors
Constructor and Description
`AbstractJschWagon()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeConnection()`
`void`	`executeCommand(String command)`
`Streams`	`executeCommand(String command, boolean ignoreFailures)`
`List<String>`	`getFileList(String destinationDirectory)`
`InteractiveUserInfo`	`getInteractiveUserInfo()`
`KnownHostsProvider`	`getKnownHostsProvider()`
`protected void`	`handleGetException(Resource resource, Exception e)`
`void`	`openConnectionInternal()`
`void`	`putDirectory(File sourceDirectory, String destinationDirectory)`
`boolean`	`resourceExists(String resourceName)`
`void`	`setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)`
`void`	`setKnownHostsProvider(KnownHostsProvider knownHostsProvider)`
`void`	`setUIKeyboardInteractive(com.jcraft.jsch.UIKeyboardInteractive uIKeyboardInteractive)`
`boolean`	`supportsDirectoryCopy()`

Methods inherited from class org.apache.maven.wagon.StreamWagon
checkInputStream, checkOutputStream, fillInputData, fillOutputData, get, getIfNewer, getIfNewerToStream, getInputStream, getOutputStream, getToStream, put, putFromStream, putFromStream, putFromStream

Methods inherited from class org.apache.maven.wagon.AbstractWagon
addSessionListener, addTransferListener, cleanupGetTransfer, cleanupPutTransfer, connect, connect, connect, connect, connect, connect, createParentDirectories, disconnect, finishGetTransfer, finishPutTransfer, 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, 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

Field Detail

sshTool
```
protected ScpHelper sshTool
```

session

protected com.jcraft.jsch.Session session

EXEC_CHANNEL

protected static final String EXEC_CHANNEL

See Also:: Constant Field Values

Constructor Detail
- AbstractJschWagon
```
public AbstractJschWagon()
```

Method Detail

openConnectionInternal
```
public void openConnectionInternal()
                            throws AuthenticationException
```
Specified by:

openConnectionInternal in class AbstractWagon

Throws:

AuthenticationException

closeConnection
```
public void closeConnection()
```
Specified by:

closeConnection in class StreamWagon

executeCommand

public Streams executeCommand(String command,
                     boolean ignoreFailures)
                       throws CommandExecutionException

Specified by:: executeCommand in interface CommandExecutor
Throws:: CommandExecutionException

handleGetException

protected void handleGetException(Resource resource,
                      Exception e)
                           throws TransferFailedException

Throws:: TransferFailedException

getFileList

public List<String> getFileList(String destinationDirectory)
                         throws TransferFailedException,
                                ResourceDoesNotExistException,
                                AuthorizationException

Specified by:: getFileList in interface Wagon
Overrides:: getFileList in class AbstractWagon
Throws:: TransferFailedException; ResourceDoesNotExistException; AuthorizationException

putDirectory

public void putDirectory(File sourceDirectory,
                String destinationDirectory)
                  throws TransferFailedException,
                         ResourceDoesNotExistException,
                         AuthorizationException

Specified by:: putDirectory in interface Wagon
Overrides:: putDirectory in class AbstractWagon
Throws:: TransferFailedException; ResourceDoesNotExistException; AuthorizationException

resourceExists

public boolean resourceExists(String resourceName)
                       throws TransferFailedException,
                              AuthorizationException

Specified by:: resourceExists in interface Wagon
Overrides:: resourceExists in class AbstractWagon
Throws:: TransferFailedException; AuthorizationException

supportsDirectoryCopy
```
public boolean supportsDirectoryCopy()
```
Specified by:

supportsDirectoryCopy in interface Wagon

Overrides:

supportsDirectoryCopy in class AbstractWagon

executeCommand

public void executeCommand(String command)
                    throws CommandExecutionException

Specified by:: executeCommand in interface CommandExecutor
Throws:: CommandExecutionException

getInteractiveUserInfo

public InteractiveUserInfo getInteractiveUserInfo()

getKnownHostsProvider

public KnownHostsProvider getKnownHostsProvider()

setInteractiveUserInfo

public void setInteractiveUserInfo(InteractiveUserInfo interactiveUserInfo)

setKnownHostsProvider

public void setKnownHostsProvider(KnownHostsProvider knownHostsProvider)

Specified by:: setKnownHostsProvider in interface SshWagon

setUIKeyboardInteractive

public void setUIKeyboardInteractive(com.jcraft.jsch.UIKeyboardInteractive uIKeyboardInteractive)

Class AbstractJschWagon

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

sshTool

session

EXEC_CHANNEL

Constructor Detail

AbstractJschWagon

Method Detail

openConnectionInternal

closeConnection

executeCommand

handleGetException

getFileList

putDirectory

resourceExists

supportsDirectoryCopy

executeCommand

getInteractiveUserInfo

getKnownHostsProvider

setInteractiveUserInfo

setKnownHostsProvider

setUIKeyboardInteractive