Domain Registration by Using Configuration File

The domain and transport configuration file (DomainTransportConfig.yml) for Hawk Console contains the parameters to connect to regular and proxy domains.

For more information about proxy domains, see TIBCO Hawk Concepts Guide.

You can specify the location of the DomainTransportConfig.yml file by using the -domain_config_file option in the Hawk Console configuration file (hawkconsole.cfg). For details on options present in the hawkconsole.cfg file, see Hawk Console Configuration Options.

In the DomainTransportConfig.yml file you can specify the following elements for the connection:

domainConfiguration - The parent tag for the domain and transport configurations for Hawk Console.
Domain type - Specify whether the Hawk domain to be registered is a regular domain or a proxy domain. Based on the domain type, specify additional configuration parameters. The tags used for the domain type are:
regular - For details about fields for the proxy domain type, see Configuration Fields in DomainTransportConfig.yml for the Regular Domain Type
proxy - For details about fields for the proxy domain type, see Configuration Fields in DomainTransportConfig.yml for Proxy Domain Type
domainName - Name of the domain that is to be registered.

The following figure shows the hierarchy of the tags that can be defined in the DomainTransportConfig.yml file.

Figure 14: Hawk Console Domain and Transport Configuration Hierarchy

Domain and Transport Configuration Parameters

 

Configuration Fields in DomainTransportConfig.yml for the Regular Domain Type

Field

Description

transport

Type of transport that the Hawk domain is using. The following transport types are available:

tibtcp - TCP Transport for TIBCO Hawk
tibrv - TIBCO Rendezvous Transport
tibems - TIBCO Enterprise Message Service (EMS) Transport

Based on the transport type selected, specify transport configuration fields.

securityPolicy

Specify security policy to be applied to a domain:

COM.TIBCO.hawk.security.trusted.Trusted

or

COM.TIBCO.hawk.security.trusted.TrustedWithDomain

TCP Transport for TIBCO Hawk (tibtcp)

tcpSelfUrl

Unique socket address of the Hawk Console for connecting to the TCP Transport for TIBCO Hawk cluster. The syntax is:

<self IP>:<self port>

tcpDaemonUrl

The socket address of the Cluster Manager acting as the seed node for the TCP Transport for TIBCO Hawk cluster. The syntax is:

<cluster manager IP>:<cluster manager port>

Secure Connection Fields for TCP Transport for TIBCO Hawk

tcpSslKeyStore

Path of the key store file.

tcpSslTrustStore

Path of the trust store file.

tcpSslKeyStorePassword

Password for the key store file.

tcpSslKeyPassword

Encrypted key password.

tcpSslTrustStorePassword

Password for the trust store file.

tcpSslProtocol

Protocol for a secure connection.

The default value is TLSv1.2.

tcpSslEnabledAlgorithms

Algorithm to be used for the security protocol. You can specify multiple algorithms as comma-separated list without space.

The default value is TLS_RSA_WITH_AES_128_CBC_SHA.

TIBCO Rendezvous Transport (tibrv)

rvService

Specify the service that the Rendezvous daemon uses to convey messages on this transport. You can specify the port number as the service to be used, for example, "7474".

rvNetwork

Specify the network that the Rendezvous daemon uses for all communications involving this transport. The network parameter consists of up to three parts, separated by semicolons: network, multicast groups, and send address.

rvDaemon

Specify the socket address of the Rendezvous daemon.

TIBCO Enterprise Message Service Transport (tibems)

emsServerUrl

Specify the location of the EMS server.

emsUserName

Specify the user name to login to the EMS server.

emsPassword

Specify the password for the emsUserName.

Secure Connection Fields for TIBCO Enterprise Message Service Transport

emsSslVendor

The name of the vendor of the SSL implementation. The valid choices are

j2se (default) - Use this option when you want to use the default Java Cryptography Extension (JCE) bundled with the Java JRE.
entrust61 - Use this option when you want to use the Entrust libraries.
ibm - On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

emsSslTrace

The option enables the SSL tracing.

emsSslTrusted

The option specifies the file name of the server certificates. This option can be repeated if more than one certificate file is used.

emsSslPrivateKey

This option indicates the private key of the TIBCO Hawk component.

emsSslExpectedHostname

The name that is expected in the name of the CN field of the server certificates is specified by this option.

emsSslPassword

The password to decrypt the identity file of the Hawk component.

 

Configuration Fields in DomainTransportConfig.yml for Proxy Domain Type

Field

Description

host

URL of the domain that needs to be registered. The syntax is:

<domain IP>:<domain port>

credentials

User name and password required to log in to the domain. The syntax is

<user name>:<encrypted password>

securedChannel

Specify the value as true for connecting to the domain using a secure channel. The default value is true.

Example

For example, the following is a sample code of the DomainTransportConfig.yml file for a non-secure connection to the default domain using TCP Transport for TIBCO Hawk.

 

domainConfiguration: 
  regular:
    - domainName: default
      transport: tibtcp
      tcpSelfUrl: localhost:2581 
      tcpDaemonUrl: localhost:2561 
      tcpsecurityPolicy: ' '