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.EndpointServiceLocation, 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 implements org.apache.camel.spi.EndpointServiceLocation
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

    Constructors
    Constructor
    Description
    SshEndpoint()
     
    SshEndpoint(String uri, SshComponent component)
     
    SshEndpoint(String uri, SshComponent component, SshConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    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()
     
    Map<String,String>
    getServiceMetadata()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    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, 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, getInternalLock, 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, isRemote

    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

  • Method Details

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • isSingletonProducer

      public boolean isSingletonProducer()
      Specified by:
      isSingletonProducer in interface org.apache.camel.Endpoint

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceMetadata

      public Map<String,String> getServiceMetadata()
      Specified by:
      getServiceMetadata in interface org.apache.camel.spi.EndpointServiceLocation

    • 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)