corda.p2p.gateway heading-link-icon

Configuration schema for the P2P gateway.

  • connectionConfig - Settings for the TCP connection pool to peer gateways.
    • acquireTimeout - The time, in seconds, after which a connection request fails.
      Default value: 10
      Minimum value: 1
      Maximum value: 3000
    • connectionIdleTimeout - The time, in seconds, after which an inactive connection in the pool will be released (closed).
      Default value: 60
      Minimum value: 1
      Maximum value: 3000
    • initialReconnectionDelay - The initial time, in seconds, to wait before trying to reconnect.
      Default value: 1
      Minimum value: 1
      Maximum value: 3000
    • maxClientConnections - The maximum size of the connection pool.
      Default value: 100
      Minimum value: 1
      Maximum value: 10000
    • maxReconnectionDelay - The maximum time, in seconds, to delay before trying to reconnect.
      Default value: 16
      Minimum value: 1
      Maximum value: 3000
    • responseTimeout - The time, in milliseconds, after which the delivery of a message is considered failed.
      Default value: 3000
      Minimum value: 100
      Maximum value: 10000
    • retryDelay - The time, in milliseconds, after which a message that previously failed is retried.
      Default value: 2000
      Minimum value: 100
      Maximum value: 10000
  • maxRequestSize - The maximum request size, in bytes, accepted by the gateway. The gateway rejects requests larger than the specified size.
    Default value: 500000000
    Minimum value: 10000000
    • serversConfiguration - A list of HTTP servers that Corda listens to. The list is specified as an array of hostAddress, hostPort, and urlPath values.
      • hostAddress - The hostname or IP address where the HTTP server will bind.
        Default value: 0.0.0.0
      • hostPort - The HTTP port of the server.
        Default value: 8080
        Minimum value: 0
        Maximum value: 65535
      • urlPath - The URL path the gateway server will listen on.
        Default value: /
      • sslConfig - Settings for TLS connections between gateways.
        • revocationCheck - The type of revocation check for the TLS certificate.
          • mode This must be set to one of the following values:
            • SOFT_FAIL - The revocation check succeeds if the revocation status cannot be determined under certain circumstances. See java.security.cert.PKIXRevocationChecker.Option.SOFT_FAIL Javadoc for more details.
            • HARD_FAIL - The opposite of SOFT_FAIL. This is the most rigorous check. Amongst other requirements, this check requires that the CRL checking URL is available on every level of certificate chain.
            • OFF - Disables the CRL check.
            Default value: SOFT_FAIL
        • tlsType - The type of TLS connections to establish between the gateways in the cluster and gateways in other clusters. This setting MUST be the same on all gateways that communicate via HTTPS. This must be set to one of the following values:
          • ONE_WAY - Establishes a regular TLS connection, where the server gateway is authenticated.
          • MUTUAL - Establishes a mutual TLS connection, where both the server and client gateway are authenticated.
          Default value: ONE_WAY

      Was this page helpful?

      Thanks for your feedback!

      Chat with us

      Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

      Propose documentation improvements directly

      Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

      We're sorry this page wasn't helpful. Let us know how we can make it better!

      Chat with us

      Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

      Create an issue

      Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

      Propose documentation improvements directly

      Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.