Setting Transport Properties

Procedure

  1. Select the Gateway Engine Properties from the drop-down list.
  2. Click the Transport link.
    Transport Properties
    Property Description
    Facade
    Port Specifies the port through which the gateway accepts the HTTP requests from the client.

    The default value is 9222.

    Active Spaces
    Transport Type Type of the transport for Global Throttle Manager and Central Logger. Select AS from the drop-down list.
    Metaspace Name The name of the ActiveSpaces Metaspace to connect to. A metaspace is a logical group of spaces—a cluster of hosts and processes that share the same metaspace name and set of discovery transport attributes. The hosts and processes in a metaspace work together by joining the same spaces.

    Refer to TIBCO ActiveSpaces Developer's Guide for details on Metaspaces.

    The default value for the metaspace name is GTM.

    Discovery URL Specifies the discovery URL to use to discover spaces in the cluster. The TCP discovery has the following format:

    tcp://ip1[:port1];ip2[:port2],...

    where any number of ip[:port] well-known addresses can be listed. If no port is specified, the default port number value of 50000 is assumed.

    For example, tcp://127.0.0.1:13000.

    Refer to TIBCO ActiveSpaces Developer's Guide for details on the discovery URLs.

    Listen URL Specifies a URL that is used for direct communication between the members of the metaspace.

    To use a listen URL, use a string of the form:

    tcp://[interface[:port]]

    This syntax specifies that the member should bind to the specified interface and the specified port when creating the TCP socket that will be used for direct communication between the members of the metaspace. If not specified, it will default to 0.0.0.0 (INADDR_ANY) for the interface and to the first available port starting from port 5000 and above.

    For example, tcp://127.0.0.1:13000-*/

    Log Level The logging level of the messages when the ActiveSpaces channel is used.

    The default value is INFO.

    The possible values are as follows:

    INFO

    WARN

    ERROR

    FATAL

    FINE

    FINER

    FINEST

    NONE

    Log Directory The directory to store the log files. The log files contain the messages when the ActiveSpaces channel is used.

    The default value is ASG_CONFIG_HOME/logs

    For example,

    C:/TIBCO_HOMEAPIXCONFIG/tibco/cfgmgmt/asg/logs

    SSL
    Port Specifies the port through which the gateway accepts SSL enabled HTTP requests from client.

    The default value is 9233.

    Use SSL This is a boolean field which indicates if SSL should be enabled for accepting the HTTPS requests. If this is set to true, SSL is enabled to accept the requests using the HTTPS transport.
    Identity Resource Specifies an identity resource which is used by FacadeHTTPSSLConnection HTTP shared resource to provide the SSL properties.
    Identity File Type Specifies the type of identity resource.

    The possible values are as follows:

    • Identity File
    • Certificate/Private Key
    • If Identity File Type is of the Identity File type, enter the Identity Type, Identity URL, and Identity File Password parameters.
    • If Identity File Type is of the Certificate/Private Key type, enter Certificate URL, Key URL, and Key Password parameters.
    Identity Type Specifies the type of the keystore if the Identity File Type is of the Identity File type. The supported values are as follows:
    • JCEKS
      JKS
      PEM
      PKCS12
    Identity URL Specifies the URL to the identity file if Identity File Type is of the Identity File type.

    For example, C:\asgserver.pfx

    Identity File Password Specifies the password for the identity file used for the SSL connection if Identity File Type is of the Identity File type.
    Certificate URL Specifies the URL to the certificate file if Identity File Type is of the Certificate/Private Key type.
    Key URL Specifies the URL to the private key in the certificate file if Identity File Type is of the Certificate/Private Key type.
    Key Password Specifies the password for the private key used for the SSL connection if Identity File Type is of the Certificate/Private Key type.
    Requires Client Authentication Indicates a Boolean flag to enable or disable mutual SSL authentication for HTTPs transport between the client and the gateway.

    When this field is set to true, the Trusted Certificates Folder becomes enabled so that you can specify a location containing the list of trusted certificate authorities.

    Truststore Password Specifies the password to access the certificate stored in the folder defined by Trusted Certificate Folder field.
    Trusted Certificate Folder Specifies a folder containing one or more certificates from trusted certificate authorities, which is required for mutual SSL authentication.

    Required when the RequiresClientAuthentication property is set to true.

    JMS Facade ESB Connection
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from the ESB communication domain. The ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade operation requests with ESB communication domain.

    The default value is tibjmsnaming://localhost:7222

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for ESB channel (one) communication for the response from the target operation.

    The default value is asg.out.request.reply.0.0.

    JMS Target ESB Connection Primary
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from ESB communication domain. ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade operation requests with ESB communication domain.

    The default value is tibjmsnaming://localhost:7222.

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for the ESB channel (one) communication for the response from the target operation.

    The default value is asg.out.request.reply.0.0.

    JMS Target ESB Connection Secondary
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from the ESB communication domain. The ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade operation requests with ESB communication domain.

    The default value is tibjmsnaming://localhost:7222.

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for ESB channel (one) communication for the response from the target operation.

    The default value is asg.out.request.reply.0.0.

    JMS Target ESB Connection Tertiary
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from the ESB communication domain. The ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade client requests with the ESB communication domain.

    The default value is tibjmsnaming://localhost:7222.

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for ESB channel (one) communication for the response from the target operation.

    The default value is asg.out.request.reply.0.0.

    JMS SOAP Connection North
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from the ESB communication domain. The ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade client requests with the ESB communication domain.

    The default value is tibjmsnaming://localhost:7222.

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for the ESB channel (one) communication for the response from the target operation.

    The default value is asg.out.request.reply.0.0.

    JMS SOAP Connection South
    JMS Provider URL Specifies the connection URL for the EMS Server used for facade operation requests from the ESB communication domain. The ESB communication uses JMS transport with XML.

    The default value is tcp://localhost:7222.

    JNDI Context URL Specifies the URL to the JNDI service provider used for facade client requests with the ESB communication domain.

    The default value is tibjmsnaming://localhost:7222.

    Topic Connection Factory Name Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with ESB services at the facade side.

    The default value is TopicConnectionFactory.

    Queue Connection Factory Name Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with ESB services at the facade side.

    The default value is QueueConnectionFactory.

    JNDI Username Specifies the user name for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.

    The default value is admin.

    JNDI Password Specifies the password for logging into the JNDI server in the ESB communication domain at the facade side. If the JNDI provider does not require access control, this field can be empty.
    JMS Username Specifies the user name for logging into the EMS server in the ESB communication domain at the facade side.

    The default value is admin.

    JMS Password Specifies the password for logging into the EMS server in the ESB communication domain at the facade side.
    Request Queue Specifies the queue name for an ESB channel (one) communication for the target operation request.

    The default value is asg.out.request.

    Reply Queue Specifies the queue name for an ESB channel (one) communication for the response from the target response.

    The default value is asg.out.request.reply.0.0.

    Show SSLProperties

    Use the Show SSL Properties button to configure the SSL connection parameters for JMS transport at the facade and target side.

    Use SSL A boolean field to indicate if SSL is enabled for accepting requests using the JMS transport.

    Set this to true to enable SSL for the JMS transport.

    Trusted Certificate Folder Specifies a location of the trusted certificates on this machine. The trusted certificates are a collection of certificates from servers with which you establish connections. If the server with which the connection is going to be established, presents a certificate that does not match one of your trusted certificates, the connection is refused. This prevents connections to unauthorized servers.

    Import the trusted certificates into a folder before you select the folder in this field.

    Identity Resource Specifies an identity resource used to provide the SSL properties for JMS transport.

    For example,

    /DefaultImplementation/SharedResources/JMS/Target_ESB0ConnIdentityResource.id

    TrustStorePassword Specifies the password to access the certificate stored in the folder defined by the Trusted Certificate Folder field.
    Trace Specifies whether SSL tracing should be enabled during the connection. If checked, the SSL connection messages are logged and sent to the console.
    Debug Trace Specifies whether SSL debug tracing should be enabled during the connection. Debug tracing provides more detailed messages than standard tracing.
    Verify Host Name Specifies whether the host you are connecting to is the expected host. The host name in the host’s digital certificate is compared against the value in the Expected Host Name field. If the host name does not match the expected host name, the connection is refused.

    Note: The default context factories for TIBCO Enterprise Message Service automatically determine if host name verification is necessary. If you are using a custom implementation of the context factories, your custom implementation must explicitly set the verify host property to the correct value. For example:

    com.tibco.tibjms.TibjmsSSL.setVerifyHost(false)
    Expected Host Name Specifies the name of the host you are expecting to connect to. This field is only relevant if the Verify Host Name field is also selected.

    If the name of the host in the host’s digital certificate does not match the value specified in this field, the connection is refused.

    This prevents hosts from attempting to impersonate the host you are connecting to.

    Strong Cipher Suites Only When selected, this field specifies that the minimum strength of the cipher suites used can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information about this property. The default value of the property disables cipher suites with an effective key length below 128 bits.

    When this field is unchecked, only cipher suites with an effective key length of up to 128 bits can be used.

    Identity Type Speicifies the type of identity resource. The possible values are:
    • certPlusKeyURL
    • url
    • usernamePassword
    Certificate/Private Key Identity

    Use this option if the private key and the certificate are in two separate files.

    Certificate URL Specifies the URL to the certificate file if the Identity Type is of the certPlusKeyURL type.
    Key URL Specifies the URL to the private key in the certificate file if the Identity Type is of the certPlusKeyURL type.
    Key Password Specifies the password for the private key used for SSL connection if the Identity Type is of the certPlusKeyURL type.
    Username/Password

    Use this option if you want to use a username and password for authentication instead of a certificate.

    Identity User Name Name of the user for this identity.
    Identity Password Password for the user for this identity.
    url

    Use this option if the certificate includes the private key information in the same file.

    Identity URL Specifies the location of the certificate (which includes the private key) if Identity Type is of url type.

    For example, C:\asgserver.pfx

    Identity File Type Specifies the type of certificate file if Identity Type is of url type.

    Choose the certificate file type from the drop-down list:

    • Entrust
    • JCEKS
    • JKS
    • PEM
    • PKCS12
    Key Password Password for the certificate if Identity Type is of url type.