SET JVMENDPOINT

Enable or disable a JVM server endpoint.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

SET JVMENDPOINT

Read syntax diagramSkip visual syntax diagramSET JVMENDPOINT( endpoint-name)JVMSERVER( jvmserver)ENABLESTATUS( cvda)ENABLEDDISABLED

Conditions: INVREQ, NOTAUTH, NOTFND

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

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.