org.apache.camel.component.ssh

Class SshComponent

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultComponent

org.apache.camel.component.ssh.SshComponent

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@Component(value="ssh")
public class SshComponent
extends org.apache.camel.support.DefaultComponent

Represents the component that manages SshEndpoint.

Field Summary

Fields inherited from class org.apache.camel.support.service.ServiceSupport

BUILDED, FAILED, INITIALIZED, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
SshComponent()

Method Summary

Modifier and Type	Method and Description
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
String	getCertResource()
String	getCertResourcePassword()
SshConfiguration	getConfiguration()
String	getHost()
org.apache.sshd.common.keyprovider.KeyPairProvider	getKeyPairProvider()
String	getKeyType()
String	getPassword()
String	getPollCommand()
int	getPort()
long	getTimeout()
String	getUsername()
void	setCertResource(String certResource) Sets the resource path of the certificate to use for Authentication.
void	setCertResourcePassword(String certResourcePassword) Sets the password to use in loading certResource, if certResource is an encrypted key.
void	setChannelType(String channelType) Sets the channel type to pass to the Channel as part of command execution.
void	setConfiguration(SshConfiguration configuration) To use the shared SSH configuration
void	setHost(String host) Sets the hostname of the remote SSH server.
void	setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider) Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
void	setKeyType(String keyType) Sets the key type to pass to the KeyPairProvider as part of authentication.
void	setPassword(String password) Sets the password to use in connecting to remote SSH server.
void	setPollCommand(String pollCommand) Sets the command string to send to the remote SSH server during every poll cycle.
void	setPort(int port) Sets the port number for the remote SSH server.
void	setShellPrompt(String shellPrompt) Sets the shellPrompt to be dropped when response is read after command execution
void	setSleepForShellPrompt(long sleepForShellPrompt) Sets the sleep period in milliseconds to wait reading response from shell prompt.
void	setTimeout(long timeout) Sets the timeout in milliseconds to wait in establishing the remote SSH server connection.
void	setUsername(String username) Sets the username to use in logging into the remote SSH server.

Methods inherited from class org.apache.camel.support.DefaultComponent

afterConfiguration, createEndpoint, createEndpoint, doInit, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

Methods inherited from class org.apache.camel.support.service.ServiceSupport

build, doBuild, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Component

trySetComponent

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Constructor Detail

SshComponent

public SshComponent()

Method Detail

createEndpoint

protected org.apache.camel.Endpoint createEndpoint(String uri,
                                                   String remaining,
                                                   Map<String,Object> parameters)
                                            throws Exception

Specified by:

createEndpoint in class org.apache.camel.support.DefaultComponent

Throws:

Exception

getConfiguration

public SshConfiguration getConfiguration()

setConfiguration

public void setConfiguration(SshConfiguration configuration)

To use the shared SSH configuration

getHost

public String getHost()

setHost

public void setHost(String host)

Sets the hostname of the remote SSH server.

Parameters:

host - String representing hostname of SSH server.

getPort

public int getPort()

setPort

public void setPort(int port)

Sets the port number for the remote SSH server.

Parameters:

port - int representing port number on remote host. Defaults to 22.

getUsername

public String getUsername()

setUsername

@Metadata(label="security",
          secret=true)
public void setUsername(String username)

Sets the username to use in logging into the remote SSH server.

Parameters:

username - String representing login username.

getPassword

public String getPassword()

setPassword

@Metadata(label="security",
          secret=true)
public void setPassword(String password)

Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.

Parameters:

password - String representing password for username at remote host.

getPollCommand

public String getPollCommand()

setPollCommand

public void setPollCommand(String pollCommand)

Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from("ssh://..."). You may need to end your command with a newline, and that must be URL encoded %0A

Parameters:

pollCommand - String representing the command to send.

getKeyPairProvider

public org.apache.sshd.common.keyprovider.KeyPairProvider getKeyPairProvider()

setKeyPairProvider

@Metadata(label="security")
public void setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)

Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.

Parameters:

keyPairProvider - KeyPairProvider reference to use in authenticating. If set to 'null', then will attempt to connect using username/password settings.

See Also:

KeyPairProvider

getKeyType

public String getKeyType()

setKeyType

@Metadata(label="security")
public void setKeyType(String keyType)

Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to "ssh-rsa".

Parameters:

keyType - String defining the type of KeyPair to use for authentication.

See Also:

KeyPairProvider

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.

Parameters:

timeout - long milliseconds to wait.

getCertResource

public String getCertResource()

setCertResource

@Metadata(label="security")
public void setCertResource(String certResource)

Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting.

Parameters:

certResource - String file, classpath, or http url for the certificate

getCertResourcePassword

public String getCertResourcePassword()

setCertResourcePassword

@Metadata(label="security",
          secret=true)
public void setCertResourcePassword(String certResourcePassword)

Sets the password to use in loading certResource, if certResource is an encrypted key.

Parameters:

certResourcePassword - String representing password use to load the certResource key

setChannelType

@Metadata(label="advanced")
public void setChannelType(String channelType)

Sets the channel type to pass to the Channel as part of command execution. Defaults to "exec".

Parameters:

channelType - String defining the type of Channel to use for command execution.

See Also:

Channel

setShellPrompt

@Metadata(label="advanced")
public void setShellPrompt(String shellPrompt)

Sets the shellPrompt to be dropped when response is read after command execution

Parameters:

shellPrompt - String defining ending string of command line which has to be dropped when response is read after command execution.

setSleepForShellPrompt

@Metadata(label="advanced")
public void setSleepForShellPrompt(long sleepForShellPrompt)

Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds.

Parameters:

sleepForShellPrompt - long milliseconds to wait.