INQUIRE OSGISERVICE

Retrieve information about OSGi services that are registered in a CICS® region.

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

INQUIRE OSGISERVICE

Conditions: END, ILLOGIC, 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).

This command is threadsafe.

Description

Use the INQUIRE OSGISERVICE command to find information about an OSGi service that is registered in a JVM server.

Browsing

You can browse through all the OSGi services that are registered in a JVM server by using the browse options, START, NEXT, and END, on INQUIRE OSGISERVICE commands. When browsing, you must specify the name of the JVMSERVER resource. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

BUNDLE(data-area)

Returns the 8-character name of the CICS BUNDLE resource that contains the OSGi service on the specified JVM server.

BUNDLEPART(data-area)

Returns the 255-character name of the part of the CICS BUNDLE resource that represents the installed OSGi bundle in the specified JVM server.

JVMSERVER(data-value)

Specifies the 8-character name of the JVMSERVER resource in which the OSGi service is registered.

OSGIBUNDLE(data-area)

Returns the 255-character symbolic name of the OSGi bundle that contains the OSGi service. In a Liberty JVM server the returned value of the OSGIBUNDLE will be null.

OSGISERVICE(data-value)

Specifies a doubleword binary value representing the ID of the OSGi service.

OSGIVERSION(data-area)

Returns the 255-character version of the OSGi bundle that defines the OSGi service.

SRVCNAME(data-area)

Returns the 255-character name of the OSGi service that is registered in the JVM server.

SRVCSTATUS(cvda)

Returns the status of the OSGi service. The status can have one of the following values:

ACTIVE: The OSGi service is available in the OSGi framework.
INACTIVE: The OSGi service is not available in the OSGi framework.

Conditions

END

RESP2 values:

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

ILLOGIC

RESP2 values:

1: You have either issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an 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 bundle.

NOTFND

RESP2 values:

1: The JVMSERVER resource cannot be found.
3: The OSGi service cannot be found.