Overview Package Class Use Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.sshtools.common.configuration

Class SshToolsConnectionProfile

public class SshToolsConnectionProfile
extends SshConnectionProperties
Version:
$Revision: 1.22 $
Author:
$author$

Field Summary

static int
DO_NOTHING
static int
EXECUTE_COMMANDS
static int
START_SHELL

Fields inherited from class com.sshtools.j2ssh.configuration.SshConnectionProperties

USE_HTTP_PROXY, USE_SOCKS4_PROXY, USE_SOCKS5_PROXY, USE_STANDARD_SOCKET, forwardingAutoStart, host, localForwardings, port, prefDecryption, prefEncryption, prefKex, prefPK, prefRecvComp, prefRecvMac, prefSendComp, prefSendMac, proxyHostname, proxyPassword, proxyPort, proxyUsername, remoteForwardings, transportProvider, username

Constructor Summary

SshToolsConnectionProfile()
Creates a new SshToolsConnectionProfile object.

Method Summary

void
addAuthenticationMethod(SshAuthenticationClient method)
void
addLocalForwarding(ForwardingConfiguration config)
void
addRemoteForwarding(ForwardingConfiguration config)
void
clearAuthenticationCache()
boolean
disconnectOnSessionClose()
boolean
getAllowAgentForwarding()
String
getApplicationProperty(String name, String defaultValue)
boolean
getApplicationPropertyBoolean(String name, boolean defaultValue)
Color
getApplicationPropertyColor(String name, Color defaultColor)
int
getApplicationPropertyInt(String name, int defaultValue)
Map
getAuthenticationMethods()
String
getCommandsToExecute()
int
getOnceAuthenticatedCommand()
Map
getSftpFavorites()
void
open(File file)
void
open(InputStream in)
void
open(String file)
void
removeAuthenticaitonMethod(String method)
void
removeAuthenticationMethods()
void
removeLocalForwarding(String name)
void
removeRemoteForwarding(String name)
boolean
requiresPseudoTerminal()
void
save()
void
save(String file)
void
setAllowAgentForwarding(boolean allowAgentForwarding)
void
setApplicationProperty(String name, Color value)
void
setApplicationProperty(String name, String value)
void
setApplicationProperty(String name, boolean value)
void
setApplicationProperty(String name, int value)
void
setCommandsToExecute(String executeCommands)
void
setDisconnectOnSessionClose(boolean disconnectOnSessionClose)
void
setOnceAuthenticatedCommand(int onceAuthenticated)
void
setRequiresPseudoTerminal(boolean requiresPseudoTerminal)
void
setSftpFavorite(String name, String value)
String
toString()

Methods inherited from class com.sshtools.j2ssh.configuration.SshConnectionProperties

addLocalForwarding, addRemoteForwarding, getForwardingAutoStartMode, getHost, getLocalForwardings, getPort, getPrefCSComp, getPrefCSEncryption, getPrefCSMac, getPrefKex, getPrefPublicKey, getPrefSCComp, getPrefSCEncryption, getPrefSCMac, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getRemoteForwardings, getTransportProvider, getTransportProviderString, getUsername, removeAllForwardings, setForwardingAutoStartMode, setHost, setPort, setPrefCSComp, setPrefCSEncryption, setPrefCSMac, setPrefKex, setPrefPublicKey, setPrefSCComp, setPrefSCEncryption, setPrefSCMac, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setTransportProvider, setTransportProviderString, setUsername

Field Details

DO_NOTHING

public static final int DO_NOTHING
Field Value:
1

EXECUTE_COMMANDS

public static final int EXECUTE_COMMANDS
Field Value:
3

START_SHELL

public static final int START_SHELL
Field Value:
2

Constructor Details

SshToolsConnectionProfile

public SshToolsConnectionProfile()
Creates a new SshToolsConnectionProfile object.

Method Details

addAuthenticationMethod

public void addAuthenticationMethod(SshAuthenticationClient method)
Parameters:
method -

addLocalForwarding

public void addLocalForwarding(ForwardingConfiguration config)
Overrides:
addLocalForwarding in interface SshConnectionProperties
Parameters:
config -

addRemoteForwarding

public void addRemoteForwarding(ForwardingConfiguration config)
Overrides:
addRemoteForwarding in interface SshConnectionProperties
Parameters:
config -

clearAuthenticationCache

public void clearAuthenticationCache()

disconnectOnSessionClose

public boolean disconnectOnSessionClose()
Returns:

getAllowAgentForwarding

public boolean getAllowAgentForwarding()
Returns:

getApplicationProperty

public String getApplicationProperty(String name,
                                     String defaultValue)
Parameters:
name -
defaultValue -
Returns:

getApplicationPropertyBoolean

public boolean getApplicationPropertyBoolean(String name,
                                             boolean defaultValue)
Parameters:
name -
defaultValue -
Returns:

getApplicationPropertyColor

public Color getApplicationPropertyColor(String name,
                                         Color defaultColor)
Parameters:
name -
defaultColor -
Returns:

getApplicationPropertyInt

public int getApplicationPropertyInt(String name,
                                     int defaultValue)
Parameters:
name -
defaultValue -
Returns:

getAuthenticationMethods

public Map getAuthenticationMethods()
Returns:

getCommandsToExecute

public String getCommandsToExecute()
Returns:

getOnceAuthenticatedCommand

public int getOnceAuthenticatedCommand()
Returns:

getSftpFavorites

public Map getSftpFavorites()
Parameters:
Returns:

open

public void open(File file)
            throws InvalidProfileFileException
Parameters:
file -
Throws:
InvalidProfileFileException -

open

public void open(InputStream in)
            throws InvalidProfileFileException
Parameters:
in -
Throws:
InvalidProfileFileException -

open

public void open(String file)
            throws InvalidProfileFileException
Parameters:
file -
Throws:
InvalidProfileFileException -

removeAuthenticaitonMethod

public void removeAuthenticaitonMethod(String method)
Parameters:
method -

removeAuthenticationMethods

public void removeAuthenticationMethods()

removeLocalForwarding

public void removeLocalForwarding(String name)
Parameters:
name -

removeRemoteForwarding

public void removeRemoteForwarding(String name)
Parameters:
name -

requiresPseudoTerminal

public boolean requiresPseudoTerminal()
Returns:

save

public void save()
            throws InvalidProfileFileException

save

public void save(String file)
            throws InvalidProfileFileException
Parameters:
file -
Throws:
InvalidProfileFileException -

setAllowAgentForwarding

public void setAllowAgentForwarding(boolean allowAgentForwarding)
Parameters:
allowAgentForwarding -

setApplicationProperty

public void setApplicationProperty(String name,
                                   Color value)
Parameters:
name -
value -

setApplicationProperty

public void setApplicationProperty(String name,
                                   String value)
Parameters:
name -
value -

setApplicationProperty

public void setApplicationProperty(String name,
                                   boolean value)
Parameters:
name -
value -

setApplicationProperty

public void setApplicationProperty(String name,
                                   int value)
Parameters:
name -
value -

setCommandsToExecute

public void setCommandsToExecute(String executeCommands)
Parameters:
executeCommands -

setDisconnectOnSessionClose

public void setDisconnectOnSessionClose(boolean disconnectOnSessionClose)
Parameters:
disconnectOnSessionClose -

setOnceAuthenticatedCommand

public void setOnceAuthenticatedCommand(int onceAuthenticated)
Parameters:
onceAuthenticated -

setRequiresPseudoTerminal

public void setRequiresPseudoTerminal(boolean requiresPseudoTerminal)
Parameters:
requiresPseudoTerminal -

setSftpFavorite

public void setSftpFavorite(String name,
                            String value)
Parameters:
name -

toString

public String toString()
Returns:

Overview Package Class Use Index Deprecated About
Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.