Table 51 summarizes the EJ 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 51. EJ domain’s specific gates
Gate |
Trace |
Function |
XPI |
EJBB |
EJ 0Cxx
|
START_BROWSE
GET_NEXT
END_BROWSE
|
NO
NO
NO
|
EJBG |
EJ 0Bxx
|
ADD_BEAN
ADD_BEAN_STATS
CONFIRM_ALL_BEANS
DELETE_ALL_BEANS
DELETE_BEAN
GET_BEAN_DD
INQUIRE_BEAN
RESET_BEAN_STATS
|
NO
NO
NO
NO
NO
NO
NO
NO
|
EJCB |
EJ 08xx
|
START_BROWSE
GET_NEXT
END_BROWSE
|
NO
NO
NO
|
EJCG |
EJ 07xx
EJ 17xx
|
ADD_CORBASERVER
ACTION_CORBASERVER
AMEND_CORBASERVER
DELETE_CORBASERVER
ESTABLISH
INQUIRE_CORBASERVER
RELINQUISH
RESOLVE_CORBASERVER
SET_ALL_STATE
WAIT_FOR_CORBASERVER
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
EJDB |
EJ 0Axx
|
START_BROWSE
GET_NEXT
END_BROWSE
|
NO
NO
NO
|
EJDG |
EJ 09xx
EJ 19xx
|
ADD_DJAR
ACTION_DJAR
AMEND_DJAR
COUNT_FOR_CS
DELETE_ALL_DJARS
DELETE_DJAR
INQUIRE_DJAR
RESOLVE_DJAR
SET_ALL_STATE
WAIT_FOR_DJAR
WAIT_FOR_USABLE_DJARS
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
EJDI |
EJ 05xx
|
ADD_ENTRY
INITIALIZE
LOOKUP_ENTRY
REMOVE_ENTRY
|
NO
NO
NO
NO
|
EJDU |
EJ 06xx
|
DUMP_DATA
DUMP_STACK
INQUIRE_TRACE_FLAGS
|
NO
NO
NO
|
EJGE |
EJ 0Dxx
|
INITIALIZE
QUIESCE
TERMINATE
|
NO
NO
NO
|
EJIO |
EJ 0Fxx
|
RESOLVE
RESOLVE_CSERVERS
RESOLVE_DJARS
|
NO
NO
NO
|
EJJO |
EJ 0Exx
|
ADD_BEAN
END_BEAN_BROWSE
GET_BEAN_DD
GET_NEXT_BEAN
INQUIRE_CORBASERVER
START_BEAN_BROWSE
WAIT_FOR_CORBASERVER
WAIT_FOR_USABLE_DJARS
|
NO
NO
NO
NO
NO
NO
NO
NO
|
EJMI |
EJ 50xx
|
ADD_BEAN
ADD_METHOD
DISCARD_METHOD_INFO
GET_METHOD_INFO
INITIALIZE
|
NO
NO
NO
NO
NO
|
EJOB |
EJ 03xx
|
END_BROWSE_OBJECT
GET_NEXT_OBJECSTORE
INQUIRE_OBJECT
INQUIRE_STORES
RETRIEVE_STATISTICS
START_BROWSE_OBJECT
|
NO
NO
NO
NO
NO
NO
|
EJOS |
EJ 02xx
|
ACTIVATE_OBJECT
CLOSE_OBJECT_STORE
OPEN_OBJECT_STORE
REMOVE_OBJECT
REMOVE_STORE
STORE_OBJECT
|
NO
NO
NO
NO
NO
NO
|
EJSO |
EJ 1751
EJ 1752
|
INQUIRE_CORBASERVER
AMEND_CORBASERVER
|
NO
NO
|
The START_BROWSE function of the EJBB gate initiates the browse upon the
chain of Beans. Positioning of the start of the Browse is not supported. Selection
by Bean is not provided, but selection by owning CorbaServer and owning DJar
is. The end_browse condition is not returned if there are no suitable Beans
(this is postponed until the get_next). The returned browsetoken must be used
for subsequent GET_NEXT operations. This operation is available from EJJO
and so the definitions must be consistent. The browsemode parameter controls
which Beans are selected. Only BROWSEMODE(VALIDONLY) should be used by the
SPI-layers.
- BROWSEMODE(ALL) selects all Beans (setting not usually used)
- BROWSEMODE(VALIDONLY) selects the Beans whose status has been confirmed
(those which are not temporarily present during the install of all the Beans
from a DJar). This is the usual (and default) setting.
- BROWSEMODE(INDOUBTONLY) selects the Beans whose status is temporary (those
which are temporarily present during the install of all the Beans from a DJar).
Input parameters
- CORBASERVER
- Name of the CorbaServer to be Browsed
- DJAR
- Name of the DJar for this Bean
- [BROWSEMODE]
- Controls which Beans are to be selected for Bean Browse
Output parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first DJar in
the chain 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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_BROWSEMODE
INVALID_CORBASERVER
INVALID_DJAR
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The GET_NEXT function of the EJBB gate returns the next Bean Control Block
in the list of Beans that meets the selection criteria. The ordering of Beans
returned is not specified (the order is not alpha order but LastIn-FirstOut
for Browse purposes). This operation is available from EJJO and so the definitions
must be consistent. The POINTAT parameter is used to enable a Browse to proceed
when the aim of the Browse is to locate a Bean to be deleted.
- POINTAT(NORMAL) should be used in all cases by the SPI layers and general
users (and is the default).
- POINTAT(PRIOR) shows the deletion intent. POINTAT(PRIOR) should never
be coded in normal circumstances and may result in an infinite loop if used
without a delete.
Input parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first DJar in
the chain to be browsed
- [POINTAT]
- Indicates whether to advance the browse pointer to point to the next
item in the chain (NORMAL|PRIOR). NORMAL will return the next item in the
chain, whereas PRIOR will always return the same item, unless that item has
been deleted
Output parameters
- BEAN
- Name of the Bean
- [CORBASERVER]
- Name of the CorbaServer for this DJar
- [DDLEN]
- Length of the deployment/meta data area. Used particularly to contain
the length of the data if the size is larger than the maximum length for ddareaforin
block
- [DJAR]
- Name of DJar for this Bean
- [STATUS]
- The state of the Bean being Browsed (NORMAL or TEMPORARY). Indicates
that a Bean has been confirmed
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BROWSE_TOKEN
EJB_INACTIVE
END_OF_BROWSE
INVALID_BROWSE_TOKEN
INVALID_POINTAT
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The END_BROWSE function of the EJBB gate ends the browse operation and
deletes the browsetoken. This operation is available from EJJO and so the
definitions must be consistent.
Input parameters
- BROWSETOKEN
- The pointer which points to the first DJar in the chain to be deleted
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_BROWSE_TOKEN
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The ADD_BEAN function of the EJBG gate:
- Creates the Bean element in memory and chains it appropriately. The XRSINDI
exit is called to notify the creation of this element.
- The ADDMODE parameter controls the compartmentalization of this operation
for usage purposes (this defaults to NORMAL which does both the creation of
the Control Block and its replacement in temporary mode). Usage of this verb
is always via the Java™ layers and so ADDMODE(NORMAL) is used.
- The namespace for the Bean is at the CorbaServer level - the Bean cannot
already have been installed from a different DJar (with the same name).
- The Bean itself is not actually installed until all the Beans within the
Djar have been installed. Therefore, the Bean is added as a Control Block
in a temporary state until all the Beans from the DJar have been so processed.
When all the Beans in the DJar have been (successfully) added, the CONFIRM_ALL_BEANS
call is made to alter the temporary state in the CB into a proper state. Otherwise
the DELETE_ALL_BEANS call is made which deletes the Control Block. As the
DJar was invalid it will be removed.
- On Warm restart, the owning Container and DJar will already have been
restored from the Global Catalog.
Input parameters
- BEAN
- Name of the Bean to be added
- CORBASERVER
- Name of the CorbaServer for this Bean
- DJAR
- Name of the Djar for this Bean
- DDAREAFORIN
- Block for Bean deployment/meta data input
- [ADDMODE]
- The type of create done for the Bean
- [MESSAGE]
- Controls whether a message is issued when a CorbaServer is created
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ALREADY_PRESENT
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
DDAREAFORIN_ABSENT
DJAR_ABSENT
DJAR_INVALID_STATE
EJB_INACTIVE
INVALID_BEAN
INVALID_BROWSE_TOKEN
INVALID_CORBASERVER
INVALID_DDAREAFORIN
INVALID_DD_ZERO_LENGTH
INVALID_DD_ZERO_POINTER
INVALID_DJAR
LOCK_ERROR
LOOP
NAMESPACE_CONFLICT
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The ADD_BEAN_STATS function of the EJBG gate increments the EJ domain’s
statistics counters for a specific enterprise bean.
Input parameters
- BEAN
- Name of the enterprise bean whose statistics are to be incremented
- CORBASERVER
- Name of the CorbaServer in which this bean is installed
- [ACTIVATES]
- The number of times this bean has been activated
- [PASSIVATES]
- The number of times this bean has been passivated
- [CREATES]
- The number of times this bean has been created
- [REMOVES]
- The number of times this bean has been removed
- [METHOD_CALLS]
- The number of method calls (other than the above) made against this
bean
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The CONFIRM_ALL_BEANS function of the EJBG gate hardens all Beans associated
with the given DJar within the relevant CorbaServer namespace. This just switches
the state of a suitable Bean from temporary to normal. This will run when
all Beans in the DJar have been correctly installed. The key is CS+DJar for
this multiple status changing.
Input parameters
- CORBASERVER
- The name of the CorbaServer for this Bean
- DJAR
- The name of the DJar for this Bean
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The DELETE_ALL_BEANS function of the EJBG gate is executed when all of
the Beans within the DJar did not install or when the owning DJar itself is
deleted. All relevant Bean Control Blocks (whatever their state) are deleted.
This works via the usual Browse mechanism (BROWSEMODE(ALL)) with POINTAT(PRIOR)
enabled to delete each individual Bean. The key of CS+DJar+Bean is required.
Input parameters
- CORBASERVER
- The name of the CorbaServer for this Bean
- DJAR
- the name of the DJar for this Bean
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
BROWSE_ERROR
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The DELETE_BEAN function of the EJBG gate deletes the Bean Control Block.
The XRSINDI exit is also called to notify the removal. The full key of CS+DJar+Bean
is required.
Input parameters
- BEAN
- The name of the Bean
- CORBASERVER
- The name of the CorbaServer for this Bean
- DJAR
- The name of the DJar for the Bean
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The GET_BEAN_DD function of the EJBG gate returns the saved Deployment/Meta
Data for the Bean (key is CS+Bean) in a buffer. The Buffer Pointer (_P) must
be non-zero and point to a suitable area of length_M bytes. After the Deployment/Meta
Data has been moved to the _P area, the _N item will be set to the length
of the Deployment/Meta Data as is the DDLEN parameter. If _M is too small
for the Deployment/Meta Data, then it is not moved into the _P area, _N is
set to zero and the required length returned in DDLEN. Note that DDLEN and
_N are only valid for OK operation or length errors - they are not available
for use in other circumstances.
This operation is available via EJJO and so parameters should be kept consistent.
Input parameters
- BEAN
- The name of the Bean
- CORBASERVER
- The name of the CorbaServer for this Bean
- DDAREAFORUPD
- A buffer for Bean the deployment/meta data update area
Output parameters
- [DDLEN]
- The length of the deployment/meta data area. Used particularly to contain
the length of the data if the size is larger than the maximum length for the
ddareaforin block
- [DJAR]
- The name of the DJar for this Bean
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
DJAR_ABSENT
DJAR_INVALID_STATE
DDAREAFORUPD_ABSENT
DD_AREA_TOO_SMALL
EJB_INACTIVE
INVALID_DDAREAFORUPD
INVALID_DD_ZERO_LENGTH
INVALID_DD_ZERO_POINTER
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The INQUIRE_BEAN function of the EJBG gate extracts information from the
named Bean Control Block (key is CS+Bean). Note that the length of the Deployment/Meta
Data is returned, but this XML is obtained via get_bean_dd.
This function can be used to determine the DJar which sourced the Bean.
Input parameters
- BEAN
- The name for the Bean
- CORBASERVER
- The name of the CorbaServer for this Bean
Output parameters
- [DDLEN]
- The length of the deployment/meta data area. Used particularly to contain
the length of the data if the size is larger than the maximum length of the
ddareaforin block
- [DJAR]
- The name of the DJarfor this Bean
- [STATUS]
- The state of the Bean being inquired upon
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The RESET_BEAN_STATS function of the EJBG gate sets the EJ domain’s
statistics counters, for a specific enterprise bean, to zero.
Input parameters
- BEAN
- Name of the enterprise bean whose statistics counters are to be reset
- CORBASERVER
- Name of the CorbaServer in which this bean is installed
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The START_BROWSE function of the EJCB gate initiates the browse upon the
chain of CorbaServers. Positioning of the start of the Browse is not supported.
Selection by CorbaServer is not provided. The end_browse condition is not
returned if there are no suitable CorbaServers (this is postponed until the
get_next). The returned browsetoken must be used for subsequent GET_NEXT operations.
Input parameters
None
Output parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first CorbaServer
in the chain 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]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
LOCK_ERROR
LOOP
SETUP_ERROR
STORAGE_ERROR
|
The GET_NEXT function of the EJCB gate returns the next CorbaServer Control
Block in the list of CorbaServers. The ordering of CorbaServers returned is
not specified (the order is not alpha order but Last-FirstOut for Browse purposes).
The POINTAT parameter is used to enable a Browse to proceed when the aim of
the Browse is to locate a CorbaServer to be deleted.
- POINTAT(NORMAL) should be used in all cases by the SPI layers and general
users (and is the default).
- POINTAT(PRIOR) shows the deletion intent. POINTAT(PRIOR) should never
be coded in normal circumstances and may result in an infinite loop if used
without a delete.
Input parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first CorbaServer
in the chain to be browsed
- [POINTAT]
- Indicates whether to advance the browse pointer to point to the next
item in the chain (NORMAL|PRIOR). NORMAL will return the next item in the
chain, whereas PRIOR will always return the same item, unless that item has
been deleted
Output parameters
- CORBASERVER
- Name of the CorbaServer
- [STATE]
- Indicates the current Resolution State and whether it is available for
use or not.
- [TIMEOUT]
- The elapsed time period (in seconds) of inactivity after which a session
Bean can be discarded
- [PORT]
- The binary TCP/IP port number for non-SSL communication included in
IORs exported from this CorbaServer
- [SSLPORT]
- The binary TCP/IP port number for SSL communication included in IORs
exported from this CorbaServer
- [SSL]
- the SSL type for this CorbaServer (YES|NO|CLIENTAUTH)
- [JNDIPREFIX]
- The prefix to use at runtime when publishing the JNDI
- [SHELF]
- The fully qualified name of a directory (a 'shelf' for 'jars') on HFS
- [HOST]
- The TCP/IP hostname or the dotted decimal TCP/IP address included in
IORs exported from this CorbaServer
- [CERT]
- The label of a certificate within the keyring that is to be used as
a client certificate in the SSL handshake for outbound IIOP connections
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BROWSE_TOKEN
EJB_INACTIVE
END_OF_BROWSE
INVALID_BROWSE_TOKEN
INVALID_POINTAT
LOCK_ERROR
LOOP
SETUP_ERROR
|
The END_BROWSE function of the EJCB gate ends the browse operation and
deletes the browsetoken.
Input parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first CorbaServer
in the chain to be browsed
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_BROWSE_TOKEN
LOCK_ERROR
LOOP
SETUP_ERROR
STORAGE_ERROR
|
The ACTION_CORBASERVER function of the EJCG gate is a gate which tells
another party that something is to be done on the CorbaServer. The implemented
actions are to manipulate the External Namespace for the named CorbaServer.
Input parameters
- CORBASERVER
- Name of the CorbaServer on which the action is to be done
- ACTIONMODE
- the action to perform on the CorbaServer. Possible values are:
PUBLISH|RETRACT
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
DJAR_INVALID_STATE
EJB_INACTIVE
INVALID_ACTION
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
PUBLISH_ERROR
RETRACT_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The ADD_CORBASERVER function creates a CorbaServer Control Block:
- creates the CorbaServer in memory, chains it appropriately, and saves
an entry in the Global Catalog for Warm restart purposes.
- The XRSINDI exit is called to notify the creation of this element.
- The ADDMODE parameter controls the scope of this operation for restart
purposes (this defaults to NORMAL which does both creation of the Control
Block and its cataloging). Usage of this verb via the SPI/RDO layers should
always code ADDMODE(NORMAL).
Input parameters
- CORBASERVER
- Name of the CorbaServer to be added
- STATE
- Indicates the current resolution state of the CorbaServer and whether
it is available for use or not.
- TIMEOUT
- The elapsed time (in seconds) of inactivity after which a session Bean
can be discarded
- JNDIPREFIX
- The prefix to use at runtime when publishing to JNDI
- SHELF
- The fully qualified name of a directory (a 'shelf' for 'jars') on HFS
- HOST
- The TCP/IP hostname or the dotted decimal TCP/IP address included in
IORs exported from this CorbaServer
- CERT
- The label of a certificate within the keyring that is to be used as
a client certificate in the SSL handshake for outbound IIOP connections
- [ADDMODE]
- The type of create done for the CorbaServer
- [MESSAGE]
- Controls whether a message is issued when a CorbaServer is created
- [ENABLESTATE]
- Permissible values are:
ENABLED|DISABLED|DISABLING
- [SCANINTERVAL]
-
- [DJARDIR]
-
- [AUTOPUBLISH]
-
- [OUTPRIVACY]
-
- [UNAUTH_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with no authentication.
- [SSLUNAUTH_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with SSL but no client authentication.
- [CLIENTCERT_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with SSL client certificate authentication.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
ATTACH_ERROR
CATALOG_ERROR
CERT_ERROR
CORBASERVER_ALREADY_THERE
EJB_INACTIVE
INVALID_CERT
INVALID_CORBASERVER
INVALID_HOST
INVALID_JNDIPREFIX
INVALID_PORT
INVALID_SHELF
INVALID_SSL
INVALID_SSLPORT
INVALID_STATE
INVALID_TIMEOUT
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The AMEND_CORBASERVER function of the EJCG gate changes information held
within the CorbaServer Control Block. It does not harden this information
over a CICS® restart, nor does the change get communicated to the executing JVMs.
Input parameters
- CORBASERVER
- Name of the CorbaServer in which the information is to be changed
- STATE
- Indicates the current resolution state of the CorbaServer and whether
it is available for use or not.
- [TIMEOUT]
- The elapsed time (in seconds) of inactivity after which a session Bean
can be discarded
- [STATE]
- Specifies the state into which the CorbaServer is to be put. Values
are
PENDINIT|INITING|UNUSABLE|PENDRESOLV|RESOLVING|INSERV|
UNRESOLVED|DELETING
- [CURRENT_STATE]
- Used as a check, must match the existing state of the CorbaServer. Values
are
PENDINIT|INITING|UNUSABLE|PENDRESOLV|RESOLVING|INSERV|
UNRESOLVED|DELETING
- [ENABLESTATE]
- Permissible values are:
ENABLED|DISABLED|DISABLING
- [SCANINTERVAL]
-
- [DJARDIR]
-
- [AUTOPUBLISH]
-
- [OUTPRIVACY]
-
- [UNAUTH_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with no authentication.
- [SSLUNAUTH_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with SSL but no client authentication.
- [CLIENTCERT_TCPIPSERVICE]
- The 8-character name of a TCPIPSERVICE that defines the characteristics
of the port which is used for inbound IIOP with SSL client certificate authentication.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
CORBASERVER_STATE_CHANGED
EJB_INACTIVE
EJOS_ERROR
INVALID_STATE
INVALID_STATE_CHANGE
INVALID_TIMEOUT
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The DELETE_CORBASERVER function of the EJCG gate removes a CorbaServer.
- Deletes the CorbaServer Control Block and removes the saved entry in the
Global catalog. The XRSINDI exit is called to notify the removal.
- The Java layers are informed that the CorbaServer has been
deleted.
- This operation has a side effect in that all DJars associated with the
CorbaServer are also deleted, and then all the Beans from the DJar.
Input parameters
- CORBASERVER
- Name of the CorbaServer to be deleted
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CATALOG_ERROR
CORBASERVER_ABSENT
CORBASERVER_DELETING
DELDJAR_ERROR
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The ESTABLISH function of the EJCG gate associates a CorbaServer with
the calling task. It sets the task’s Recovery Manager work token to reference
the CorbaServer.
Input parameters
- CORBASERVER
- Name of the CorbaServer with which an association is to be established
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_DELETING
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
STORAGE_ERROR
|
The INQUIRE_CORBASERVER function of the EJCG gate extracts information
from the named CorbaServer Control Block. It is also executed indirectly from
the EJJO gate.
Input parameters
- CORBASERVER
- Name of the CorbaServer from which to extract information
Output parameters
- [STATE]
- The state of the CorbaServer. Used to indicate whether the CorbaServer
is available to use or not
- [ENABLESTATE]
- Possible values are:
ENABLED|DISABLED|DISABLING
- [TIMEOUT]
- The elapsed time (in seconds) of inactivity after which a session Bean
can be discarded
- [PORT]
- The binary TCP/IP port number for non-SSL communication included in
IORs exported from this CorbaServer
- [SSLPORT]
- The binary TCP/IP port number for SSL communication included in IORs
exported from this CorbaServer
- [SSL]
- The SSL type for this CorbaServer (YES|NO|CLIENTAUTH)
- [JNDIPREFIX]
- The prefix to use at runtime when publishing to JNDI
- [SHELF]
- The fully qualified name of a directory (a 'shelf' for 'jars') on HFS
- [HOST]
- The TCP/IP hostname or the dotted decimal TCP/IP address included in
IORs exported from this CorbaServer
- [CERT]
- The label of a certificate within the keyring that is to be used as
a client certificate in the SSL handshake for outbound IIOP connections
- 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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The RELINQUISH function of the EJCG gate ends an association between a
CorbaServer and the calling task. It sets the task’s Recovery Manager
work token to blank.
Input parameters
- CORBASERVER
- Name of the CorbaServer with which an association is to be ended
- [ALLOC_COUNT]
- The allocation number of the CorbaServer (used to prevent the accidental
relinquishing of CorbaServers that have been freed and reallocated).
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_DELETING
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
STORAGE_ERROR
|
The RESOLVE_CORBASERVER function of the EJCG gate makes the CorbaServer
available for use by Resolution (called by the CEJR transaction). The Java layers are informed that the CorbaServer has been created.
Input parameters
- CORBASERVER
- Name of the CorbaServer
Output parameters
- DID_STAGE
- The output from Resolve function which indicates which stage of resolution
was done (STAGE1 or STAGE2)
- 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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BAD_STATE_SET
CATALOG_ERROR
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
EJB_INACTIVE
EJOS_ERROR
IILS_ERROR
INVALID_CORBASERVER
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The SET_ALL_STATE function sets the state of all the CorbaServers.
input parameters
- STATE
- Indicates the current Resolution State and whether it is available for
use or not.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The WAIT_FOR_CORBASERVER function of the EJCG gate will wait until the
CorbaServer enters the required state.
Input parameters
- CORBASERVER
- Name of the CorbaServer being waited on
- STATE
- Indicates the current Resolution State and whether it is available for
use or not.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_UNRESOLVED
CORBASERVER_UNUSABLE
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
WAIT_ERROR
|
The DISCARD_DJAR function of the EJCP gate is called by the EJ domain during
DJar Discard processing, but the DJar is unavailable for inquire.
The jar file is removed from its shelf and the shelf directory is deleted.
Input parameters
- CORBASERVER
- Name of the CorbaServer (container) in which this DJar is installed.
This is the CorbaServer name as specified in the DJar definition.
- DJAR
- Name of the DJar to be discarded
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
SHELF_ACCESS_ERROR |
The INSTALL_DJAR function of the EJCP gate is called by the EJ domain when
a DJar is installed as the second part of the DJar installation processing
(after the DJar has been copied to the shelf).
The Java Container should initiate the processing of the DJar and pass the
obtained Bean to the EJ domain.
The EJ domain expects to be called back for inquire_corbaserver and inquire_djar
during the processing of this call, so the DJar must be available for inquire.
Input parameters
- CORBASERVER
- Name of the CorbaServer (container) into which this DJar is to be installed.
This is the CorbaServer name as specified in the DJar definition.
- DJAR
- Name of the DJar to be installed
- HFSFILE
- The fully qualified name of the jar file to be installed. The name must
be a valid HFS filename and must not have any trailing blanks.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
CONTAINER_ERROR
HFSFILE_NOT_FOUND
HFS_ACCESS_ERROR
SHELF_ACCESS_ERROR
|
The PRE_INSTALL_DJAR function of the EJCP gate is called by the EJ domain
when a DJar is installed to copy the hfsfile comprising the DJar onto the
shelf.
The Java Container should create a copy of the DJar file on the shelf for
the associated CorbaServer.
The EJ domain expects to be called back for inquire_corbaserver and inquire_djar
during the processing of this call (EJJO gate), so the DJar must be available
for inquire.
Input parameters
- CORBASERVER
- Name of the CorbaServer (container) into which this DJar is to be installed.
This is the CorbaServer name as specified in the DJar definition.
- DJAR
- Name of the DJar to be installed
- HFSFILE
- The fully qualified name of the jar file to be installed. The name must
be a valid HFS filename and must not have any trailing blanks.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
CONTAINER_ERROR
HFSFILE_NOT_FOUND
HFS_ACCESS_ERROR
SHELF_ACCESS_ERROR
|
The PUBLISH_CORBASERVER function of the EJCP gate may be invoked by the
EJ domain or the exec interface layer. All beans in the specified logical
server are published to JNDI. This is not to be confused with the IILS publish
function.
The Java container calls back to the EJ domain with a browse of all installed
Beans for the logical server during processing of the function.
Input parameters
- CORBASERVER
- Name of the CorbaServer for which to publish Beans.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
CONTAINER_ERROR
HFS_ACCESS_ERROR
JNDI_ACCESS_ERROR
|
The PUBLISH_DJAR function of the EJCP gate may be invoked by the EJ domain
or the exec interface layer. All beans in the specified logical server are
published to JNDI.
The Java container calls back to the EJ domain with a browse of all installed
Beans for the DJar during processing of the function.
Input parameters
- CORBASERVER
- Name of the CorbaServer for which to publish Beans.
- DJAR
- Name of the DJar for which to publish all Beans.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
CONTAINER_ERROR
HFS_ACCESS_ERROR
JNDI_ACCESS_ERROR
|
The RETRACT_CORBASERVER function of the EJCP gate may be invoked by the
EJ domain or the exec interface layer. All beans in the specified logical
server are retracted from JNDI. This is not to be confused with the IILS retract
function.
The Java container calls back to the EJ domain with a browse of all installed
Beans for the logical server during processing of the function.
Input parameters
- CORBASERVER
- Name of the CorbaServer for which to retract Beans.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
HFS_ACCESS_ERROR
JNDI_ACCESS_ERROR
|
The RETRACT_DJAR function of the EJCP gate may be invoked by the EJ domain
or the exec interface layer. All beans in the specified DJar server are retracted
from JNDI.
The Java container calls back to the EJ domain with a browse of all installed
Beans for DJar or the logical server during processing of the function.
Input parameters
- CORBASERVER
- Name of the CorbaServer for which to retract Beans.
- DJAR
- Name of the DJar for which to retract all Beans.
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 DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND LOOP |
EXCEPTION |
HFS_ACCESS_ERROR
JNDI_ACCESS_ERROR
|
The START_BROWSE function of the EJDB gate initiates the browse upon the
chain of DJars. Positioning of the start of the Browse is not supported. Selection
by DJars is not provided, but selection by owning CorbaServer is. The end_browse
condition is not returned if there are no suitable DJars (this is postponed
until the get_next). The returned browsetoken must be used for subsequent
GET_NEXT operations.
Input parameters
- CORBASERVER
- The name of the CorbaServer for this DJar
Output parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first CorbaServer
in the chain 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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_CORBASERVER
LOCK_ERROR
LOOP
SETUP_ERROR
STORAGE_ERROR
|
The GET_NEXT function of the EJDB gate returns the next DJar Control Block
in the list of DJars that meets the selection criteria. The ordering of DJars
returned is not specified (the order is not alpha order but LastIn-FirstOut
for Browse purposes). The POINTAT parameter is used to enable a Browse to
proceed when the aim of the browse is to locate a DJar to be deleted.
- POINTAT(NORMAL) should be used in all cases by the SPI layers and general
users (and is the default).
- POINTAT(PRIOR) shows the deletion intent. POINTAT(PRIOR) should never
be coded in normal circumstances and may result in an infinite loop if used
without a delete.
Input parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first DJar in
the chain to be browsed
- [POINTAT]
- Indicates whether to advance the browse pointer to point to the next
item in the chain (NORMAL|PRIOR). NORMAL will return the next item in the
chain, whereas PRIOR will always return the same item, unless that item has
been deleted
Output parameters
- DJAR
- The name of the DJar
- [CORBASERVER]
- The name of the CorbaSerever for this DJar
- [HFSFILE]
- The fully qualified name of the deployed jar file on HFS
- [STATE]
- The state of the DJar. Used to indicate whether the DJar is available
for use or not
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BROWSE_TOKEN
EJB_INACTIVE
END_OF_BROWSE
INVALID_BROWSE_TOKEN
INVALID_POINTAT
LOCK_ERROR
LOOP
SETUP_ERROR
|
The END_BROWSE function of the EJDB gate ends the browse operation and
deletes the browsetoken.
Input parameters
- BROWSETOKEN
- The pointer set up by START_BROWSE which points to the first DJar in
the chain to be browsed
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_BROWSE_TOKEN
LOCK_ERROR
LOOP
SETUP_ERROR
|
The ACTION_DJAR function of the EJDG gate tells another party that something
is to be done on the DJar. The implemented actions are to manipulate the External
Namespace for the named DJar.
Input parameters
- DJAR
- The name of the DJar
- ACTIONMODE
- The action to perform on the DJar (PUBLISH|RETRACT)
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
DJAR_ABSENT
DJAR_INVALID_STATE
EJB_INACTIVE
INVALID_ACTION
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
PUBLISH_ERROR
RETRACT_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The ADD_DJAR function of the EJDG gate creates a DJar Control Block.
- Creates the DJar element in memory, chains it appropriately, and saves
an entry in the Global Catalog for Warm restart purposes.
- The XRSINDI exit is called to notify the creation of the element. The Java layers are informed that the DJar has been created.
- The ADDMODE parameter controls the compartmentalization of this operation
for restart purposes (this defaults to NORMAL which does both the creation
of the Control Block and its cataloging). Usage of this verb via the SPI/RDO
layers should always code ADDMODE(NORMAL).
Input parameters
- DJAR
- The name of the DJar to be added
- CORBASERVER
- The name of the CorbaServer for this DJar
- HFSFILE
- The fully qualified name of the deployed jar file on HFS
- STATE
- Indicates the current Resolution State and whether it is available for
use or not.
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
ATTACH_ERROR
CATALOG_ERROR
CORBASERVER_ABSENT
CORBASERVER_INVALID_STATE
DJAR_ALREADY_THERE
EJB_INACTIVE
INVALID_CORBASERVER
INVALID_DJAR
INVALID_HFSNAME
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The AMEND_DJAR function of the EJDG gate alters the DJar Control Block,
but does not catalog the change or tell Java about the amendment.
Input parameters
- DJAR
- The name of the DJar to be changed
- [STATE]
- Specifies the state into which the DJar is to be put. Values are
PENDINIT|INITING|UNUSABLE|PENDRESOLV|RESOLVING|INSERV|
UNRESOLVED|DELETING
- [CURRENT_STATE]
- Used as a check, and must match the existing state of the DJar. Values
are
PENDINIT|INITING|UNUSABLE|PENDRESOLV|RESOLVING|INSERV|
UNRESOLVED|DELETING
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BAD_STATE_CHANGE
DJAR_ABSENT
DJAR_STATE_CHANGED
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The COUNT_FOR_CS function of the EJDG gate totals the number of DJars in
each state for the owning CorbaServer
Input parameters
- CORBASERVER
- The name of the CorbaServer
Output parameters
- [NDJARS]
- The number of DJars in this Corbaserver
- [NPENDINIT]
- The number of DJars which are in pendinit state in the CorbaServer
- [NINITING]
- The number of DJars which are in initing state in the CorbaServer
- [NUNUSABLE]
- The number of DJars which are in unusable state in the CorbaServer
- [NPENDRESOLV]
- The number of DJars which are in pendresolve state in the CorbaServer
- [NRESOLVING]
- The number of DJars which are in resolving state in the CorbaServer
- [NINSERV]
- The number of DJars which are in inservice state in the CorbaServer
- [NUNRESOLVED]
- The number of DJars which are in unresolved state in the CorbaServer
- [NDELETING]
- The number of DJars which are in deleting state in the CorbaServer
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BAD_STATE_CHANGE
DJAR_ABSENT
DJAR_STATE_CHANGED
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The DELETE_DJAR function of the EJDG gate
- Deletes the DJar Control Block and removes the saved entry in the Global
Catalog. the XRSINDI exit is also called to notify the removal.
- The Java layers are informed that the DJar has been deleted.
However, this notification is not done if the deletion has been initiated
by the deletion of the owning CorbaServer (this is notified by the delmode
parameter - DELMODE(CASCADE) showing this CorbaServer initiated deletion and
DELMODE(NORMAL) showing that the deletion has been initiated from the SPI/CEMT
layers).
- This operation has a side effect in that all Beans associated with the
DJar are also deleted.
Input parameters
- DJAR
- The name of the DJar to be deleted
- DELMODE
- Indicates what type of deletion is being done:
- DELMODE(CASCADE) indicates an owning CorbaServer initiated the deletion
of this DJar
- DELMODE(NORMAL) indicated deletion is for SPI/CEMT delete DJar request
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CATALOG_ERROR
DJAR_ABSENT
DJAR_DELETING
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The DELETE_ALL_DJARS function of the EJDG gate is called when the owning
CorbaServer is deleted which forces the cascaded deletion of all the DJars
associated with the CorbaServer. This gate eventually uses EJDG.DELETE_DJAR
with DELMODE(CASCADE) as part of its operation.
Input parameters
- CORBASERVER
- The name of the CorbaServer for these DJars
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The INQUIRE_DJAR function of the EJDG gate extracts information from the
named DJar Control Block
Input parameters
- DJAR
- The name of the DJar
Output parameters
- [CORBASERVER]
- The name of the CorbaServer for this deployed jar file.
- [HFSFILE]
- The fully qualified name of the deployed jar file on HFS
- [STATE]
- The state of the deployed jar file. Used to indicate whether the deployed
jar file is available for use or not
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
DJAR_ABSENT
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The SET_ALL_STATE function of the EJDG gate sets the state of all the DJars.
Input parameters
- STATE
- Indicates the current Resolution State and whether it is available for
use or not.
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
|
The WAIT_FOR_DJAR function of the EJDG gate waits until the DJars enter
the required state.
Input parameters
- DJAR
- The name of the DJar being waited on
- STATE
- Indicates the current Resolution State and whether it is available for
use or not.
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
DJAR_ABSENT
DJAR_UNRESOLVED
DJAR_UNUSABLE
EJB_INACTIVE
INVALID_STATE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
WAIT_ERROR
|
The WAIT_FOR_USABLE_DJARS function of the EJDG gate waits until all the
DJars associated with a CorbaServer are INSERV.
Input parameters
- CORBASERVER
- The name of the CorbaServers for these DJars
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CORBASERVER_ABSENT
CORBASERVER_ERROR
CORBASERVER_INVALID_STATE
COUNT_ERROR
DJAR_ABSENT
DJAR_UNRESOLVED
DJAR_UNUSABLE
EJB_INACTIVE
LOCK_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
WAIT_ERROR
|
The ADD_ENTRY function of the EJDI gate adds a new entry to the Directory
partition for the specified LogicalServer.
No entry with the same name should exist in the specified LogicalServer
partition. In the case of a transaction entry, no existing entry should refer
to the same request stream, but this is not checked.
Input parameters
- ENTRY_KEY
- The key (OTS or Object Key) for the entry
- ENTRY_TYPE
- Indicates whether this is a transaction or object_key entry
- LOGICALSERVER
- Name of the LogicalServer for which the entry is to be added
- REQUEST_STREAM_ID
- Public ID of the request stream to be put in the entry
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
DUPLICATE_ENTRY
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_FULL_ERROR
FILE_IO_ERROR
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The INITIALIZE function of the EJDI gate is called when a store_not_open
has been detected.
Input parameters
- LOGICALSERVER
- Name of the LogicalServer for which the entry is to be added
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CICS_TERMINATING
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_NOT_FOUND
FILE_RECOVERY_ERROR
FILE_RECOVERY_UNKNOWN
CTL_REC_FULL_ERROR
|
INVALID |
INVALID_KEYLENGTH
INVALID_RECORD_SIZE
|
The LOOKUP_ENTRY function of the EJDI gate looks up the given OTS transaction
or object key / LogicalServer pair and returns the associated Request Stream
if found.
Input parameters
- ENTRY_KEY
- The key (OTS transaction or Object Key) for the entry to be returned
- ENTRY_TYPE
- Indicates whether this is a transaction or object_key entry
- LOGICALSERVER
- Name of the LogicalServer to search for the entry
- REQUEST_STREAM_BUFFER
- Caller supplied buffer to contain the request stream id
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
ENTRY_NOT_FOUND
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
OBJECT_CORRUPT
STORE_NOT_FOUND
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The REMOVE_ENTRY function of the EJDI gate removes a transaction or object
key for a given LogicalServer.
Input parameters
- ENTRY_KEY
- The key (OTS transaction or Object Key) for the entry to be removed
- ENTRY_TYPE
- Indicates whether this is a transaction or object_key entry
- LOGICALSERVER
- Name of the LogicalServer for which the entry is to be removed
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
ENTRY_NOT_FOUND
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The DUMP_DATA function of the EJDU gate is used to collect data from a
dumping class. It will be placed in the chain of data collected by EJDU and
formatted out when a CICS dump occurs.
Input parameters
- DATA
- A pointer and length pair containing the data to be stored for inclusion
in a dump.
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND INTERNAL_ERROR |
EXCEPTION |
INSUFFICIENT_STORAGE |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The DUMP_STACK function of the EJDU gate is used to collect the stack of
a running JVM. The stack is passed as a string to EJDU and will be formatted
out separately from the other data collected by EJDU's DUMP_DATA function.
This function should be called before DUMP_DATA as it will free any existing
data gathered for the running task.
Input parameters
- DATA
- A pointer and length pair containing the data to be stored for inclusion
in a dump.
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INTERNAL_ERROR
|
EXCEPTION |
INSUFFICIENT_STORAGE |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The INQUIRE_TRACE_FLAGS function of the EJDU gate is used to return the
current settings of all the trace flags. It takes into account the master
trace flag setting when returning the result. The trace flags are returned
as a continuous block of storage with 2 bytes for each flag, in domain order.
Input parameters
- TRACE_DATA
- A block of data containing the trace flags in domain order, where each
trace flag takes up 2 bytes
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INTERNAL_ERROR
|
EXCEPTION |
BAD_DOMAIN_TOKEN
TRACE_BUFFER_ERROR
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The INITIALIZE function of the EJGE gate creates the various things in
the EJE Anchor Block (Locks, Store Subpools, Statii etc.) and then sets up
the initial chains of CorbaServer, DJar and BEan Control Blocks (and the Browse
equivalents). These chains all start with a dummy X'00' element and end with
another dummy X'FF' element. This permits easy chaining and detection of end-of-lists.
However, more importantly, this technique enables multi-TCB operations to
proceed as there are never any EJ Element wide-locks - all locks are at the
CorbaServer, DJar or Bean level. After the EJE anchor block has been setup
it is never subsequently amended.
Input parameters
- STARTTYPE
- The startup type for this CICS system (WARM|COLD)
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CATALOG_ERROR
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The QUIESCE function of the EJGE gate runs when a CEMT P SHUT is executed.
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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The TERMINATE function of the EJGE gate runs when a CEMT P IMMED is executed.
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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
LOOP
PARMS_STORAGE_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The RESOLVE function of the EJIO gate controls the operation of Resolution
processing. It is called by the CEJR transaction.
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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ADD_ERROR
CATALOG_ERROR
EJB_INACTIVE
ENV_ERROR
LOOP
MULTIUSE
OBJECTSTORE_ERROR
PARMS_STORAGE_ERROR
PRIORFAIL
RESC_BAD_STB
RESC_GETNEXT_ERROR
RESD_BAD_STB
RESD_GETNEXT_ERROR
RESOLV_FAIL_CS
RESOLV_FAIL_DJAR
SETUP_ERROR
STORAGE_ERROR
|
The RESOLVE_CSERVERS function of the EJIO gate scans all existing CorbaServer
Control Blocks that have not been fully processed and issues a EJCG.RESOLVE_CORBASERVER
on the first such CorbaServer. (both Stage one 'copying the DJar to the Shelf'
and Stage two 'Opening Object Stores' Resolution Processing).
Input parameters
None
Output parameters
The RESOLVE_DJARS function of the EJIO gate scans all existing DJar Control
Blocks that have not been fully processed and issues a EJDG.RESOLVE_DJAR on
the first such DJar (both Stage one 'copying the DJar to the Shelf' and Stage
two 'Bean loading' Resolution Processing).
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]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BEAN_ADD_ERROR
CATALOG_ERROR
EJB_INACTIVE
ENV_ERROR
LOCK_ERROR
LOOP
OBJECTSTORE_ERROR
PARMS_STORAGE_ERROR
RESD_BAD_STB
RESD_GETNEXT_ERROR
SETUP_ERROR
STORAGE_ERROR
|
The EJJO Gate provides a subset of the aforementioned EJ Domain Gates for
direct use by the CICS-supplied layers residing within Java code.
See the native functions for details.
The ADD_BEAN function of the EJMI gate adds the named Bean within the named
CorbaServer to the EJMI state.
A duplicate_bean exception is returned if there is already a Bean of that
name within the given CorbaServer. (The DJar must be discarded before the
Bean can be added again.)
Input parameters
- BEAN
- The name of the Bean to be added
- CORBASERVER
- The name of the CorbaServer containing the Bean
- DJAR
- The name of the DJar
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
DUPLICATE_BEAN |
The ADD_METHOD function of the EJMI gate adds the information for the named
method within the given Bean and CorbaServer.
An unknown_bean exception is returned if there the given Bean and CorbaServer
combination is not present in the EJMI state.
A duplicate_method exception is returned if there is already a method of
that name within the given Bean and CorbaServer combination.
Input parameters
- BEAN
- The name of the Bean to be added
- CORBASERVER
- The name of the CorbaServer containing the Bean
- METHOD
- The name of the method
- XCOORD
- Indicates whether an external OTS transaction coordinator, if there
is one, is respected for determining transaction commit or rollback. Values
are:
RESPECTED|IGNORED
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
DUPLICATE_METHOD
UNKNOWN_BEAN
|
The DISCARD_METHOD_INFO function of the EJMI gate removes from the given
CorbaServer all the information about Beans with the given DJar name. If no
DJar name is specified all Beans are removed.
Input parameters
- CORBASERVER
- The name of the CorbaServer for this DJar
- [DJAR]
- The name of the DJar for these Beans
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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
UNKNOWN_CORBASERVER |
The GET_METHOD_INFO function of the EJMI gate returns the information about
the named method within the named Bean and CorbaServer.
An unknown_method exception is returned if the method is not found within
the Bean and CorbaServer combination.
Input parameters
- BEAN
- The name of the Bean
- CORBASERVER
- The name of the CorbaServer for this Bean
- METHOD
- The name of the Bean method
Output parameters
- XCOORD
- Indicates whether an external OTS transaction coordinator, if there
is one, is respected for determining transaction commit or rollback Values
are:
RESPECTED|IGNORED
- 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 DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
UNKNOWN_BEAN
UNKNOWN_CORBASERVER
UNKNOWN_METHOD
|
The INITIALIZE function of the EJMI gate initializes the EJMI state in
the EJ anchor block.
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
The END_BROWSE_OBJECT function of the EJOB gate is called after START_BROWSE_OBJECT
to end the Browse of a file or object_store.
Input parameters
- BROWSE_TOKEN
- The token returned by START_BROWSE
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_TOKEN |
The GET_NEXT_OBJECT function of the EJOB gate is called after START_BROWSE_OBJECT
to return the next object in the file or object_store.
Input parameters
- BROWSE_TOKEN
- The token returned by START_BROWSE
- [KEY_BUFFER]
- A buffer in which the next object key is returned
- [OBJECT_BUFFER]
- A buffer in which the next object is returned
Output parameters
- [ACTIVE_TIMEOUT]
- A full-word giving the number of seconds after which Objects in the
Active state may be automatically deleted from the store.
- [FILE_NAME]
- The 8-character name of the file containing the Object Store.
- [LAST_UPDATED]
- The time in STCK seconds when the object was last stored or activated.
- [OBJECT_SIZE]
- The size of the object being inquired.
- [PASSIVE_TIMEOUT]
- A full-word giving the number of seconds after which Objects in the
Passive state may be automatically deleted from the store.
- [STATUS]
- The state of the Object, ACTIVE or PASSIVE.
- [STORE_NAME]
- The 8-character name of the Object Store.
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
END_BROWSE FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
OBJECT_CORRUPT
|
INVALID |
INVALID_TOKEN |
The INQUIRE_OBJECT function of the EJOB gate is called to return the Object
data and attributes associated with the given key.
Input parameters
- STORE_NAME
- The 8-character name of the Object Store
- KEY_BLOCK
- A block giving the key of the Object being inquired
- [OBJECT_BUFFER]
- A buffer in which the object is returned
Output parameters
- [ACTIVE_TIMEOUT]
- A full-word giving the number of seconds after which Objects in the
Active state may be automatically deleted from the store.
- [FILE_NAME]
- The 8-character name of the file containing the Object Store.
- [LAST_UPDATED]
- The time in STCK seconds when the object was last stored or activated.
- [OBJECT_SIZE]
- The size of the object being inquired.
- [PASSIVE_TIMEOUT]
- A full-word giving the number of seconds after which Objects in the
Passive state may be automatically deleted from the store.
- [STATUS]
- The state of the Object, ACTIVE or PASSIVE.
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
OBJECT_CORRUPT
OBJECT_NOT_FOUND
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The INQUIRE_STORES function of the EJOB gate is called to return a list
of the Object Store names associated with the given file. The list is returned
as an array of 8-character store names.
Input parameters
- [FILE_NAME]
- The optional 8-character name of the file to be inquired. If omitted
then the default file 'DFHEJOS' will be used.
- [OBJECT_BUFFER]
- A buffer in which the array of store names is returned.
- [SUBPOOL]
- A storage subpool from which to getmain the object block.
Output parameters
- STORE_COUNT
- The number of store names being returned
- [OBJECT_BLOCK]
- A block containing the array of 8-character store names. If specified
then SUBPOOL must also be specified.
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
FILE_REC_SIZE_ERROR
|
INVALID |
INVALID_TOKEN |
The RETRIEVE_STATISTICS function of the EJOB gate is called by statistics
to return the statistics associated with a supplied store key.
Input parameters
- STORE_NAME
- The name of the store for which the statistics are being retrieved.
- [DATA]
- A flag indicating if the statistics must be returned
- [OBJECT_BUFFER]
- The statistics buffer which the data must be put into
- [RESET]
- A flag indicating that the statistics fields must be reset
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
BUFFER_NOT_SUPPLIED
STORE_NOT_OPEN
|
The START_BROWSE_OBJECT function of the EJOB gate is called To Browse an
Object Store. If STORE_NAME is omitted then all Objects in the file are browsed.
If FILE_NAME is omitted then the default file 'DFHEJOS' is assumed.
Input parameters
- [STORE_NAME]
- The 8-character name of the Object Store to browse
- [FILE_NAME]
- The 8-character name of the Object Store to browse
Output parameters
- BROWSE_TOKEN
- A token required by GET_NEXT and END_BROWSE
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
FILE_REC_SIZE_ERROR
STORE_NOT_FOUND
|
The ACTIVATE_OBJECT function of the EJOS gate is called to Activate an
Object instance.
If DELETE(NO) is specified then the ACTIVATE function will mark Objects
as ACTIVE in the store. ACTIVE_TIMEOUT indicates when entries marked ACTIVE
may be automatically deleted from the store. If DELETE(YES) is specified then
ACTIVE_TIMEOUT is ignored, and the ACTIVATE function will delete the object
from the store.
Input parameters
- STORE_NAME
- The 8-character name of the Object Store
- KEY_BLOCK
- A block giving the key of the Object to be activated
- OBJECT_BUFFER
- The buffer into which the Object is returned
- DELETE
- YES means the Object is to be deleted from the while and NO means the
Object is to be marked ACTIVE in the file
Output parameters
- OBJECT_SIZE
- The size of the Object being activated
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
BUFFER_TOO_SMALL
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
OBJECT_CORRUPT
OBJECT_IS_ACTIVE
OBJECT_NOT_FOUND
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The CLOSE_OBJECT_STORE function of the EJOS gate is called to Close an
Object Store in the local system.
If an Object Store is open with a non-zero timeout value, then a task is
scheduled to sweep the store periodically, deleting timed-out Objects. It
will, therefore, improve CICS performance if stores are closed when not required.
Input parameters
- STORE_NAME
- The 8-character name of the Object Store
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
STORE_NOT_OPEN |
The OPEN_OBJECT_STORE function of the EJOS gate is called to Open a new
or existing Object Store in the local system.
An Object Store must be opened in each region wishing to use it. Many object
stores can use the same CICS file, or they can each specify a different file.
If an Object Store of the same name is already open in that region, the
existing definition is replaced, and the new file name and timeout values
are then used. As timeout values are stored with the object, changes to the
store definition will not affect objects already stored. If file_name is omitted,
then the default file 'DFHEJOS' will be used.
Input parameters
- ACTIVATE_TIMEOUT
- A full-word giving the number of seconds after which Objects in the
Active State may be automatically deleted from the store
- PASSIVE_TIMEOUT
- A full-word giving the number of seconds after which Objects in the
Passive State may be automatically deleted from the store
- RECOVERY
- YES indicates that the file should be recoverable. If it is not, FILE_RECOVERY_ERROR
is returned. NO indicates that the file should not be recoverable. If it is
then FILE_RECOVERY_ERROR is returned. If CICS is unable to determine whether
the file is recoverable then FILE_RECOVERY_UNKNOWN is returned
- STORE_NAME
- The 8-character name of the Object Store
- [FILE_NAME]
- The optional 8-character name of the file to be used
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
CICS_TERMINATING
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
FILE_RECOVERY_ERROR
FILE_RECOVERY_UNKNOWN
FILE_REC_SIZE_ERROR
CTL_REC_FULL_ERROR
|
INVALID |
INVALID_OBJECT_TIMEOUT |
The REMOVE_OBJECT function of the EJOS gate is called to Remove an Object
instance from the specified Object Store.
Input parameters
- KEY_BLOCK
- A block containing the key of the Object to be removed
- STORE_NAME
- The 8-character name of the Object Store
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
OBJECT_NOT_FOUND
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The REMOVE_STORE function of the EJOS gate is called to Remove one or all
Object Stores from the specified file.
When a Store is removed, it should be removed or closed in every region
in which it is open. If not, then data may be lost.
Input parameters
- STORE_NAME |ALL
- The 8-character name of the Object Store
- [FILE_NAME]
- The optional 8-character name of the file to be used
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
STORE_NOT_OPEN
|
The STORE_OBJECT function of the EJOS gate is called to Store an Object
instance.
The Object is identified by a KEY of from 1 to (recordsize -64) bytes,
and the Object can be of any size.
If no Object with that key exists in the store then one is created in the
Passive state. If an Object with the same key already exists in the Store,
then the action depends on the REPLACE value (YES|NO|ACTIVE|PASSIVE). An exception
OBJECT_IS_ACTIVE or OBJECT_IS_PASSIVE indicates why an object was not replaced.
Input parameters
- STORE_NAME
- The 8-character name of the Object Store
- REPLACE
- Yes means that an Object with the same key will be replaced. NO means
that an Object with the same key will not be replaced. ACTIVE means that an
ACTIVE Object with the same key is replaced. PASSIVE means that a PASSIVE
Object with the same key is replaced. Values are
YES|NO|ACTIVE|PASSIVE
- KEY_BLOCK
- A block containing the key of the Object to be stored
- OBJECT_BLOCK
- A block containing the Object data to be stored
Output parameters
- RESPONSE
- is the domain's response to the call. It can have any of these values
OK|EXCEPTION|DISASTER|INVALID|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
FILE_CONNECT_ERROR
FILE_CORRUPT_ERROR
FILE_FULL_ERROR
FILE_IO_ERROR
FILE_KEY_LENGTH_ERROR
FILE_NOT_FOUND
OBJECT_IS_ACTIVE
OBJECT_IS_PASSIVE
STORE_NOT_OPEN
|
INVALID |
INVALID_KEYLENGTH |
The INQUIRE_CORBASERVER function of the EJSO gate is used by the EJ domain
to find any TCPIP parameters that are also kept in the corba server after
resolution time. This function is used by JAVA code and normal CICS code.
Input parameters
- CORBASERVER
- The 4 character name of the corba server.
Output parameters
- ASSERTED_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
ASSERTED attribute of the CORBASERVER.
- ASSERTED_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the ASSERTED attribute of the CORBASERVER.
- ASSERTED_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the ASSERTED attribute of the CORBASERVER.
- ASSERTED_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the ASSERTED attribute of the CORBASERVER.. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- BASIC_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
BASIC attribute of the CORBASERVER.
- BASIC_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the BASIC attribute of the CORBASERVER.
- BASIC_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the BASIC attribute of the CORBASERVER.
- BASIC_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the BASIC attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- UNAUTH_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
UNAUTH attribute of the CORBASERVER.
- UNAUTH_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the UNAUTH attribute of the CORBASERVER.
- UNAUTH_SSL
- An enumerated type of YES|NO|CLIENTAUTH taken from the TCPIPSERVICE
named in the UNAUTH attribute of the CORBASERVER.
- UNAUTH_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the UNAUTH attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- CLIENTCERT_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the CLIENTCERT attribute of the CORBASERVER. It is used to check
that the TCPIPSERVICE in the listener region has the same attributes as the
one in the AOR.
- SSLUNAUTH_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_SSL
- An enumerated type of clientauth taken from the TCPIPSERVICE named in
the SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the SSLUNAUTH attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- 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 |
CORBASERVER_ABSENT
LOCK_ERROR
|
DISASTER |
ABEND |
The AMEND_CORBASERVER function of the EJSO gate is used by the EJ domain
to update TCPIP parameters that are also kept in the corba server after resolution
time. This function is only used by DFHEJCG RESOLVE_CORBASERVER.
Input parameters
- CORBASERVER
- The 4 character name of the corba server.
- ASSERTED_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
ASSERTED attribute of the CORBASERVER.
- ASSERTED_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the ASSERTED attribute of the CORBASERVER.
- ASSERTED_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the ASSERTED attribute of the CORBASERVER.
- ASSERTED_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the ASSERTED attribute of the CORBASERVER.. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- BASIC_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
BASIC attribute of the CORBASERVER.
- BASIC_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the BASIC attribute of the CORBASERVER.
- BASIC_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the BASIC attribute of the CORBASERVER.
- BASIC_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the BASIC attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- UNAUTH_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
UNAUTH attribute of the CORBASERVER.
- UNAUTH_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the UNAUTH attribute of the CORBASERVER.
- UNAUTH_SSL
- An enumerated type of YES|NO|CLIENTAUTH taken from the TCPIPSERVICE
named in the UNAUTH attribute of the CORBASERVER.
- UNAUTH_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the UNAUTH attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
- CLIENTCERT_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_SSL
- An enumerated type of YES|CLIENTAUTH taken from the TCPIPSERVICE
named in the CLIENTCERT attribute of the CORBASERVER.
- CLIENTCERT_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the CLIENTCERT attribute of the CORBASERVER. It is used to check
that the TCPIPSERVICE in the listener region has the same attributes as the
one in the AOR.
- SSLUNAUTH_PORT
- A fullword containing the port number of the TCPIPSERVICE named in the
SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_PRIVACY
- An enumerated type of REQUIRED|SUPPORTED|NOTSUPPORTED taken
from the TCPIPSERVICE named in the SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_SSL
- An enumerated type of clientauth taken from the TCPIPSERVICE named in
the SSLUNAUTH attribute of the CORBASERVER.
- SSLUNAUTH_HASH
- A fullword created by the sockets domain to represent the TCPIPSERVICE
named in the SSLUNAUTH attribute of the CORBASERVER. It is used to check that
the TCPIPSERVICE in the listener region has the same attributes as the one
in the AOR.
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 DISASTER. Possible values
are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CORBASERVER_ABSENT
LOCK_ERROR
|
DISASTER |
ABEND |
The Enterprise Java (EJ) domain is logically divided into three parts:
- Elements, which covers the manipulation of the EJ Resources of CorbaServers
(EJCG), DJars (EJDG) and Beans (EJBJ)
- Object Stores, used to store stateful Session Beans, and to hold the EJB
Directory (EJOS and EJOB)
- Directory, used to record the association of OTS transactions and object
instances with Request Processors (EJDI).
[[ Contents Previous Page | Next Page Index ]]