328.2. オプション
SSH コンポーネントは、以下に示す 15 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
configuration (advanced) | 共有 SSH 設定を使用するには | SshConfiguration | |
host (common) | リモート SSH サーバーのホスト名を設定します。 | String | |
port (common) | リモート SSH サーバーのポート番号を設定します。 | int | |
username (security) | リモート SSH サーバーへのログインに使用するユーザー名を設定します。 | String | |
password (security) | リモート SSH サーバーへの接続に使用するパスワードを設定します。keyPairProvider を null に設定する必要があります。 | String | |
pollCommand (common) | 各ポーリングサイクル中にリモート SSH サーバーに送信するコマンド文字列を設定します。コンシューマーとして使用されている camel-ssh コンポーネント、つまり from (ssh://…) でのみ機能します。コマンドを改行で終了する必要がある場合があり、それは URL エンコードされた %0A でなければなりません | String | |
keyPairProvider (security) | 証明書を使用してリモート SSH サーバーに接続するときに使用する KeyPairProvider 参照を設定します。 | KeyPairProvider | |
keyType (security) | 認証の一部として KeyPairProvider に渡すキータイプを設定します。KeyPairProvider.loadKey(…) にこの値が渡されます。デフォルトは ssh-rsa です。 | String | |
timeout (common) | リモート SSH サーバー接続を確立する際に待機するタイムアウトをミリ秒単位で設定します。デフォルトは 30000 ミリ秒 (ms) です。 | long | |
certFilename (security) | 非推奨 認証に使用する証明書のリソースパスを設定します。 | String | |
certResource (security) | 認証に使用する証明書のリソースパスを設定します。ResourceHelperKeyPairProvider を使用してファイルベースの証明書を解決し、keyType 設定に依存します。 | String | |
channelType (advanced) | コマンド実行の一部として Channel に渡すチャネルタイプを設定します。デフォルトは exec です。 | String | |
shellPrompt (advanced) | コマンド実行後にレスポンスが読み取られたときに shellPrompt がドロップされるように設定します | String | |
sleepForShellPrompt (advanced) | シェルプロンプトからのレスポンスの読み取りを待機するスリープ期間をミリ秒単位で設定します。デフォルトは 100 ミリ秒 (ms) です。 | long | |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
SSH エンドポイントは、URI 構文を使用して設定されます。
ssh:host:port
パスおよびクエリーパラメーターを使用します。
328.2.1. パスパラメーター (2 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
host | 必須 リモート SSH サーバーのホスト名を設定します。 | String | |
port | リモート SSH サーバーのポート番号を設定します。 | 22 | int |
328.2.2. Query Parameters (31 parameters):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
failOnUnknownHost (common) | 不明なホストへの接続が失敗するかどうかを指定します。この値は、プロパティー knownHosts が設定されている場合にのみチェックされます。 | false | boolean |
knownHostsResource (common) | known_hosts ファイルのリソースパスを設定します | String | |
timeout (common) | リモート SSH サーバー接続を確立する際に待機するタイムアウトをミリ秒単位で設定します。デフォルトは 30000 ミリ秒 (ms) です。 | 30000 | long |
bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
pollCommand (consumer) | 各ポーリングサイクル中にリモート SSH サーバーに送信するコマンド文字列を設定します。コンシューマーとして使用されている camel-ssh コンポーネント、つまり from(ssh://…) でのみ機能します。コマンドの最後に改行が必要な場合がありますが、これは URL エンコードされた %0A でなければなりません。 | String | |
sendEmptyMessageWhenIdle (consumer) | ポーリング consumer がファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。 | false | boolean |
exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
pollStrategy (consumer) | プラグ可能な org.apache.camel.PollingConsumerPollingStrategy を使用すると、エクスチェンジが作成され、Camel でルーティングされる前に、通常はポーリング操作中に発生するエラー処理を制御するカスタム実装が提供できます。 | PollingConsumerPoll Strategy | |
channelType (advanced) | コマンド実行の一部として Channel に渡すチャネルタイプを設定します。デフォルトは exec です。 | exec | String |
shellPrompt (advanced) | コマンド実行後にレスポンスが読み取られたときに shellPrompt がドロップされるように設定します | String | |
sleepForShellPrompt (advanced) | シェルプロンプトからのレスポンスの読み取りを待機するスリープ期間をミリ秒単位で設定します。デフォルトは 100 ミリ秒 (ms) です。 | 100 | long |
synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
backoffErrorThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。 | int | |
backoffIdleThreshold (scheduler) | backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。 | int | |
backoffMultiplier (scheduler) | 後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリング consumer のバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。 | int | |
delay (scheduler) | 次のポーリングまでの時間 (ミリ秒単位)。60s (60 秒)、5m30s (5 分 30 秒)、1h (1 時間) などの単位を使用して時間値を指定することもできます。 | 500 | long |
greedy (scheduler) | greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。 | false | boolean |
initialDelay (scheduler) | 最初のポーリングが開始されるまでの時間 (ミリ秒単位)。60s (60 秒)、5m30s (5 分 30 秒)、1h (1 時間) などの単位を使用して時間値を指定することもできます。 | 1000 | long |
runLoggingLevel (scheduler) | consumer はポーリング時に開始/完了のログ行を記録します。このオプションを使用すると、ログレベルを設定できます。 | TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | consumer に使用するカスタム/共有スレッドプールを設定できます。デフォルトでは、各コンシューマーに独自の単一スレッドのスレッドプールがあります。 | ScheduledExecutor Service | |
scheduler (scheduler) | camel-spring または camel-quartz2 コンポーネントから cron スケジューラーを使用します。 | none | ScheduledPollConsumer Scheduler |
schedulerProperties (scheduler) | カスタムスケジューラーまたは Quartz2 や Spring ベースのスケジューラーを使用する場合に、追加のプロパティーを設定します。 | Map | |
startScheduler (scheduler) | スケジューラーを自動起動するかどうか。 | true | boolean |
timeUnit (scheduler) | initialDelay および delay オプションの時間単位。 | MILLISECONDS | TimeUnit |
useFixedDelay (scheduler) | 固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。 | true | boolean |
certResource (security) | 認証に使用する証明書のリソースパスを設定します。ResourceHelperKeyPairProvider を使用してファイルベースの証明書を解決し、keyType 設定に依存します。 | String | |
keyPairProvider (security) | 証明書を使用してリモート SSH サーバーに接続するときに使用する KeyPairProvider 参照を設定します。 | KeyPairProvider | |
keyType (security) | 認証の一部として KeyPairProvider に渡すキータイプを設定します。KeyPairProvider.loadKey(…) にこの値が渡されます。デフォルトは ssh-rsa です。 | ssh-rsa | String |
password (security) | リモート SSH サーバーへの接続に使用するパスワードを設定します。keyPairProvider を null に設定する必要があります。 | String | |
username (security) | リモート SSH サーバーへのログインに使用するユーザー名を設定します。 | String |