Package org.apache.camel.component.ssh
Class SshEndpoint
java.lang.Object
org.apache.camel.support.service.BaseService
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.ComponentAware
,org.apache.camel.Endpoint
,org.apache.camel.IsSingleton
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.HasCamelContext
,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",
category=FILE,
headersClass=SshConstants.class)
public class SshEndpoint
extends org.apache.camel.support.ScheduledPollEndpoint
Execute commands on remote hosts using SSH.
-
Field Summary
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Constructor Summary
ConstructorDescriptionSshEndpoint
(String uri, SshComponent component) SshEndpoint
(String uri, SshComponent component, SshConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.camel.Consumer
createConsumer
(org.apache.camel.Processor processor) org.apache.camel.Producer
getHost()
org.apache.sshd.common.keyprovider.KeyPairProvider
int
getPort()
long
long
boolean
boolean
void
setCertResource
(String certResource) void
setCertResourcePassword
(String certResourcePassword) void
setChannelType
(String channelType) void
setConfiguration
(SshConfiguration configuration) void
setFailOnUnknownHost
(boolean failOnUnknownHost) void
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, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, 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
configureExchange, configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString
Methods inherited from class org.apache.camel.support.service.BaseService
build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, 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.ComponentAware
getComponent
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.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Constructor Details
-
SshEndpoint
public SshEndpoint() -
SshEndpoint
-
SshEndpoint
-
-
Method Details
-
createProducer
- Throws:
Exception
-
createConsumer
public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception - Throws:
Exception
-
isSingletonProducer
public boolean isSingletonProducer() -
getConfiguration
-
setConfiguration
-
getHost
-
setHost
-
getPort
public int getPort() -
setPort
public void setPort(int port) -
getUsername
-
setUsername
-
getPassword
-
setPassword
-
getPollCommand
-
setPollCommand
-
getKeyPairProvider
public org.apache.sshd.common.keyprovider.KeyPairProvider getKeyPairProvider() -
setKeyPairProvider
public void setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider) -
getKeyType
-
setKeyType
-
getTimeout
public long getTimeout() -
setTimeout
public void setTimeout(long timeout) -
getCertResource
-
setCertResource
-
getCertResourcePassword
-
setCertResourcePassword
-
getKnownHostsResource
-
setKnownHostsResource
-
isFailOnUnknownHost
public boolean isFailOnUnknownHost() -
setFailOnUnknownHost
public void setFailOnUnknownHost(boolean failOnUnknownHost) -
getChannelType
-
setChannelType
-
getShellPrompt
-
setShellPrompt
-
getSleepForShellPrompt
public long getSleepForShellPrompt() -
setSleepForShellPrompt
public void setSleepForShellPrompt(long sleepForShellPrompt)
-