Configuring the HTTP adapter
Adapter type: ro-adapter-http_20.15.02.00
Default adapter name: HTTPAdapter
The Properties field in the adapter configuration of Grid Manager is a required field. If the default values are acceptable for all elements, you can enter a configuration node, <config/>
, in the Properties field. When you set a configuration node, the adapter uses the default values for all the elements. If you use a proxy server for Internet connectivity, use the proxy settings shown in the <config>
section in the XML sample of the HTTP adapter configuration. If your environment does not require a proxy server, you can set a configuration node.
BMC recommends that you do not include unused elements in the adapter configuration because they might cause the adapter to enter a fault state.
To configure the HTTP adapter, see Configuring base adapters.
The following table describes the adapter configuration elements for the HTTP adapter that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column.
Configuration node elements for the HTTP adapter
UI label | Element | Description | Required |
---|---|---|---|
Data Format |
| Specifies the format for the output | No |
Request Timeout |
| Specifies the time (in seconds) to wait when establishing a connection | No |
Character Set |
| Specifies the supporting CharSet | No |
None |
| Contains the elements that define the HTTP proxy settings Note: To configure | No |
None |
| Indicates whether to use NTLM authentication for the specified user credentials with proxy server settings | No |
None |
| Specifies the host name or the IP address of the destination host (proxy server) for the HTTP request | Conditional; required if you use |
None |
| Specifies the destination port on the proxy server for the HTTP request | Conditional; required if you use |
None |
| Specifies the name of the user to access the proxy server | Conditional; specify |
None |
| Specifies the password for the specified user name | Conditional; specify |
None |
| Contains the elements that specify information about the public key (X.509 certificate) and the private key that are used for the digital signature
| No |
None |
| Specifies the path to the JKS that contains the client certificate | Conditional; required when the signature mode is keystore |
None |
| Specifies the password of the key contained in the JKS | No |
None |
| Specifies the password to the JKS | Conditional; required when the signature mode is keystore |
None |
| Specifies the name of the alias in the JKS that identifies the Public Key Certificate (PKC), which the web server uses to authenticate the client | Conditional; required when the signature mode is keystore |
None |
| Specifies the file containing the private key, which is used to sign the HTTP request
| Conditional; required when the signature mode is key-files |
None |
| Specifies the file containing the public key (X509 Certificate)
| Conditional; required when the signature mode is key-files |
None |
| Contains an XML specifying the private key in an Base64-encoded PEM format | Conditional; required when the signature mode is key-data |
None |
| Contains an XML specifying the public key (X509 Certificate) in an Base64-encoded PEM format | Conditional; required when the signature mode is key-data |
Enable Json Conversion |
| Specifies whether the adapter should treat the input data in the request and the data received in the adapter response as a JavaScript Object Notation (JSON) string
| |
Enable Redirects |
| Specifies whether the adapter should redirect a URL request to the changed URL location If you specify | No |
Download attachment |
| Specifies whether the adapter should display the content of the attached file in the adapter response or save the content in a file | No |
Download directory |
| Specifies the full path where the attached file must be downloaded | No |
The following figure shows an XML template for the HTTP adapter configuration.
XML template of the HTTP adapter configuration
<config>
<data-format></data-format>
<request-timeout></request-timeout>
<character-set></character-set>
<proxy-settings>
<host></host>
<port></port>
<user-name></user-name>
<password></password>
<proxy-ntlm-authentication></proxy-ntlm-authentication>
</proxy-settings>
<enable-json-conversion></enable-json-conversion>
<enable-redirects></enable-redirects>
</config>
The following figure shows an XML sample for the HTTP adapter configuration. As seen in the figure, to resolve proxy settings errors, enter the proxy settings for the Internet connection. To resolve authentication errors, enter a valid username and password.
XML sample of the HTTP adapter configuration
<config>
<data-format>HTML</data-format>
<request-timeout>15</request-timeout>
<character-set>utf-8</character-set>
<proxy-settings>
<host>10.10.75.120</host>
<port>3128</port>
<user-name>jones</user-name>
<password>bmc1234</password>
<ntlm-authentication>true</ntlm-authentication>
<proxy-ntlm-authentication>true</proxy-ntlm-authentication>
</proxy-settings>
<enable-json-conversion>true</enable-json-conversion>
<enable-redirects>true</enable-redirects>
</config>
The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode
is keystore.
XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is keystore
<config>
<signature-properties mode="keystore">
<keystore-file>filePath\server.jks</keystore-file>
<keystore-password>changeit</keystore-password>
<alias>1</alias>
<key-password>abcdef</key-password>
</signature-properties>
</config>
The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode
is key-files.
XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is key-files
<config>
<signature-properties mode="key-files">
<private-key-file>filePath\serverkey.pem</private-key-file>
<certificate-file>filePath\server.pem</certificate-file>
</signature-properties>
</config>
The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode
is key-data.
XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is key-data
<config>
<signature-properties mode="key-data">
<private-key-data>-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQDbDkji1X+Bxv7WLI5yaFTFsWgBtLPlm7x0O9iACBycLKelOZJl
....
m57VRInEsLbXpJHoPISk8Gj+JL/CGK7rIcDtPebLIEs=
-----END RSA PRIVATE KEY-----</private-key-data>
<certificate-data>-----BEGIN CERTIFICATE-----
MIICvzCCAigCAQEwDQYJKoZIhvcNAQEEBQAwga0xCzAJBgNVBAYTAlVTMREwDwYD
....
nSYYODyuU/pfV9V+qS+p/kwk/UKgEiwnngPEFn7v3zAzXmE=
-----END CERTIFICATE-----</certificate-data>
</signature-properties>
</config>
The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports downloading a file.
XML sample of the HTTP adapter configuration when the adapter supports downloading a file
<config>
<download-directory>c:\tmp</download-directory>
<download-attachment>true</download-attachment>
</config>
Comments
Log in or register to comment.