The Framework service hosts a single HTTP server for all Web services, including Web services that are part of the API. The Web server is started as soon as the Framework service activates, and initially has a single HTTPS connector available for the API on port 8449. The HTTPS connector, by default, uses the same private key as the Management Console, but this can be also configured independently of the Management Console from the rhapsody.properties file.

The following parameters can be configured in the rhapsody.properties file:

Parameter Name

Description

Default

WebServiceApi.httpsPort

The HTTPS port that the Rhapsody Web Service API is hosted on. The API is disabled if this is less than or equal to 0.

8449

WebServiceApi.ssl.keystore

The filename of the keystore containing the private key and certificate to use for the HTTPS connector. This can either be absolute or relative to the Rhapsody base directory.

monitoring.keystore

WebServiceApi.ssl.password

The password for the keystore file.

 

WebServiceApi.ssl.keypassword

The password for the keys within the keystore file.

 

WebServiceApi.ssl.keystoretype

The type of keystore in use.

JKS

WebServiceFramework.MaxHttpListenerThreads

The maximum number of threads in the pool used to service these requests.

20

WebServiceFramework.MaxHttpConnections

The maximum number of simultaneous outgoing HTTP connections.

200

WebServiceFramework.MaxHttpConnectionsPerHost

The maximum number of simultaneous outgoing HTTP connections to the same host/port.

10

 
WebServiceApi.ssl.protocol

The SSL protocol for the Web Service API.

 
TLSv1
 
WebServiceApi.WebServiceApi.cipherSuiteStrength

The ciphers suites for the Web Service API:

  • VERY_STRONG
  • FIPS
  • STRONG
 
FIPS

A restart is required in order for Rhapsody to pick up changes in the rhapsody.properties file.

Customizing the Default Key Using a PKCS#12 Key

A private key is required in order to use the API. By default, the API uses the Management Console key.

PKCS#12 is a standard for storing private keys and certificates securely. PKCS#12 is a .pfx file that contains a private key and a certificate chain. You can configure a PKCS#12 key by setting a few properties in the rhapsody.properties file.

Example

WebServiceApi.ssl.keystoretype=PKCS12
WebServiceApi.ssl.keypassword=password
WebServiceApi.ssl.password=password
WebServiceApi.ssl.keystore=Rhapsody.pfx

Generally, the key and store passwords are identical for PKCS#12 keystores. This is not normally the case for other keystore types.

Related Topics