Java Management Extensions connector properties

 

+

Search Tips   |   Advanced Search

 

We can set JMX connector properties using...

• Administrative console
• wsadmin
• Application Server commands
• Command-line interface scripts
• Custom Java admin client program

We can set SOAP connector properties in soap.client.props and IPC connector properties in ipc.client.props.

A JMX connector can be...

• Remote Method Invocation (RMI) connector
• SOAP connector
• JMX Remote API (JSR 160) RMI (JSR160RMI) connector
• IPC connector

Deprecated feature: You should eventually convert all of the RMI connectors to JSR160RMI connectors because support for the RMI connector is deprecated.

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

The JMX connectors that servers create use JMX connector properties that are accessible in the admin console. To change the configuration for JMX connectors in the console...

Servers | Application Servers | myserver | Administration | Administration Services | JMX Connectors
Servers | JMS Servers | myserver | Administration | Administration Services | JMX Connectors

The wsadmin tool and the Java administrative client use JMX connector properties in the files...

• soap.client.props
• ipc.client.props
• sas.client.prop

Properties in soap.client.props and ipc.client.props begin with com.ibm.SOAP and 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 appserver are not documented here. The coding for the property...

com.ibm.ssl.contextProvider

...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...

WAS_HOME/profiles/profile/properties/soap.client.props

For the IPC connector:

WAS_HOME/profiles/profile/properties/ipc.client.props

These property files allow us to set different properties, including security and timeout properties. These properties are the default for all the admin 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 panel...

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

 

SOAP connector properties

• 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 the machine, and the usage of the 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.

    ### Set SOAP timeout
    name = ["name", "requestTimeout"]
    value = ["value", "6000"]
    attrs = []
    attrs.append(name)
    attrs.append(value)
    
    AdminConfig.modify('(cells/Cell1/nodes/Dmgr01/servers/dmgr|server.xml#Property_8)', attrs)

  • 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.

• Configuration URL

  Use 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 appserver on the system property...

    com.ibm.SOAP.ConfigURL

  • 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 property...

    AdminClient.CONNECTOR_SOAP_CONFIG

• Security context provider

  Indicates the SSL implementation to use between the appserver 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

• SSL security

  Use this property to enable SSL security between the appserver 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 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	securityEnabled
    Data type	Boolean
    Default	False

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

• SSL alias

  Alia 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

• 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 the machine, and the usage of the 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.

• Configuration URL

  Read IPC 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 appserver 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.

• Security context provider

  SSL implementation to use between the appserver 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 security

  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 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	securityEnabled
    Data type	Boolean
    Default	False

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

• 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 SOAP connectors, RMI connectors, JSR160RMI connectors, and IPC connectors.

Connector type

A connector type of SOAP, RMI, JSR160RMI, or IPC depends on whether the appserver connects to a SOAP server, an RMI server, a JSR160RMI server, or an IPC server.

Use 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	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.

Host The host name or the IP address of the server to which the appserver 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.

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 appserver 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 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	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.

The password that the appserver 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 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	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.

Disable a connector

We can enable or disable any of the JMX connectors from the admin 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

 

RMI connector properties

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

Disable the JSR 160 RMI connector

Support for JMX Remote API (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

---

Related concepts

Additional Application Programming Interfaces (APIs)

 

Related tasks

Set up the admin architecture
Set security with scripting

 

Related

Java Management Extensions connectors
Administrative properties for scripting

 

Related information

SOAP connector and Inter-Process Communications connector properties files