INQUIRE OSGIBUNDLE

Description

Use the INQUIRE OSGIBUNDLE command to find information about an OSGi bundle that is installed in a JVM server.

Browsing

You can browse through all the OSGi bundles that are installed in a particular JVM server by using the browse options, START, NEXT, and END, on INQUIRE OSGIBUNDLE commands. When browsing, specify the JVMSERVER resource that you want to browse. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Auditing resources. The resource signature fields are BUNDLE, CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

BUNDLE(data-area)

Returns the 8-character name of the CICS BUNDLE resource that contains the deployed OSGi bundle 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.

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. The possible values are as follows:

CREATESPI

The resource definition was last changed by an EXEC CICS CREATE command.

CSDAPI

The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.

CSDBATCH

The resource definition was last changed by a DFHCSDUP job.

DREPAPI

The resource definition was last changed by a CICSPlex SM BAS API command.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS® release that was running when the resource definition was last changed.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

JVMSERVER(data-value)

Specifies the 8-character name of the JVMSERVER resource in which the OSGi bundle is installed.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. Only one value is possible:

BUNDLE

The resource was installed by a bundle deployment.

INSTALLTIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

OSGIBUNDLE(data-value)

Specifies the 255-character symbolic name of the OSGi bundle.

OSGIBUNDLEID(data-area)

Returns a doubleword binary value of the bundle ID in the OSGi framework.

OSGISTATUS(cvda)

Returns the status of the OSGi bundle. The status can be one of the following values:

ACTIVE

The bundle has been successfully activated and is running; its bundle activator start method has been called and returned.

INSTALLED

The OSGi bundle has successfully installed.

RESOLVED

All Java classes that the bundle requires are available. This state indicates that the bundle is either ready to be started or has stopped.

STARTING

The bundle is being started in the OSGi framework. The bundle activator start method is called but has not yet returned. When the bundle has an activation policy, the bundle remains in the STARTING state until the bundle is activated according to its activation policy.

STOPPING

The bundle is being stopped in the OSGi framework. The bundle activator stop method is called but has not yet returned.

UNINSTALLED

The bundle has been uninstalled. It cannot move into another state.

OSGIVERSION(data-value)

Specifies the 255-character version of the OSGi bundle.

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 is not found or disabled.

3

The OSGi bundle cannot be found.