INQUIRE JVMENDPOINT

Retrieve information about a JVM server endpoint.

INQUIRE JVMENDPOINT

Conditions: END, ILLOGIC, NOTAUTH, NOTFND

Description

You can retrieve the details of a JVM server endpoint by using the INQUIRE JVMENDPOINT SPI. Only Liberty server HTTP/JMS endpoints are currently supported.

Optionally, the ENABLESTATUS, TYPE, HOST, PORT, and SECPORT parameters can be supplied to elicit further endpoint details. If not specified in the Liberty configuration, HOST can be empty. If not defined in the Liberty configuration, PORT and SECPORT will be equal to -1.

To retrieve details of a single endpoint, issue the following command: INQUIRE JVMENDPOINT(data-value) JVMSERVER(data-value).

Important: Avoid using special characters in Liberty endpoint names when using the JVMENDPOINT SPI.

Browsing

You can browse through all the endpoints of a JVM server by using the browse options (START, NEXT, and END) on the INQUIRE JVMENDPOINT command that uses the browse syntax.

See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

JVMENDPOINT(data-value)

The name of the endpoint as defined by the JVMSERVER. For Liberty endpoints, this is the id property of the element the endpoint as configured in server.xml. Any trailing whitespace in this element, which is case-sensitive, is removed, and it is truncated to 224 characters.

JVMSERVER(data-value)

The 8-character name of the JVMSERVER the endpoint is defined in. This is required.

ENABLESTATUS(cvda)

Returns the CVDA value indicating the status of the endpoint. Valid values are:

ENABLED: Specifies if the endpoint is listening for requests.
DISABLED: Specifies if the endpoint is not listening for requests.

TYPE(data-area)

Returns the type of the endpoint.

PORT(data-area)

Returns the port that this endpoint is listening on. If no port is used in this endpoint, or if it is not known, then -1 is returned.

SECPORT(data-area)

Returns the secure port that this endpoint is listening on. If no secure port is used in this endpoint, or if it is not known, then -1 is returned.

HOST(data-area)

Returns the details of the TCP/IP host that this endpoint is listening on. If the endpoint is not listening on a host, or if the host is not known, then an empty string is returned.

Conditions

END

RESP2 values:

2: There are no more resource definitions of this type.

ILLOGIC

RESP2 values:

1: You have issued a START command when a browse of this resource's type is already in progress, or you have issued a NEXT or END command when a browse of this resource type is not in progress.

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 disabled.
3: The named JVMENDPOINT cannot be found.