SET JVMENDPOINT
Enable or disable a JVM server endpoint.
Description
The SET JVMENDPOINT SPI can be used to enable or disable JVM HTTP or JMS endpoints.
If an endpoint cannot be set the SPI returns an INVREQ response with the RESP2 code set to 15, indicating that the state of the endpoint cannot be changed.
Important: Avoid using special characters in Liberty endpoint names when using the
JVMENDPOINT SPI.
Options
- JVMENDPOINT(endpoint-name)
- The name of the endpoint as defined by the JVMSERVER. For Liberty endpoints, this is the
id
attribute of the element the endpoint as configured in server.xml. Any trailing whitespace in this element, which is case-sensitive, is removed. - JVMSERVER(jvmserver)
- The 8-character name of the JVMSERVER the endpoint is defined in. This is required.
- ENABLESTATUS(cvda)
- The CVDA value representing the desired status of the endpoint. Valid values are:
- ENABLED
- Specifies the endpoint should be enabled and start listening for requests.
- DISABLED
- Specifies the endpoint should be disabled and stop listening to requests.
Conditions
- INVREQ
- RESP2 values:
- 2
- The ENABLESTATUS value is not valid.
- 15
- The ENABLESTATUS of the JVMENDPOINT cannot be changed.
- 16
- The SET command failed to change the ENABLESTATUS of the JVMENDPOINT. Check the JVM server log file for more information.
- NOTAUTH
- RESP2 values:
- 100
- The user associated with the issuing task is not authorized to use this command.
- 101
- The user associated with the issuing task is not authorized to access this JVMSERVER.
- NOTFND
- RESP2 values:
- 1
- The named JVMSERVER resource cannot be found or is not enabled.
- 3
- The named JVMENDPOINT cannot be found.