org.apache.camel.component.ssh

Class SshEndpoint

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.support.ScheduledPollEndpoint

org.apache.camel.component.ssh.SshEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.10.0",
             scheme="ssh",
             title="SSH",
             syntax="ssh:host:port",
             alternativeSyntax="ssh:username:password@host:port",
             label="file")
public class SshEndpoint
extends org.apache.camel.support.ScheduledPollEndpoint

The ssh component enables access to SSH servers such that you can send an SSH command, and process the response.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

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
SshEndpoint()
SshEndpoint(String uri, SshComponent component)
SshEndpoint(String uri, SshComponent component, SshConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
String	getCertResource()
String	getCertResourcePassword()
String	getChannelType()
SshConfiguration	getConfiguration()
String	getHost()
org.apache.sshd.common.keyprovider.KeyPairProvider	getKeyPairProvider()
String	getKeyType()
String	getKnownHostsResource()
String	getPassword()
String	getPollCommand()
int	getPort()
String	getShellPrompt()
long	getSleepForShellPrompt()
long	getTimeout()
String	getUsername()
boolean	isFailOnUnknownHost()
boolean	isSingletonProducer()
void	setCertResource(String certResource)
void	setCertResourcePassword(String certResourcePassword)
void	setChannelType(String channelType)
void	setConfiguration(SshConfiguration configuration)
void	setFailOnUnknownHost(boolean failOnUnknownHost)
void	setHost(String host)
void	setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)
void	setKeyType(String keyType)
void	setKnownHostsResource(String knownHostsResource)
void	setPassword(String password)
void	setPollCommand(String pollCommand)
void	setPort(int port)
void	setShellPrompt(String shellPrompt)
void	setSleepForShellPrompt(long sleepForShellPrompt)
void	setTimeout(long timeout)
void	setUsername(String username)

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

configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, doStart, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

SshEndpoint

public SshEndpoint()

SshEndpoint

public SshEndpoint(String uri,
                   SshComponent component)

SshEndpoint

public SshEndpoint(String uri,
                   SshComponent component,
                   SshConfiguration configuration)

Method Detail

isSingletonProducer

public boolean isSingletonProducer()

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

getConfiguration

public SshConfiguration getConfiguration()

setConfiguration

public void setConfiguration(SshConfiguration configuration)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPollCommand

public String getPollCommand()

setPollCommand

public void setPollCommand(String pollCommand)

getKeyPairProvider

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

setKeyPairProvider

public void setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)

getKeyType

public String getKeyType()

setKeyType

public void setKeyType(String keyType)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getCertResource

public String getCertResource()

setCertResource

public void setCertResource(String certResource)

getCertResourcePassword

public String getCertResourcePassword()

setCertResourcePassword

public void setCertResourcePassword(String certResourcePassword)

getKnownHostsResource

public String getKnownHostsResource()

setKnownHostsResource

public void setKnownHostsResource(String knownHostsResource)

isFailOnUnknownHost

public boolean isFailOnUnknownHost()

setFailOnUnknownHost

public void setFailOnUnknownHost(boolean failOnUnknownHost)

getChannelType

public String getChannelType()

setChannelType

public void setChannelType(String channelType)

getShellPrompt

public String getShellPrompt()

setShellPrompt

public void setShellPrompt(String shellPrompt)

getSleepForShellPrompt

public long getSleepForShellPrompt()

setSleepForShellPrompt

public void setSleepForShellPrompt(long sleepForShellPrompt)