接続プロパティ

接続は仮想サービスのエンドポイントです。サービスへの接続を確立する、または接続を模倣するためには、シミュレーションファイルにおいて接続プロパティが必要となります。これらのプロパティには、タイムアウト、暗号化、認証オプションが含まれる場合があります。例えば、元のサービスがSSL暗号化を必要とする場合、仮想サービスも同様に動作するように安全な接続をシミュレートする必要があるかもしれません。

以下は、使用可能な一般的な接続プロパティです。

接続プロパティ

説明

例

authentication

Specifies the authentication method for your connection.Supports the following values:

  • None means the service doesn't require authentication.

  • Basic requires a username and password to authenticate.

  • ClientCertificate uses a client certificate file for authentication.

  • Digest employs digest access authentication, which securely transmits credentials using hashing.

None

basedOn

この接続名を使用して接続を参照します。

Connection 1

capture

送信または受信したすべてのメッセージを一時的に保存するには、このプロパティをtrueに設定します。デフォルト値はfalseです。

true

clientCertificateFile

接続にSSL認証が必要な場合、このプロパティを定義します。クライアント証明書ファイルへのパスを入力します。

/path/to/clientcert.pem

clientCertificatePassword

クライアント証明書ファイルにパスワードが必要な場合は、このプロパティを定義します。

test123

endpoint

メッセージを送信するエンドポイントを指定します。通常、URI、ポート、あるいはIPアドレスのいずれかになります。

https://www.send-messages.here.com/

forward

すべての受信メッセージを転送する接続を定義します。forwardは、常にtoあるいはmode、および必要に応じてsimulateOnプロパティと組み合わせて指定してください。

  • to: 接続名を指定します。参照される接続は、同じシミュレーションファイルまたは同じワークスペースフォルダ内の別のシミュレーションファイルで定義されている必要があります。

  • mode: このプロパティを使用して、接続の種類を定義します。以下のオプションを利用できます。

    • passThrough: メッセージは実際のサービスに転送されます。

    • simulate first: メッセージはシミュレーションに送信されます。シミュレーションが機能しない場合は、実際のサービスに転送されます。

    • forward first: メッセージは最初に実際のサービスに送信されます。サービスが利用できない場合、シミュレーションに転送されます。
      さらに、シミュレーションをいつトリガーすべきかを指定するために、プロパティsimulateOnが必要です。

    • learning: forward firstのように機能し、実際のサービスから新しい動作を学習します。

  • simulateOn: このプロパティは、forward firstプロパティとの組み合わせでのみ必要です。This lets APIシミュレーション know when to trigger the simulation.

    • timeout: Specify how long APIシミュレーション should wait for the service to respond before the fallback service starts.ミリ秒で時間を入力してください。

    • statusCode: 複数のステータスコードをカンマ区切りで入力することができます。

forward:
to: myConnection2
mode: passThrough

 

 

learning

転送をlearningモードで使用する際、メッセージは最初にシミュレーションに送信されます。If the simulation doesn’t respond, APIシミュレーション forwards the request to the real service.同時に、実際のサービスの応答を記録し、新しいシミュレーションファイルとして保存いたします。これにより、シミュレーションは将来的に同じリクエストを処理できるようになります。

When APIシミュレーション creates the simulation file, it detects possible trigger elements and saves them as trigger properties.

必要に応じて、learningとともに以下のプロパティを使用することができます。

  • sortプロパティを使用することで、シミュレーションを整理して保つことができます。以下のソートオプションのいずれかを選択してください。

    • ByConnection: シミュレーションを接続名ごとにフォルダに分類します。特定のシステムまたはエンドポイントからのメッセージを追跡しやすくなります。

    • ByPath: 受信メッセージのパスによってシミュレーションを整理します。APIやメッセージロジックを反映したフォルダ構造を作成します。

    • ByTimestamp: 各シミュレーションはタイムスタンプに基づいたファイル名を使用し、ワークスペースフォルダに保存されます。容易な識別と時系列の追跡を可能にします。

  • externalPayload: When set to true, the シミュレータAgent stores learned message payloads in separate simulation files instead of embedding them in the current file.これにより、シミュレーションファイルを綺麗に保ちます。

  • learnOn: learningモードが開始される前に満たすべきルールを指定できます。例えば、ヘッダー、プロパティ、またはペイロードの値を確認することで、特定のメッセージに学習を制限することができます。

  • pathTemplate: 学習されたシミュレーションファイルが保存されるファイル名またはフォルダパスを指定できます。これにより、例えばエンドポイント、接続、またはユースケースごとにシミュレーションファイルを整理できます。ファイルがすでに存在する場合、新しいサービスは単にそこに追加されます。

  • patternsプロパティを使用すると、JSONフィールドなどの追加のメッセージ詳細を定義できます。learningモードはこれを使用してサービスやシナリオを区別します。すべてのリクエストをURIとHTTPメソッドだけでグループ化するのではなく、ユーザーロールや操作の種類などの値によって分類できます。これにより、異なるユースケースに対して異なる動作を作成することが可能になります。

forward:

to: myConnection2
mode: learning
sort: ByConnection

 

車両サービスの例

keepProcessed

このプロパティは、処理されたメッセージを保持するか削除するかを指定します。処理済みのメッセージを保持する場合は、値をtrueに設定します。デフォルト値はfalseです。

true

listen

デフォルトでは、このプロパティの値はtrueに設定されています。これは、接続がメッセージの送受信を行うことを意味します。接続がメッセージの送信のみを行うように指定するには、値をfalseに設定します。

true

name

接続の名前です。

myConnection

password

認証が必要な場合にこのプロパティを指定します。

test123

port

受信メッセージをリッスンするために使用されるポートです。

8080

queue

メッセージブローカーのキューを使用してメッセージの読み書きを行う場合、このプロパティが必要です。使用するキューの名前を指定します。

myQueue

selector

このプロパティはメッセージブローカーのキューと組み合わせて使用します。セレクタを使用すると、キューから受信したメッセージをフィルタリングすることができます。指定した値を含むメッセージのみが通過します。selectorプロパティの構文とサポートは、使用するメッセージブローカーによって異なります。

JMSPriority = 9

serverCertificateFile

接続を暗号化したい場合、証明書のパスを指定します。

/etc/certs/server.pfx

serverCertificatePassword

接続が暗号化を必要とし、提供されたサーバー証明書ファイルにパスワードが必要な場合、このプロパティを指定します。

test123

serverCertificateThumbprint

接続が暗号化される必要がある場合は、証明書のサムプリントを指定します。When opening a connection, APIシミュレーション uses the thumbprint to search for the certificate in the certificate stores of the operating system.

a909502dd...

topic

メッセージブローカーのトピックを使用してメッセージの読み書きを行う場合、このプロパティが必要です。使用するトピックの名前を指定します。

myTopic

type

デフォルトのHTTP以外の接続技術を使用する場合に、このプロパティを指定します。例えば、メッセージブローカー経由でメッセージを送受信したり、フォルダに接続したりする場合などです。有効な値は、AmazonSqs、Amqp、AzureSb、Folder、Http、IbmMq、Kafka、RabbitMQ、Solace、およびCustomです。

For the Custom connection type, specify the typeName property to identify the custom connection.

RabbitMQ

typeName

If you use a Custom connection type, specify a name for this property to identify the connection.

myCustomConnection

uri

Specify the URI to send the messages to.

www.tricentis.com

username

認証が必要な場合にこのプロパティを指定します。

myUser

ローカルマシンまたはネットワークドライブ上の特定のファイルディレクトリを定義するには、以下の接続プロパティを使用します。

接続プロパティ

説明

例

create

ファイルシステムにフォルダが存在しない場合、接続によって新しいフォルダを作成するかどうかを指定します。デフォルト値はfalseです。

true

fileExtension

ファイル拡張子を指定します。

xml

folder

Specify the path to a folder that APIシミュレーション will check for new messages.接続のtypeプロパティは、folderに設定する必要があります。

/path/to/messages

使用可能なAmazon MQブローカーの接続プロパティは次の通りです。

接続プロパティ

説明

例

accessKey

Amazon SQSアクセスキーIDを入力します。

your_access_key_id

account

Amazonウェブサービスアカウント（AWS）の名前を入力します。

myAccount

region

一部の操作では、リージョンを定義する必要があります。最適なネットワークパフォーマンスを得るために、地理的に近いリージョンを選択することができます。

us-east-1

secretKey

Amazon SQSのシークレットアクセスキーを入力します。

your_secret_access_key

使用可能なApache Kafkaブローカーの接続プロパティは次の通りです。

接続プロパティ

説明

例

clientPropertiesFile

特定のKafka接続設定を含むファイルのパスを指定します。

/path/to/kafka.properties

groupId

使用するグループの識別子を指定します。

myGroup

partition

使用するパーティションの番号を指定します。

1

使用可能なAzure Service Busブローカーの接続プロパティは次の通りです。

接続プロパティ

説明

例

accessKey

Azure Service Busに接続するためのAzure Service Busアクセスキーを入力します。

your_access_key

accessKeyName

Azure Service Busアクセスキー名を入力します。

RootManageSharedAccessKey

使用可能なIBM MQブローカーの接続プロパティーは次の通りです。

接続プロパティ

説明

例

channel

メッセージブローカーとの通信に使用するチャネルの名前を指定します。

CH1

CipherSpec

暗号化通信（SSL）を有効にするために、暗号化アルゴリズムとメッセージ認証コードのアルゴリズムの組み合わせを指定します。

ECDHE_ECDSA_3DES_EDE_CBC_SHA256

CipherSuite

暗号化アルゴリズムのスイートを指定します。暗号化スイートは、暗号化通信（SSL）を有効にするための仕様を選択する代替手段です。

SSL_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA

KeyRepository

暗号化通信（SSL）を有効にするために、ファイル拡張子なしでキーリポジトリのファイルパスを指定します。

C:\Data\ssl_certificate

manager

メッセージブローカーとの通信に使用するIBM MQキューマネージャーの名前を指定します。

myManager

peerName

ピアキューマネージャーからの証明書の識別名（DN）を検証するために、このプロパティを指定します。

QMGR

使用可能なRabbitMQブローカーの接続プロパティは次の通りです。

接続プロパティ

説明

例

exchange

メッセージを異なるキューにルーティングするために使用するエクスチェンジの名前を指定します。

myExchange

routingKey

ブローカーが要求する場合、ルーティングキーを指定します。

myRoutingKey

virtualHost

仮想ホストの名前を指定します。

myVirtualHost

使用可能なSolaceブローカーの接続プロパティは次の通りです。

接続プロパティ

説明

例

trustStorePath

validateCertificateプロパティが有効な場合、このプロパティを指定します。信頼された証明書のコレクションへのパスを入力してください。

/path/to/trust.jks

validateCertificate

トラストストアで定義された証明書を信頼するかどうかを指定します。デフォルト値はfalseです。証明書を信頼するには、値をtrueに設定します。このプロパティが有効な場合、trustStorePathプロパティを指定する必要があります。

true

privateKeyFile

クライアント証明書ファイルを使用する場合、このプロパティを定義する必要があります。クライアント証明書キーファイルへのパスを入力します。

/path/to/clientkey.pem

privateKeyFilePassword

秘密鍵ファイルがパスワードで保護されている場合、このプロパティを指定します。

myPass

vpnName

参加するメッセージVPNの名前を指定します。

myVPN

以下は接続の構成例です。

  • シミュレーションには、myConnection01およびmyConnection02という2つの接続テンプレートが含まれています。

  • service01というサービスは、ポートプロパティ8080で接続テンプレートmyConnection01を参照しています。

コピー 
schema: SimV1
name: my simulation

templates:
  connections: 
  - name: myConnection01
    port: 8080
  - name: myConnection02
    port: 8081

services:
- name: service01
  steps:
  - direction: In
    connection:
      basedOn: myConnection01