SJ domain’s specific gates

Table 94 summarizes the SJ (JVM) domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 94. SJ domain’s specific gates
Gate Trace Function XPI
SJCC
SJ 0601
SJ 0602
START_CLASSCACHE
STOP_CLASSCACHE
RELOAD_CLASSCACHE
NOTIFY_CLASSCACHE
ADD_TO_ACTIVE_JVMSET
REMOVE_FROM_JVMSET
NO
NO
NO
NO
NO
NO
SJIN
SJ 0201
SJ 0202
INVOKE_JAVA_PROGRAM
(also has a generic function:
     NOTIFY_DELETE_TCB)
NO
SJIS
SJ 0301
SJ 0302
INQUIRE_JVMPOOL
SET_JVMPOOL
INQUIRE_JVM
START_BROWSE_JVM
GET_NEXT_JVM
END_BROWSE_JVM
INQUIRE_CLASSCACHE
SET_CLASSCACHE
INQUIRE_JVMPROFILE
START_BROWSE_JVMPROFILE
GET_NEXT_JVMPROFILE
END_BROWSE_JVMPROFILE
SET_JVMPROFILEDIR
DELETE_INACTIVE_JVMS
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

SJCC gate, START_CLASSCACHE function

The START_CLASSCACHE function of the SJCC gate is used to start the shared class cache.

Input parameters

[CACHE_SIZE]
The size of the shared class cache.
[JVM_PROFILE_NAME]
The name of the JVM profile to be used for the master JVM that initializes the shared class cache.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NOT_STOPPED

SJCC gate, STOP_CLASSCACHE function

The STOP_CLASSCACHE function of the SJCC gate is used to stop the shared class cache.

Input parameters

[AUTOSTART]
The autostart status that is to be set for the shared class cache, to determine whether or not it will restart automatically when a JVM requests its use. It can have the values:
ENABLED|DISABLED
[TERMINATE]
The type of termination that is to be attempted for the shared class cache and the worker JVMs that are dependent on it. It can have the values:
PHASEOUT|PURGE|FORCEPURGE
When PHASEOUT is specified, the supporting TCBs for the JVMs will be marked for deletion at the termination of their current task (if any). If PURGE or FORCEPURGE is specified, then premature termination of those tasks is initiated. When all worker JVMs have been terminated, the shared class cache is also terminated.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
ALREADY_STOPPED

SJCC gate, RELOAD_CLASSCACHE function

The RELOAD_CLASSCACHE function of the SJCC gate is used to reload the shared class cache--that is, to start a new master JVM and phase out the existing JVMset.

Input parameters

[CACHE_SIZE]
The size of the shared class cache.
[JVM_PROFILE_NAME]
The name of the JVM profile to be used for the master JVM that initializes the shared class cache.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NOT_STARTED

SJCC gate, NOTIFY_CLASSCACHE function

The NOTIFY_CLASSCACHE function of the SJCC gate is used to confirm the status of the master JVM that initializes the shared class cache. If the master JVM starts successfully, the function quiesces the previous shared class cache so that the new master JVM becomes the active shared class cache, and can be used by new worker JVMs (so the new master and worker JVMs become the active JVMset). If the master JVM fails to start, its autostart status is marked as disabled.

Input parameters

SJVMS_TOKEN
The token of the SJVMS control block.
JVMSET_STATUS
The status of the JVMset, that is, whether the master JVM started successfully. It can have the values:
READY|START_FAILED
[JVMSET_TOKEN]
The token of the master JVM.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
MASTER_JVM_ABENDED
INVALID
INVALID_CC_STATE

SJCC gate, ADD_TO_ACTIVE_JVMSET function

The ADD_TO_ACTIVE_JVMSET function of the SJCC gate is used to add a new worker JVM to the active JVMset, and also to automatically start the shared class cache if autostart is enabled and the shared class cache is not started. The active JVMset consists of the master JVM for the active shared class cache, and the worker JVMs that are dependent on it.

Input parameters

SJTCB_TOKEN
The token of the TCB on which the worker JVM is to be built.

Output parameters

JVMSET_TOKEN
The token of the master JVM.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
AUTOSTART_DISABLED
DISASTER
INVALID_CC_STATE

SJCC gate, REMOVE_FROM_JVMSET function

The REMOVE_FROM_JVMSET function of the SJCC gate is used to dissociate a worker JVM from the master JVM as part of the termination process for the worker JVM.

Input parameters

SJTCB_TOKEN
The token of the TCB on which the worker JVM has been built.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIN gate, INVOKE_JAVA_PROGRAM function

The INVOKE_JAVA_PROGRAM function of the SJIN gate is used to invoke a user Java™ program.

Input parameters

PROGRAM
The program name of the program to be invoked.
TRANSACTION
The transaction id of the current transaction.
JVM_PROFILE_NAME
The name of the JVM profile to be used for the JVM for this program to run in.
USER_CLASS
The name of the main class in the Java program that is to run in the JVM.
EXEC_KEY
The EXEC key of the JVM. It can have the values:
CICS|USER

Output parameters

ABEND_CODE
The CICS® abend code returned if an abend occurs.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
AUTOSTART_DISABLED
JVM_START_FAILURE
JVM_POOL_DISABLED
JVM_PROFILE_MISSING
JVM_PROFILE_INVALID
SYSTEM_PROPERTIES_MISSING
SYSTEM_PROPERTIES_INVALID
TRANSACTION_ABENDED
USER_CLASS_NOT_FOUND

SJIS gate, INQUIRE_JVMPOOL function

The INQUIRE_JVMPOOL function of the SJIS gate is used to retrieve information about the JVM pool.

Input parameters

[JVM_LEVEL0_TRACE_BUFFER]
is a buffer which is used by the JVM domain to return the JVM trace options that have been set for JVM Level 0 trace (up to 240 characters).
[JVM_LEVEL1_TRACE_BUFFER]
is a buffer which is used by the JVM domain to return the JVM trace options that have been set for JVM Level 1 trace (up to 240 characters).
[JVM_LEVEL2_TRACE_BUFFER]
is a buffer which is used by the JVM domain to return the JVM trace options that have been set for JVM Level 2 trace (up to 240 characters).
[JVM_USER_TRACE_BUFFER]
is a buffer which is used by the JVM domain to return the JVM trace options that have been set for JVM User trace (up to 240 characters).

Output parameters

[TOTAL]
The total number of JVMs in the JVM pool.
[STATUS]
The status of the JVM pool (that is, whether it can service new requests or not). It can have the values:
ENABLED|DISABLED
[PHASINGOUT]
The number of JVMs that are curently being phased out (that is, they have been marked for deletion, but are still being used by a task).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
JVM_LEVEL0_TRACE_OVERFLOW
JVM_LEVEL1_TRACE_OVERFLOW
JVM_LEVEL2_TRACE_OVERFLOW
JVM_USER_TRACE_OVERFLOW
DISASTER
INSUFFICIENT_STORAGE

SJIS gate, SET_JVMPOOL function

The SET_JVMPOOL function of the SJIS gate is used to set the status of the JVM pool, or to set JVM trace options for the JVM pool, or to terminate the JVM pool.

Input parameters

[STATUS]
The status of the JVM pool (that is, whether it can service new requests or not). It can have the values:
ENABLED|DISABLED
[TERMINATE]
The type of termination that is to be attempted for the JVMs in the JVM pool (both worker JVMs and standalone JVMs), and for the shared class cache. It can have the values:
 PHASEOUT|PURGE|FORCEPURGE
When PHASEOUT is specified, the supporting TCBs for the JVMs will be marked for deletion at the termination of their current task (if any). If PURGE or FORCEPURGE is specified, then premature termination of those tasks is initiated. If a shared class cache has been started, it will be terminated when all the worker JVMs that were dependent on it have been terminated.
[JVM_LEVEL0_TRACE_BLOCK]
is a buffer containing the JVM trace options (up to 240 characters) that are to be set for JVM Level 0 trace.
[JVM_LEVEL1_TRACE_BLOCK]
is a buffer containing the JVM trace options (up to 240 characters) that are to be set for JVM Level 1 trace.
[JVM_LEVEL2_TRACE_BLOCK]
is a buffer containing the JVM trace options (up to 240 characters) that are to be set for JVM Level 2 trace.
[JVM_USER_TRACE_BLOCK]
is a buffer containing the JVM trace options (up to 240 characters) that are to be set for JVM User trace.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, INQUIRE_JVM function

The INQUIRE_JVM function of the SJIS gate is used to identify and retrieve information about the JVMs in the JVM pool.

Input parameters

JVM_ID
The JVM token, a value that identifies the JVM.

Output parameters

[AGE]
The number of seconds since the JVM was initialized.
[ALLOC_AGE]
The number of seconds for which the JVM has been allocated to its task (zero if the JVM is not currently allocated to a task).
[CLASSCACHE]
Indicates whether the JVM is a worker JVM dependent on the shared class cache. It can have the values:
YES|NO
[EXEC_KEY]
The EXEC key of the JVM. It can have the values:
CICS|USER
[PHASING_OUT]
Indicates whether the JVM is being phased out (that is, it has been marked for deletion, but is still being used by a task). It can have the values:
YES|NO
[JVMPROFILE_NAME]
The name of the JVM profile used to initialize the JVM.
[TRANNUM]
The task to which the JVM is allocated (zero if the JVM is not currently allocated to a task).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
JVM_NOT_FOUND

SJIS gate, START_BROWSE_JVM function

The START_BROWSE_JVM function of the SJIS gate starts a browse of the JVMs in the JVM pool.

Input parameters

None.

Output parameters

BROWSE_TOKEN
A pointer to the JVM_ID (JVM token) of the first JVM that is to be browsed.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, GET_NEXT_JVM function

The GET_NEXT_JVM function of the SJIS gate returns the next JVM in the JVM pool. The JVMs are ordered by their JVM tokens.

Input parameters

BROWSE_TOKEN
A pointer to the JVM_ID (JVM token) of the last JVM that was found by the browse.

Output parameters

[JVM_ID]
The JVM token, a value that identifies the JVM.
[AGE]
The number of seconds since the JVM was initialized.
[ALLOC_AGE]
The number of seconds for which the JVM has been allocated to its task (zero if the JVM is not currently allocated to a task).
[CLASSCACHE]
Indicates whether the JVM is a worker JVM dependent on the shared class cache. It can have the values:
YES|NO
[EXEC_KEY]
The EXEC key of the JVM. It can have the values:
CICS|USER
[PHASING_OUT]
Indicates whether the JVM is being phased out (that is, it has been marked for deletion, but is still being used by a task). It can have the values:
YES|NO
[JVMPROFILE_NAME]
The name of the JVM profile used to initialize the JVM.
[TRANNUM]
The task to which the JVM is allocated (zero if the JVM is not currently allocated to a task).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
END_OF_BROWSE

SJIS gate, END_BROWSE_JVM function

The END_BROWSE_JVM function of the SJIS gate ends the browse of the JVMs in the JVM pool.

Input parameters

BROWSE_TOKEN
A pointer to the JVM_ID (JVM token) of the last JVM that was found by the browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, INQUIRE_CLASSCACHE function

The INQUIRE_CLASSCACHE function of the SJIS gate is used to retrieve information about the shared class cache in the CICS region.

Input parameters

None.

Output parameters

[ACTIVE_JVMS]
The number of worker JVMs in the CICS region that are dependent on the current shared class cache or on a shared class cache that is phasing out.
[AUTOSTART]
The status of autostart for the shared class cache.
[JVMPROFILE_NAME]
The name of the JVM profile for the master JVM that initializes the shared class cache.
[PHASINGOUT_JVMS]
The number of worker JVMs that are dependent on an old shared class cache (or on the current shared class cache, if its status is STOPPED) and are being phased out.
[PHASINGOUT_JVMSETS]
The number of old shared class caches that are still present in the region because they are waiting for worker JVMs that are dependent on them to be phased out (including the current shared class cache, if its status is STOPPED).
[CACHE_FREE]
The amount of free space in the shared class cache.
[CACHE_SIZE]
The size of the shared class cache, in bytes.
[START_DATE]
The date on which the current shared class cache was started.
[START_TIME]
The time at which the current shared class cache was started.
[START_ABSTIME]
The absolute date and time at which the current shared class cache was started (ABSTIME format).
[STARTED_STATUS]
The status of the current shared class cache (STARTING, STARTED, RELOADING or STOPPED).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, SET_CLASSCACHE function

The SET_CLASSCACHE function of the SJIS gate is used to set the autostart status and size of the shared class cache, and the JVM profile that is to be used for the master JVM.

Input parameters

[AUTOSTART]
The autostart status that is to be set for the shared class cache, to determine whether or not it will restart automatically when a JVM requests its use. It can have the values:
ENABLED|DISABLED
[INITIAL_START]
Specifies whether or not the shared class cache will start automatically at CICS initialization. It can have the values:
YES|NO
[JVMPROFILE_NAME]
The name of the JVM profile for the master JVM that initializes the shared class cache.
[CACHE_SIZE]
The size of the shared class cache, in bytes.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, INQUIRE_JVMPROFILE function

The INQUIRE_JVMPROFILE function of the SJIS gate is used to retrieve information about JVM profiles that have been used during the lifetime of this CICS region.

Input parameters

JVMPROFILE_NAME
The name of the JVM profile.
JVMPROFILE_PATH_NAME
is a buffer which is used by the JVM domain to return the full path name of the HFS file for the JVM profile (up to 240 characters).

Output parameters

CLASSCACHE
Indicates whether JVMs that use this JVM profile are worker JVMs dependent on the shared class cache. It can have the values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
JVMPROFILE_NOT_FOUND

SJIS gate, START_BROWSE_JVMPROFILE function

The START_BROWSE_JVMPROFILE function of the SJIS gate starts a browse of the JVM profiles that have been used during the lifetime of this CICS region.

Input parameters

None.

Output parameters

BROWSE_TOKEN
A pointer to the first JVM profile to be browsed.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, GET_NEXT_JVMPROFILE function

The GET_NEXT_JVMPROFILE function of the SJIS gate returns the next JVM profile. The JVM profiles are returned in alphabetical order.

Input parameters

BROWSE_TOKEN
A pointer to the last JVM profile that was found by the browse.
JVMPROFILE_PATH_NAME
is a buffer which is used by the JVM domain to return the full path name of the HFS file for the JVM profile (up to 240 characters).

Output parameters

JVMPROFILE_NAME
The name of the JVM profile.
CLASSCACHE
Indicates whether JVMs that use this JVM profile are worker JVMs dependent on the shared class cache. It can have the values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
END_OF_BROWSE
DISASTER
INVALID_BROWSE_TOKEN

SJIS gate, END_BROWSE_JVMPROFILE function

The END_BROWSE_JVMPROFILE function of the SJIS gate ends the browse of the JVM profiles.

Input parameters

BROWSE_TOKEN
A pointer to the last JVM profile that was found by the browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, SET_JVMPROFILEDIR function

The SET_JVMPROFILEDIR function of the SJIS gate is used to set the HFS directory where CICS will look for JVM profiles.

Input parameters

JVMPROFILE_DIR_BLOCK
is a buffer containing the full path of the HFS directory where CICS will look for JVM profiles (up to 240 characters).

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.

SJIS gate, DELETE_INACTIVE_JVMS function

The DELETE_INACTIVE_JVMS function of the SJIS gate is used when MVS storage is constrained, and CICS needs to delete JVMs in the JVM pool that are not currently in use, together with their TCBs.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None.
[[ Contents Previous Page | Next Page Index ]]