content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.camel.component.ssh.springboot;
  
  import org.apache.camel.component.ssh.SshConfiguration;
  import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon;
  import org.apache.sshd.client.ClientBuilder;
  import org.apache.sshd.common.keyprovider.KeyPairProvider;
  import org.springframework.boot.context.properties.ConfigurationProperties;
  
  /**
   * Execute commands on remote hosts using SSH.
   * 
   * Generated by camel-package-maven-plugin - do not edit this file!
   */
  @ConfigurationProperties(prefix = "camel.component.ssh")
  public class SshComponentConfiguration
          extends
              ComponentConfigurationPropertiesCommon {
  
      /**
       * Whether to enable auto configuration of the ssh component. This is
       * enabled by default.
       */
      private Boolean enabled;
      /**
       * Specifies whether a connection to an unknown host should fail or not.
       * This value is only checked when the property knownHosts is set.
       */
      private Boolean failOnUnknownHost = false;
      /**
       * Sets the resource path for a known_hosts file
       */
      private String knownHostsResource;
      /**
       * Sets the timeout in milliseconds to wait in establishing the remote SSH
       * server connection. Defaults to 30000 milliseconds.
       */
      private Long timeout = 30000L;
      /**
       * Allows for bridging the consumer to the Camel routing Error Handler,
       * which mean any exceptions (if possible) occurred while the Camel consumer
       * is trying to pickup incoming messages, or the likes, will now be
       * processed as a message and handled by the routing Error Handler.
       * Important: This is only possible if the 3rd party component allows Camel
       * to be alerted if an exception was thrown. Some components handle this
       * internally only, and therefore bridgeErrorHandler is not possible. In
       * other situations we may improve the Camel component to hook into the 3rd
       * party component and make this possible for future releases. By default
       * the consumer will use the org.apache.camel.spi.ExceptionHandler to deal
       * with exceptions, that will be logged at WARN or ERROR level and ignored.
       */
      private Boolean bridgeErrorHandler = false;
      /**
       * 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
       */
      private String pollCommand;
      /**
       * Whether the producer should be started lazy (on the first message). By
       * starting lazy you can use this to allow CamelContext and routes to
       * startup in situations where a producer may otherwise fail during starting
       * and cause the route to fail being started. By deferring this startup to
       * be lazy then the startup failure can be handled during routing messages
       * via Camel's routing error handlers. Beware that when the first message is
       * processed then creating and starting the producer may take a little time
       * and prolong the total processing time of the processing.
       */
      private Boolean lazyStartProducer = false;
      /**
       * Whether autowiring is enabled. This is used for automatic autowiring
       * options (the option must be marked as autowired) by looking up in the
       * registry to find if there is a single instance of matching type, which
       * then gets configured on the component. This can be used for automatic
       * configuring JDBC data sources, JMS connection factories, AWS Clients,
       * etc.
       */
      private Boolean autowiredEnabled = true;
      /**
       * Sets the channel type to pass to the Channel as part of command
       * execution. Defaults to exec.
       */
      private String channelType = "exec";
      /**
       * Instance of ClientBuilder used by the producer or consumer to create a
       * new SshClient. The option is a org.apache.sshd.client.ClientBuilder type.
       */
      private ClientBuilder clientBuilder;
      /**
       * Whether to use compression, and if so which.
       */
      private String compressions;
      /**
       * Component configuration. The option is a
       * org.apache.camel.component.ssh.SshConfiguration type.
       */
      private SshConfiguration configuration;
      /**
       * Sets the shellPrompt to be dropped when response is read after command
       * execution
       */
      private String shellPrompt;
      /**
       * Sets the sleep period in milliseconds to wait reading response from shell
       * prompt. Defaults to 100 milliseconds.
       */
      private Long sleepForShellPrompt = 100L;
      /**
       * Used for enabling or disabling all consumer based health checks from this
       * component
       */
      private Boolean healthCheckConsumerEnabled = true;
      /**
       * Used for enabling or disabling all producer based health checks from this
       * component. Notice: Camel has by default disabled all producer based
       * health-checks. You can turn on producer checks globally by setting
       * camel.health.producersEnabled=true.
       */
      private Boolean healthCheckProducerEnabled = true;
      /**
       * Sets the resource path of the certificate to use for Authentication. Will
       * use ResourceHelperKeyPairProvider to resolve file based certificate, and
       * depends on keyType setting.
       */
      private String certResource;
      /**
       * Sets the password to use in loading certResource, if certResource is an
       * encrypted key.
       */
      private String certResourcePassword;
      /**
       * Comma-separated list of allowed/supported ciphers in their order of
       * preference.
       */
      private String ciphers;
      /**
       * Comma-separated list of allowed/supported key exchange algorithms in
       * their order of preference.
       */
      private String kex;
      /**
       * Sets the KeyPairProvider reference to use when connecting using
       * Certificates to the remote SSH Server. The option is a
       * org.apache.sshd.common.keyprovider.KeyPairProvider type.
       */
      private KeyPairProvider keyPairProvider;
      /**
       * Sets the key type to pass to the KeyPairProvider as part of
       * authentication. KeyPairProvider.loadKey(...) will be passed this value.
       * From Camel 3.0.0 / 2.25.0, by default Camel will select the first
       * available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa'
       * was enforced by default.
       */
      private String keyType;
      /**
       * Comma-separated list of allowed/supported message authentication code
       * algorithms in their order of preference. The MAC algorithm is used for
       * data integrity protection.
       */
      private String macs;
      /**
       * Sets the password to use in connecting to remote SSH server. Requires
       * keyPairProvider to be set to null.
       */
      private String password;
      /**
       * Comma-separated list of allowed/supported signature algorithms in their
       * order of preference.
       */
      private String signatures;
      /**
       * Sets the username to use in logging into the remote SSH server.
       */
      private String username;
  
      public Boolean getFailOnUnknownHost() {
          return failOnUnknownHost;
      }
  
      public void setFailOnUnknownHost(Boolean failOnUnknownHost) {
          this.failOnUnknownHost = failOnUnknownHost;
      }
  
      public String getKnownHostsResource() {
          return knownHostsResource;
      }
  
      public void setKnownHostsResource(String knownHostsResource) {
          this.knownHostsResource = knownHostsResource;
      }
  
      public Long getTimeout() {
          return timeout;
      }
  
      public void setTimeout(Long timeout) {
          this.timeout = timeout;
      }
  
      public Boolean getBridgeErrorHandler() {
          return bridgeErrorHandler;
      }
  
      public void setBridgeErrorHandler(Boolean bridgeErrorHandler) {
          this.bridgeErrorHandler = bridgeErrorHandler;
      }
  
      public String getPollCommand() {
          return pollCommand;
      }
  
      public void setPollCommand(String pollCommand) {
          this.pollCommand = pollCommand;
      }
  
      public Boolean getLazyStartProducer() {
          return lazyStartProducer;
      }
  
      public void setLazyStartProducer(Boolean lazyStartProducer) {
          this.lazyStartProducer = lazyStartProducer;
      }
  
      public Boolean getAutowiredEnabled() {
          return autowiredEnabled;
      }
  
      public void setAutowiredEnabled(Boolean autowiredEnabled) {
          this.autowiredEnabled = autowiredEnabled;
      }
  
      public String getChannelType() {
          return channelType;
      }
  
      public void setChannelType(String channelType) {
          this.channelType = channelType;
      }
  
      public ClientBuilder getClientBuilder() {
          return clientBuilder;
      }
  
      public void setClientBuilder(ClientBuilder clientBuilder) {
          this.clientBuilder = clientBuilder;
      }
  
      public String getCompressions() {
          return compressions;
      }
  
      public void setCompressions(String compressions) {
          this.compressions = compressions;
      }
  
      public SshConfiguration getConfiguration() {
          return configuration;
      }
  
      public void setConfiguration(SshConfiguration configuration) {
          this.configuration = configuration;
      }
  
      public String getShellPrompt() {
          return shellPrompt;
      }
  
      public void setShellPrompt(String shellPrompt) {
          this.shellPrompt = shellPrompt;
      }
  
      public Long getSleepForShellPrompt() {
          return sleepForShellPrompt;
      }
  
      public void setSleepForShellPrompt(Long sleepForShellPrompt) {
          this.sleepForShellPrompt = sleepForShellPrompt;
      }
  
      public Boolean getHealthCheckConsumerEnabled() {
          return healthCheckConsumerEnabled;
      }
  
      public void setHealthCheckConsumerEnabled(Boolean healthCheckConsumerEnabled) {
          this.healthCheckConsumerEnabled = healthCheckConsumerEnabled;
      }
  
      public Boolean getHealthCheckProducerEnabled() {
          return healthCheckProducerEnabled;
      }
  
      public void setHealthCheckProducerEnabled(Boolean healthCheckProducerEnabled) {
          this.healthCheckProducerEnabled = healthCheckProducerEnabled;
      }
  
      public String getCertResource() {
          return certResource;
      }
  
      public void setCertResource(String certResource) {
          this.certResource = certResource;
      }
  
      public String getCertResourcePassword() {
          return certResourcePassword;
      }
  
      public void setCertResourcePassword(String certResourcePassword) {
          this.certResourcePassword = certResourcePassword;
      }
  
      public String getCiphers() {
          return ciphers;
      }
  
      public void setCiphers(String ciphers) {
          this.ciphers = ciphers;
      }
  
      public String getKex() {
          return kex;
      }
  
      public void setKex(String kex) {
          this.kex = kex;
      }
  
      public KeyPairProvider getKeyPairProvider() {
          return keyPairProvider;
      }
  
      public void setKeyPairProvider(KeyPairProvider keyPairProvider) {
          this.keyPairProvider = keyPairProvider;
      }
  
      public String getKeyType() {
          return keyType;
      }
  
      public void setKeyType(String keyType) {
          this.keyType = keyType;
      }
  
      public String getMacs() {
          return macs;
      }
  
      public void setMacs(String macs) {
          this.macs = macs;
      }
  
      public String getPassword() {
          return password;
      }
  
      public void setPassword(String password) {
          this.password = password;
      }
  
      public String getSignatures() {
          return signatures;
      }
  
      public void setSignatures(String signatures) {
          this.signatures = signatures;
      }
  
      public String getUsername() {
          return username;
      }
  
      public void setUsername(String username) {
          this.username = username;
      }
  }