StreamUtils (Spring XD 1.3.2.RELEASE API)

java.lang.Object
- org.springframework.xd.integration.util.StreamUtils

```
public class StreamUtils
extends java.lang.Object
```
ストリームとそれらの文字列の JMX フックを作成および監視するためのユーティリティ。
作成者:
Glenn Renfro

フィールド概要
フィールド
修飾子と型フィールドと説明
static java.lang.String TMP_DIR

フィールド
修飾子と型	フィールドと説明
`static java.lang.String`	`TMP_DIR`

コンストラクター概要
コンストラクター
コンストラクターと説明
StreamUtils()

コンストラクター
コンストラクターと説明
`StreamUtils()`

方法の概要

メソッド
修飾子と型	メソッドと説明
`static void`	`appendToRemoteFile(java.lang.String privateKey, java.lang.String host, java.lang.String dir, java.lang.String fileName, java.lang.String payload)` リモート EC2 インスタンス上の既存のファイルにペイロードを追加します。
`static void`	`copyFileToRemote(java.lang.String privateKey, java.lang.String host, java.net.URI uri, java.io.File file, long waitTime)` テストマシンからリモートマシンにファイルをコピーします。
`static boolean`	`createDataFileOnRemote(java.lang.String privateKey, java.lang.String host, java.lang.String dir, java.lang.String fileName, java.lang.String payload, int retryTime)` ペイロードをコンテンツとしてリモート EC2 マシン上にファイルを作成します。
`static boolean`	`createRemoteDirectory(java.lang.String path, java.lang.String host, java.lang.String privateKey, int waitTime)` リモートマシン上にディレクトリを作成します。
`static void`	`destroyAllStreams(java.net.URL adminServer)` クラスターからすべてのストリームを削除します。
`static boolean`	`fileExists(java.lang.String host, java.lang.String privateKey, java.lang.String path)` 指定されたパスがリモートマシン上に存在することを確認します。
`static java.util.Map<java.lang.String,java.lang.String>`	`getAvailableContainers(java.net.URL adminServer)` コンテナー ID と関連付けられたホストのマップを作成します。
`static java.lang.Integer[]`	`getContainerPidsFromURL(java.net.URL url, java.lang.String privateKey, java.lang.String jpsCommand)` リモートマシンのコンテナー PID を取得します。
`static long`	`getCount(java.net.URL adminServer, java.lang.String name)` カウンターの値を取得します
`static java.util.List<org.jclouds.ec2.domain.RunningInstance>`	`getEC2RunningInstances(java.lang.String awsAccessKey, java.lang.String awsSecretKey, java.lang.String awsRegion)` 指定された ec2 リージョンのアクティブなインスタンスのリストを返します。
`static java.lang.Integer[]`	`getLocalContainerPids(java.lang.String jpsCommand)` ローカルマシン上のコンテナー PID を取得します。
`static org.springframework.hateoas.PagedResources<ModuleMetadataResource>`	`getRuntimeModules(java.net.URL adminServer)` モジュールがデプロイされているコンテナー ID のリストを返します
`static java.lang.String`	`httpGet(java.net.URL url)` クライアントに対して http get を実行し、結果を文字列として返します。
`static boolean`	`isStreamDeployed(java.lang.String streamName, java.net.URL adminServer)` 指定されたストリームが XD クラスターにデプロイされているかどうかを確認します。
`static java.net.URL`	`replacePort(java.net.URL url, int port)` URL に関連付けられたポートを別のポートに置き換えます。
`static void`	`stream(java.lang.String streamName, java.lang.String streamDefinition, java.net.URL adminServer)` ストリーム定義を作成し、テスト対象のクラスターにデプロイします。
`static java.lang.String`	`transferResultsToLocal(java.lang.String privateKey, java.net.URL url, java.lang.String fileName)` 指定されたファイルをリモートマシンからローカルマシンにコピーします。
`static void`	`undeployStream(java.net.URL adminServer, java.lang.String streamName)` 指定されたストリーム名をアンデプロイします
`static boolean`	`waitForMetric(java.lang.String name, java.net.URL adminServer, int waitTime)` メトリクスが作成されるまで待機時間まで待機します。
`static boolean`	`waitForStreamDeployment(java.lang.String streamName, java.net.URL adminServer, int waitTime)` ストリームがデプロイされるまで待機時間まで待機します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - TMP_DIR
```
public static final java.lang.String TMP_DIR
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - StreamUtils
```
public StreamUtils()
```
- メソッドの詳細
  - stream
```
public static void stream(java.lang.String streamName,
          java.lang.String streamDefinition,
          java.net.URL adminServer)
```
    ストリーム定義を作成し、テスト対象のクラスターにデプロイします。
    パラメーター:
    streamName - ストリームの名前
    streamDefinition - このストリームにデプロイする必要がある定義。
    adminServer - このストリームがデプロイされる管理サーバー。
  - httpGet
```
public static java.lang.String httpGet(java.net.URL url)
```
    クライアントに対して http get を実行し、結果を文字列として返します。
    パラメーター:
    url - 取得を実行する場所。
    戻り値:
    取得した文字列の結果
  - destroyAllStreams
```
public static void destroyAllStreams(java.net.URL adminServer)
```
    クラスターからすべてのストリームを削除します。クリーンな受け入れテストを保証するために使用されます。
    パラメーター:
    adminServer - コマンドが実行される管理サーバー。
  - undeployStream
```
public static void undeployStream(java.net.URL adminServer,
                  java.lang.String streamName)
```
    指定されたストリーム名をアンデプロイします
    パラメーター:
    adminServer - コマンドが実行される管理サーバー。
    streamName - アンデプロイするストリームの名前
  - getCount
```
public static long getCount(java.net.URL adminServer,
            java.lang.String name)
```
    カウンターの値を取得します
    パラメーター:
    adminServer - テスト対象のクラスターの管理サーバー。
    name - メトリクスリポジトリ内のカウンターの名前。
    戻り値:
    名前に関連付けられたカウント。
  - transferResultsToLocal
```
public static java.lang.String transferResultsToLocal(java.lang.String privateKey,
                                      java.net.URL url,
                                      java.lang.String fileName)
```
    指定されたファイルをリモートマシンからローカルマシンにコピーします。
    パラメーター:
    privateKey - リモートマシンへの SSH 秘密鍵
    url - リモートマシンの URL。
    fileName - 転送するファイルの完全修飾ファイル名。
    戻り値:
    リモートファイルがコピーされた場所の完全修飾ファイル名。
  - createDataFileOnRemote
```
public static boolean createDataFileOnRemote(java.lang.String privateKey,
                             java.lang.String host,
                             java.lang.String dir,
                             java.lang.String fileName,
                             java.lang.String payload,
                             int retryTime)
```
    ペイロードをコンテンツとしてリモート EC2 マシン上にファイルを作成します。
    パラメーター:
    privateKey - リモートコンテナーの SSH 秘密鍵
    host - リモートマシンの IP。
    dir - ファイルを書き込むディレクトリ
    fileName - 作成するファイルの完全修飾ファイル名。
    payload - ファイルに書き込むデータ
    retryTime - リモートシステムにデータファイルをプッシュする再試行にかかる時間 (ミリ秒)。
  - copyFileToRemote
```
public static void copyFileToRemote(java.lang.String privateKey,
                    java.lang.String host,
                    java.net.URI uri,
                    java.io.File file,
                    long waitTime)
```
    テストマシンからリモートマシンにファイルをコピーします。
    パラメーター:
    privateKey - リモートコンテナーの SSH 秘密鍵
    host - リモートマシンの IP。
    uri - ファイルがリモートマシンにコピーされる場所。
    file - リモートマシンに移行するファイル。
  - createRemoteDirectory
```
public static boolean createRemoteDirectory(java.lang.String path,
                            java.lang.String host,
                            java.lang.String privateKey,
                            int waitTime)
```
    リモートマシン上にディレクトリを作成します。失敗した場合は、waitTime が使い果たされるまで再試行されます。
    パラメーター:
    path - 作成されるディレクトリ
    host - ディレクトリが作成される IP
    privateKey - リモートマシンにサインするために使用される秘密鍵。
    waitTime - ディレクトリの作成を試みる最大時間
    戻り値:
    ディレクトリが正常に作成された場合は true、それ以外の場合は false。
  - appendToRemoteFile
```
public static void appendToRemoteFile(java.lang.String privateKey,
                      java.lang.String host,
                      java.lang.String dir,
                      java.lang.String fileName,
                      java.lang.String payload)
```
    リモート EC2 インスタンス上の既存のファイルにペイロードを追加します。
    パラメーター:
    privateKey - リモートコンテナーの SSH 秘密鍵
    host - リモートマシンの IP。
    dir - ファイルを書き込むディレクトリ
    fileName - 作成するファイルの完全修飾ファイル名。
    payload - ファイルに追加するデータ
  - getEC2RunningInstances
```
public static java.util.List<org.jclouds.ec2.domain.RunningInstance> getEC2RunningInstances(java.lang.String awsAccessKey,
                                                                            java.lang.String awsSecretKey,
                                                                            java.lang.String awsRegion)
```
    指定された ec2 リージョンのアクティブなインスタンスのリストを返します。
    パラメーター:
    awsAccessKey - ec2 ユーザーの一意の ID。
    awsSecretKey - ec2 ユーザーのパスワード。
    awsRegion - 受け入れテストインスタンスをインスペクションする AWS リージョン。
    戻り値:
    指定されたアカウントおよびリージョンにおけるアクティブなインスタンスのリスト。
  - replacePort
```
public static java.net.URL replacePort(java.net.URL url,
                       int port)
```
    URL に関連付けられたポートを別のポートに置き換えます。
    パラメーター:
    url - ポート番号の置換が必要な URL。
    port - 新しいポート番号
    戻り値:
    渡された URL のホスト名と新しいポート番号を含む新しい URL。
  - getAvailableContainers
```
public static java.util.Map<java.lang.String,java.lang.String> getAvailableContainers(java.net.URL adminServer)
```
    コンテナー ID と関連付けられたホストのマップを作成します。
    パラメーター:
    adminServer - 照会対象の管理サーバー。
    戻り値:
    キーがコンテナー ID、値がホスト IP であるマップ。
  - getRuntimeModules
```
public static org.springframework.hateoas.PagedResources<ModuleMetadataResource> getRuntimeModules(java.net.URL adminServer)
```
    モジュールがデプロイされているコンテナー ID のリストを返します
    パラメーター:
    adminServer - 照会対象となる管理サーバー。
    戻り値:
    モジュールがデプロイされているコンテナーの一覧。
  - waitForStreamDeployment
```
public static boolean waitForStreamDeployment(java.lang.String streamName,
                              java.net.URL adminServer,
                              int waitTime)
```
    ストリームがデプロイされるまで待機時間まで待機します。
    パラメーター:
    streamName - The name of the stream to be evaluated.
    adminServer - The admin server URL that will be queried.
    waitTime - the amount of time in millis to wait.
    戻り値:
    true if the stream is deployed else false.
  - isStreamDeployed
```
public static boolean isStreamDeployed(java.lang.String streamName,
                       java.net.URL adminServer)
```
    指定されたストリームが XD クラスターにデプロイされているかどうかを確認します。
    パラメーター:
    streamName - The name of the stream to be evaluated.
    adminServer - The admin server URL that will be queried.
    戻り値:
    true if the stream is deployed else false
  - waitForMetric
```
public static boolean waitForMetric(java.lang.String name,
                    java.net.URL adminServer,
                    int waitTime)
```
    メトリクスが作成されるまで待機時間まで待機します。
    パラメーター:
    name - The name of the metric to be evaluated.
    adminServer - The admin server URL that will be queried.
    waitTime - the amount of time in millis to wait.
    戻り値:
    true if the metric is created else false.
  - getLocalContainerPids
```
public static java.lang.Integer[] getLocalContainerPids(java.lang.String jpsCommand)
```
    ローカルマシン上のコンテナー PID を取得します。
    パラメーター:
    jpsCommand - jps command that will reveal the pids.
    戻り値:
    An Integer array that contains the pids.
  - getContainerPidsFromURL
```
public static java.lang.Integer[] getContainerPidsFromURL(java.net.URL url,
                                          java.lang.String privateKey,
                                          java.lang.String jpsCommand)
```
    リモートマシンのコンテナー PID を取得します。
    パラメーター:
    url - The URL where the containers are deployed.
    privateKey - ssh private key credential
    jpsCommand - The command to retrieve java processes on container machine.
    戻り値:
    An Integer array that contains the pids.
  - fileExists
```
public static boolean fileExists(java.lang.String host,
                 java.lang.String privateKey,
                 java.lang.String path)
```
    指定されたパスがリモートマシン上に存在することを確認します。
    パラメーター:
    host - The host where the file exists.
    privateKey - ssh private key credential
    path - path to file or directory
    戻り値:
    true if file exists else false.

クラス StreamUtils

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

TMP_DIR

コンストラクターの詳細

StreamUtils

メソッドの詳細

stream

httpGet

destroyAllStreams

undeployStream

getCount

transferResultsToLocal

createDataFileOnRemote

copyFileToRemote

createRemoteDirectory

appendToRemoteFile

getEC2RunningInstances

replacePort

getAvailableContainers

getRuntimeModules

waitForStreamDeployment

isStreamDeployed

waitForMetric

getLocalContainerPids

getContainerPidsFromURL

fileExists