View Source

Introduction

The Parasoft gRPC Listener Extension adds support for the Google Remote Procedure Call message format so that Virtualize assets can read a single message from a gRPC method call and respond with a single message on the same call or another gRPC method call.

Requirements

gRPC 1.0.0 or later
Parasoft Virtualize 2022.1 or later

Installation

This artifact can be installed from the UI or the command line.

UI Installation

Go to Parasoft > Preferences and click System Properties.
Click Add JARs and select the com.parasoft.virtualize.listener.grpc-<version>.jar file.
Click Apply.
Restart Virtualize.

Command Line Installation

Add the com.parasoft.soavirt.listener.grpc-<version>.jar file to the system.properties.classpath property in your settings properties file. For example:

system.properties.classpath=<PATH_TO_JAR>/com.parasoft.soavirt.listener.grpc-<VERSION>.jar

Usage

After installation, the gRPC Listener option will appear in the Virtual Asset Deployment Settings. The gRPC implementation can be used for all responders except SQL Responders.

Open the virtual asset settings and click the Transport tab.
Click the Custom tab and configure the listener settings (see Configuration). If your system has more than one custom extension, choose gRPC Lister from the Select implementation menu.

SOAtest and Virtualize 2026.1 > gRPC Listener > virt-grpc-listener-format-pva-20221.png

Configuration

Connection Settings

Listen Port	Specify the listen port. Value must be between `1` and `65535`.
Service Name	Specify the service name.
Method Names	Specify the method name or names. Multiple entries must be separated by commas.
Method Type(s)	Specify the method type or types. Valid entries are `unary` or `stream`. Multiple entries must be separated by commas. The default is `unary`.

Injected Headers Settings

Method Header	Default is `grpc-method`.
Call ID Header	Default is `grpc-call-id`.
Notification Header	Default is `grpc-notification`.

Transport Layer Security Settings

Auth Mechanism	Specify the authorization mechanism you want to use to connect to the gRPC server. Options are `SSL` and `insecure`. The default is `insecure`.
Certificate Chain File	Specify the path to a PEM-formatted certificate chain file. This field is ignored when the Auth Mechanism is set to `insecure`.
Private Key File	Specify the path to the private key file is PKCS#8 format. This field is ignored when the Auth Mechanism is set to `insecure`.
Client Private Key Password	If the private key is encrypted, specify its password. If the private key is not encrypted, leave this field blank.
Client Verification	Specify the level of authentication the server should expect from the client. Options are: NONE: Clients will not present any identity. OPTIONAL: Clients are requested to present their identity but clients without identities are permitted. REQUIRED: Clients are requested to present their identity and are required to provide a valid identity. The default is `NONE`.
Root Certificates File	Specify the path to a PEM-formatted root certificates file that should be used to verify the client's identity if it differs from the system's default.

Logging Settings

Log Level	Specify how much information you want logged to the console. The default is `2` (warn).

Change Log

1.5

Support client certificates for two-way SSL

1.4

Added support for large inbound messages

1.3

Decode grpc-status-details-bin header to JSON when both Protobuf and gRPC extensions are loaded

1.1

Receive gRPC metadata headers for responder correlation and show in event viewer

1.0

Initial release

Third-Party Content

This extension includes items that have been sourced from third parties as outlined below.

Additional license details are available in this plugin's licenses folder.