Java Management Extensions connector properties

Network Deployment (Distributed operating systems), v8.0 > Reference > Custom properties

Java Management Extensions connector properties

We can specify or set a property in the administrative console, wsadmin.sh, Application Server commands, the scripts that run from a command-line interface, or a custom Java administrative client program that you write. We can also set SOAP connector properties in the soap.client.props file and IPC connector properties in the ipc.client.props file.
A JMX connector can be a RMI connector, a Simple Object Access Protocol (SOAP) connector, a JMX Remote application programming interface (JSR 160) Remote Method Invocation (JSR160RMI) connector, or an Inter-Process Communications (IPC) connector.
Deprecated feature: You should eventually convert all of your RMI connectors to JSR160RMI connectors because support for the RMI connector is deprecated.depfeat
For specific information on how to code the JMX connector properties for wsadmin.sh, the Application Server commands, or scripts, see the particular tool or command. Read the application programming interfaces documentation to learn how to code the JMX connector properties for a custom Java administrative client program.
The JMX connectors that servers create use JMX connector properties that are accessible in the admin console. The wsadmin tool and the Java administrative client use JMX connector properties in the soap.client.props, ipc.client.props, and sas.client.prop files.
For the admin console, this topic specifies the coding of the particular setting or property. Coding of properties in the soap.client.props file and the ipc.client.props file that are specific to JMX connectors is specified. These SOAP properties begin with com.ibm.SOAP and the IPC properties begin with com.ibm.IPC. Other properties in the soap.client.props file and the ipc.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 and the ipc.client.props file, is specified.
Each profile has property files at the following locations:

For the SOAP connector:

(Solaris) (AIX) PROFILE_ROOT/properties/soap.client.props
(Windows) PROFILE_ROOT\properties\soap.client.props

For the IPC connector:

(Solaris) (AIX) PROFILE_ROOT/properties/ipc.client.props
(Windows) PROFILE_ROOT\properties\ipc.client.props

These property files allow you to set different properties, including security and timeout properties. These properties are the default for all the administrative connections that use either the SOAP JMX connector or the IPC JMX connector between processes that run in a particular profile. For instance, the wsadmin program running under a particular profile uses the property values from these files for the SOAP connector behavior and the IPC connector behavior unless the properties are overridden by some other programmatic means.
To view the JMX connector custom properties admin console page that goes with this topic, click...
> Server Types > WebSphere application servers > server_name
> Administration > Administration services > JMX connectors > connector_type > Custom properties.

SOAP connector properties

This section discusses the following JMX connector properties that pertain to SOAP connectors:

Configuration URL
SSL security
Security context provider
SOAP request timeout
SSL alias

Configuration URL
Specify the configuration Universal Resource Locator (URL) property if you want a program to read SOAP properties from this file. We 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 admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin console.

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

A Java administrative client. Use the AdminClient.CONNECTOR_SOAP_CONFIG property.

SSL (SSL) security
Use this property to enable SSL security between the application server and the SOAP client. Set the property by using one of the following options:

Scripts that 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 admin console.

Property securityEnabled
Data type Boolean
Default False

A Java administrative client. Use the AdminClient.CONNECTOR_SECURITY_ENABLED property.

Security context provider
This property indicates the SSL implementation to use between the application server and the SOAP client.
Set the property by using the soap.client.props file.
Property com.ibm.ssl.contextProvider
Data type String
Valid Values
IBMJSSE2
Default IBMJSSE2
SOAP 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 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.
Set the property by using one of the following options:

Scripts that 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 admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin 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.

SSL alias
This property specifies the alias to use for an SSL configuration for client connections. The value of the alias is what you want it to be.
Set the property in the soap.client.props file.

Property com.ibm.ssl.alias
Data type String
Default DefaultSSLSettings

IPC connector properties

This section discusses the following JMX connector properties that pertain to IPC connectors:

Configuration URL
IPC request timeout
SSL security
Security context provider
SSL alias

Configuration URL
Specify the configuration URL property if you want a program to read IPC properties from this file. We 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.IPC.ConfigURL system property.
The admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin console.

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

A Java administrative client. Use the AdminClient.CONNECTOR_IPC_CONFIG property.

IPC 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 usage of your machine.
The program default value for the request timeout is 600 seconds. However, other components that connect to the IPC client can override the default. Components that use the ipc.client.props file have a default value of 180 seconds.
Set the property by using one of the following options:

Scripts that run from a command-line interface.
The ipc.client.props file.

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

The admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin 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_IPC_REQUEST_TIMEOUT.

SSL security
Use this property to enable SSL security between Application Server and the IPC client. Set the property by using one of the following options:

Scripts that run from a command-line interface.
The ipc.client.props file.

Property com.ibm.IPC.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 admin console.

Property securityEnabled
Data type Boolean
Default False

A Java administrative client. Use the AdminClient.CONNECTOR_SECURITY_ENABLED property.

Security context provider
This property indicates the SSL implementation to use between the application server and the IPC client.
Set the property by using the ipc.client.props file.
Property com.ibm.ssl.contextProvider
Data type String
Valid Values
IBMJSSE2
Default IBMJSSE2
SSL alias
This property specifies the alias to use for an SSL configuration for client connections. The value of the alias is what you want it to be.
Set the property in the ipc.client.props file.

Property com.ibm.ssl.alias
Data type String
Default DefaultSSLSettings

SOAP, RMI, JSR160RMI, and IPC connector properties

This section discusses JMX connector properties that pertain to the following SOAP connectors, RMI connectors, JSR160RMI connectors, and IPC connectors:

Connector type
Disable a connector
Host
Password
Port
User name

Connector type
A connector type of SOAP, RMI, JSR160RMI, or IPC depends on whether the application server connects to a SOAP server, an RMI server, a JSR160RMI server, or an IPC server. We can set the property by using one of the following options:
The wsadmin tool.
Scripts that 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 admin console.
Property Type
Data type String
Valid values
SOAPConnector
RMIConnector
JSR160RMIConnector
IPCConnector
Default SOAPConnector JSR160RMI IPC
A Java administrative client. Use the AdminClient.CONNECTOR_TYPE property. Specify the connector type by using the AdminClient.CONNECTOR_TYPE_RMI, the AdminClient.CONNECTOR_TYPE_SOAP, the AdminClient.CONNECTOR_TYPE_JSR160RMI, or the AdminClient.CONNECTOR_TYPE_IPC constants.
Disable a connector
You can enable or disable any of the JMX connectors from the administrative console.

The wsadmin tool.
The admin console. Select the box next to the connector to enable the connector. Clear the box next to the connector to disable the connector.

Property enabled
Data type Boolean
Value true|false

Host
The host name or the IP address of the server to which the application server connects. The server can be a SOAP server, an RMI server, a JSR160RMI server, or an IPC server. We can set the property by using one of the following options:

The wsadmin tool.
Scripts that run from a command-line interface.
The admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin console.

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

A Java administrative client. Use the AdminClient.CONNECTOR_HOST property.

Password
The password that the application server uses to access the SOAP server, the RMI server, the JSR160RMI server, or the IPC server. We 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 for the SOAP server, the RMI server, or the JSR160RMI server.

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

The ipc.client.props file for the IPC server.

Property com.ibm.IPC.loginPassword
Data type String
Valid values The value must match the global SSL settings for IPC.
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 admin console.

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

A Java administrative client. Use the AdminClient.PASSWORD property.

Port
The port number of the server to which the application server connects. The server can be a SOAP server, an RMI server, a JSR160RMI server, or an IPC server. We can set the property by using one of the following options:

The wsadmin tool.
Scripts run from a command-line interface.
The admin console. Specify the property and the value as a name-value pair on the JMX connector custom properties panel of the admin console.

Property port
Data type Integer
Valid value Port number
Default None

A Java administrative client. Use the AdminClient.CONNECTOR_PORT property.

User name
The user name that the application server uses to access the SOAP server, an RMI server, a JSR160RMI server, or an IPC server. We 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 for the SOAP server, an RMI server, a JSR160RMI server.

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

The ipc.client.props file for the IPC server.

Property com.ibm.IPC.loginUserid
Data type String
Valid value The value must match the global SSL settings for IPC.
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 admin console.

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

A Java administrative client. Use the AdminClient.USERNAME property.

RMI connector properties

This section discusses the following JMX connector properties that pertain to RMI connectors:

Disable the JSR 160 RMI connector

Disable the JSR 160 RMI connector
Support for JMX Remote application programming interface (JSR 160) is enabled by default so that you automatically receive specification-compliant JMX function.
To disable the function for a particular server, set the property by using one of the following options:

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

Property disableJDKJMXConnector
Data type string
Value true

Additional Application Programming Interfaces (APIs)
Administer nodes and resources
Configure security with scripting

Related

JMX connectors
Administrative properties for using wsadmin.sh
SOAP connector and Inter-Process Communications connector properties files

+
Search Tips | Advanced Search

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

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

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

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

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

Property	com.ibm.ssl.alias
Data type	String
Default	DefaultSSLSettings

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

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

Property	Type
Data type	String
Valid values	SOAPConnector RMIConnector JSR160RMIConnector IPCConnector
Default	SOAPConnector	JSR160RMI	IPC

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

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

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

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

Property	port
Data type	Integer
Valid value	Port number
Default	None

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

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

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