Java Management Extensions connector properties

A Java Management Extensions (JMX) connector can either be a Remote Method Invocation (RMI) connector or a Simple Object Access Protocol (SOAP) connector.

Depending on the property, you can specify or set a property in the administrative console, the wsadmin tool, Application Server commands, scripts run from a command line interface, or a custom Java administrative client program that you write. You can also set SOAP connector properties in the soap.client.props file.

For specific information on how to code the JMX connector properties for the wsadmin tool, the Application Server commands, or scripts, see the particular tool or command. For specific information on how to code the JMX connector properties for a custom Java administrative client program, see the Java API documentation for Application Server.

For the administrative console, this article specifies the coding of the particular setting or property. Coding of properties in the soap.client.props file that are specific to JMX connectors is specified. These properties begin with com.ibm.SOAP. Other properties in the soap.client.props file that contain information that can be set elsewhere in the Application Server are not documented here. The coding for the com.ibm.ssl.contextProvider property, which can be set only in the soap.client.props file, is specified.

Each profile has a property file at profile_root/properties/soap.client.props, where profile_root is the fully-qualified path of the directory that contains your profile. These property files allow you to set different properties, including security and timeout properties. These properties are the default for all administrative connections that use the SOAP JMX connector between processes executing in a particular profile. For instance, the wsadmin program executing under a particular profile uses the property values from that file for the SOAP connector behavior unless the properties are overridden by some other programmatic means. To view the JMX connector custom properties administrative console panel that goes with this article, click one of the following paths:

• Servers -> Application servers -> server name -> Server Infrastructure -> Administration -> Administration Services -> Additional properties -> JMX Connectors-> connector type -> Additional Properties -> Custom properties

• System administration -> Deployment manager -> Additional Properties -> Administration Services -> Additional Properties -> JMX Connectors-> connector type-> Additional Properties -> Custom properties

• System administration -> Node agents -> node agent name -> Additional Properties -> Administration Services -> Additional Properties -> JMX Connectors-> connector type-> Additional Properties -> Custom properties

SOAP connector properties

This section discusses
JMX connector properties that pertain to SOAP connectors.

SOAP Request timeout

The SOAP client request timeout. The value that you choose depends on a number of factors such as the size and the number of the applications that are installed on the server, the speed of your machine, and the level of usage of your machine.

The program default value for the request timeout is 600 seconds. However, other components that connect to the SOAP client can override the default. Components that use the soap.client.props file have a default value of 180 seconds. You can set the property by using one of the following options:

• Scripts run from a command line interface.

• The soap.client.props file.

  Property	com.ibm.SOAP.requestTimeout
  Data type	Integer
  Range in seconds	0 to n If the property is zero (0), the request never times out.
  Default	180

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	requestTimeout
  Data type	Integer
  Range in seconds	0 to n If the property is zero (0), the request never times out.
  Default	600

• A Java administrative client. The property is AdminClient.CONNECTOR_SOAP_REQUEST_TIMEOUT.

Configuration URL The Universal Resource Locator (URL) of the soap.client.props file. Specify the configuration URL property if you want a program to read SOAP properties from this file. You can set the property by using one of the following options:

• Scripts run from a command line interface. Scripts can pass the Configuration URL property to the Application Server on the com.ibm.SOAP.ConfigURL system property.

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	ConfigURL
  Data type	String
  Valid Value	http://Path/soap.client.props
  Default	None

• A Java administrative client. The property is AdminClient.CONNECTOR_SOAP_CONFIG.

Security context provider

The Secure Sockets Layer (SSL) implementation to use between the Application Server and the SOAP client. You can specify either IBM Java Secure Sockets Extension (IBMJSSE) or IBM Java Secure Sockets Extension that has undergone Federal Information Processing Standards certification (IBMJSSEFIPS). You can set the property by using the soap.client.props file.

Property	com.ibm.ssl.contextProvider
Data type	String
Valid Values	IBMJSSE IBMJSSEFIPS IBMJSSE2
Default	IBMJSSE2

Secure Sockets Layer (SSL) security Use this property to enable SSL security between Application Server and the SOAP client. You can set the property by using one of the following options:

• Scripts run from a command line interface.

• The soap.client.props file.

  Property	com.ibm.SOAP.securityEnabled
  Data type	Boolean
  Default	False

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	securityEnabled
  Data type	Boolean
  Default	False

• A Java administrative client. The property is AdminClient.CONNECTOR_SECURITY_ENABLED.

SOAP and RMI connector properties

This section discusses
JMX connector properties that pertain to both SOAP connectors and RMI connectors.

Connector type Specify a connector type of SOAP or RMI, depending on whether Application Server connects to a SOAP server or an RMI server. You can set the property by using one of the following options:

• The wsadmin tool.

• Scripts run from a command line interface.

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	Type
  Data type	String
  Valid values	SOAPConnector RMIConnector
  Default	SOAP

• A Java administrative client. The property is AdminClient.CONNECTOR_TYPE. Specify by using the AdminClient.CONNECTOR_TYPE_RMI or the AdminClient.CONNECTOR_TYPE_SOAP constants.

Host Use the host property to specify the host name or the IP address of the server to which Application Server connects. The server can be a SOAP server or an RMI server. You can set the property by using one of the following options:

• The wsadmin tool.

• Scripts run from a command line interface.

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	host
  Data type	String
  Valid values	Host name or IP address
  Default	None

• A Java administrative client. The property is AdminClient.CONNECTOR_HOST.

Port Use the port property to specify the port number of the server to which Application Server connects. The server can be a SOAP server or an RMI server. You can set the property by using one of the following options:

• The wsadmin tool.

• Scripts run from a command line interface.

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	port
  Data type	Integer
  Valid value	Port number
  Default	None

• A Java administrative client. The property is AdminClient.CONNECTOR_PORT.

User name The user name that Application Server uses to access the SOAP server or the RMI server. You can set the property by using one of the following options:

• The wsadmin tool.

• Scripts run from a command line interface.

• The soap.client.props file.

  Property	com.ibm.SOAP.loginUserid
  Data type	String
  Valid value	The value must match the global SSL settings for SOAP or RMI.
  Default	None

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	username
  Data type	String
  Valid value	The value must match the global SSL settings for SOAP or RMI.
  Default	None

• A Java administrative client. The property is AdminClient.USERNAME.

Password The password that Application Server uses to access the SOAP server or the RMI server. You can set the property by using one of the following options:

• The wsadmin tool.

• Scripts run from a command line interface.

• The soap.client.props file.

  Property	com.ibm.SOAP.loginPassword
  Data type	String
  Valid values	The value must match the global SSL settings for SOAP or RMI.
  Default	None

• The administrative console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the administrative console.

  Property	password
  Data type	String
  Valid values	The value must match the global SSL settings for SOAP or RMI.
  Default	None

• A Java administrative client. The property is AdminClient.PASSWORD.