Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference
The page named compilation(5) summarizes information about header files, libraries, and environment variables needed when compiling application source code.
The servopts page describes options that can be specified in the configuration file as the
CLOPT parameter of application servers.
ACL_MIB—Management Information Base for ACLs
ACL_MIB(5) consists of the following classes.
MIB(5) defines the generic
TA_FLAGS attribute which is a
long containing both generic and component MIB specific flag values. At this time, there are no
ACL_MIB(5) specific flag values defined.
The field tables for the attributes described in this reference page are found in the file udataobj/tpadm relative to the root directory of the Oracle Tuxedo system software installed on the system. The directory
${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the
FLDTBLDIR environment variable and the field table name
tpadm() should be included in the comma-separated list specified by the
FIELDTBLS environment variable.
The T_ACLGROUP class represents groups of Oracle Tuxedo application users and domains.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k )—GET key field ( r )—required field for object creation ( SET TA_STATE NEW) ( * )— GET/SET key, one or more required for SET operations
|
A GET operation will retrieve configuration information for the selected
T_ACLGROUP object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_ACLGROUP object is defined and inactive. Note that this is the only valid state for this class. ACL groups are never active.
|
A SET operation will update configuration information for the selected
T_ACLGROUP object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_ACLGROUP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_ACLGROUP object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_ACLGROUP object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state.
|
The T_ACLPERM class indicates what groups are allowed to access Oracle Tuxedo system entities. These entities are named via a string. The names currently represent service names, event names, and application queue names.
A GET operation will retrieve configuration information for the selected
T_ACLPERM object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_ACLPERM object is defined and inactive. Note that this is the only valid state for this class. ACL permissions are never active.
|
A SET operation will update configuration information for the selected
T_ACLPERM object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_ACLPERM object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_ACLPERM object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_ACLPERM object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state.
|
The T_ACLPRINCIPAL class represents users or domains that can access an Oracle Tuxedo application and the group with which they are associated. To join the application as a specific user, it is necessary to present a user-specific password.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k )—GET key field ( r )—required field for object creation ( SET TA_STATE NEW) ( * )— GET/SET key, one or more required for SET operations
|
A GET operation will retrieve configuration information for the selected
T_ACLPRINCIPAL object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_ACLPRINCIPAL object is defined and inactive. Note that this is the only valid state for this class. ACL principals are never active.
|
A SET operation will update configuration information for the selected
T_ACLPRINCIPAL object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_ACLPRINCIPAL object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_ACLPRINCIPAL object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_ACLPRINCIPAL object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state.
|
The field table tpadm must be available in the environment to have access to attribute field identifiers. This can be done at the shell level as follows:
obuf = tpalloc("FML32", NULL, 1000);
/* Set MIB(5) attributes defining request type *
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_ACLPRINCIPAL", 0);
/* Set ACL_MIB(5) attributes */
Fchg32(ibuf, TA_PRINNAME, 0, ta_prinname, 0);
Fchg32(ibuf, TA_PRINID, 0, (char *)ta_prinid, 0);
Fchg32(ibuf, TA_STATE, 0, (char *)"NEW", 0);
Fchg32(ibuf, TA_PRINPASSWD, 0, (char *)passwd, 0);
/* Make the request */
if (tpcall(".TMIB", (char *)ibuf, 0, (char **)obuf, olen, 0) 0) {
fprintf(stderr, "tpcall failed: %s\en", tpstrerror(tperrno));
if (tperrno == TPESVCFAIL) {
Fget32(obuf, TA_ERROR, 0,(char *)ta_error, NULL);
ta_status = Ffind32(obuf, TA_STATUS, 0, NULL);
fprintf(stderr, "Failure: %ld, %s\en",
ta_error, ta_status);
}
/* Additional error case processing */
}tpacall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
MIB(5),
TM_MIB(5)
APPQ_MIB—Management Information Base for /Q
APPQ_MIB(5) should be used in combination with the generic MIB reference page
MIB(5) to format administrative requests and interpret administrative replies. Requests formatted as described in
MIB(5) using classes and attributes described on this reference page may be used to request an administrative service using any one of a number of existing ATMI interfaces in an active application. Application queues in an inactive application may also be administered using the
tpadmcall() function interface. For additional information pertaining to all
APPQ_MIB(5) class definitions, see
APPQ_MIB(5) Additional Information on page 45.
APPQ_MIB(5) consists of the following classes.
MIB(5) defines the generic
TA_FLAGS attribute which is a
long containing both generic and component MIB-specific flag values. The following flag values are defined for the
APPQ_MIB(5) component. These flag values should be OR’d with any generic MIB flags.
When setting the TA_STATE attribute of a
T_APPQSPACE object to
CLEaning, this flag indicates that the state change should succeed even if the state of the queue space is
ACTive.
When setting the TA_STATE attribute of a
T_APPQSPACE object to
INValid, this flag indicates that the state change should succeed even if the queue space is
ACTive or if messages are present in any of its queues. Similarly, when setting the
TA_STATE attribute of a
T_APPQ object to
INValid, this flag allows the queue to be deleted even if messages are present or processes are attached to the queue space.
When setting the TA_STATE attribute of a
T_APPQ object to
INValid, this flag indicates that the state change should succeed even if messages are present on the queue. If, however, a message stored in the selected
T_APPQ object is currently involved in a transaction, the state change will fail and an error will be written to the user log.
The field table for the attributes described on this reference page is found in the file udataobj/tpadm relative to the root directory of the Oracle Tuxedo software installed on the system. The directory
${TUXDIR}/udataobj should be included by the application in the path list (semicolon-separated list on Windows and colon-separated list otherwise) specified by the
FLDTBLDIR environment variable and the field table name
tpadm should be included in the comma-separated list specified by the
FIELDTBLS environment variable.
|
•
|
SET operations are not allowed.
|
The T_APPQ class represents application queues. One or more application queues may exist in a single application queue space.
It is not possible to retrieve all instances of this class by leaving all key fields unset. Instead, sufficient key fields must be supplied to explicitly target a single application queue space. These required key fields are TA_APPQSPACENAME,
TA_QMCONFIG, and
TA_LMID, except when the application is unconfigured (that is, when the
TUXCONFIG environment variable is not set), in which case
TA_LMID must be omitted. For example, if the
TA_APPQSPACENAME,
TA_QMCONFIG, and
TA_LMID attributes are set in a request using
tpcall(), all
T_APPQ objects within the specified queue space will be retrieved.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{PRIO | TIME | LIFO | FIFO | EXPIR}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k )—GET key field f
( r )—required field for object creation ( * )—required SET key field
|
A GET operation retrieves information about the selected application queues. The following list describes the meaning of the
TA_STATE attribute returned in response to a
GET request.
A SET operation changes characteristics of the selected application queue or creates a new queue. The following list describes the meaning of the
TA_STATE attribute returned by a
SET request. States not listed cannot be set.
|
|
|
|
|
Delete the specified queue. The queue must be in state VALid to be deleted. If the queue space has processes attached to it (that is, it is in the ACTive state), the queue will not be deleted unless the TA_FLAGS attribute includes the QMIB_FORCEDELETE flag. In addition, if the queue has messages in it, it will not be deleted unless QMIB_FORCEPURGE is specified. Successful return leaves the object in the INValid state.
|
|
|
|
The order in which messages in the queue are to be processed. Legal values are PRIO,
TIME, or
EXPIR. A combination of sort criteria may be specified with the most significant criterion specified first, followed by other criteria, and optionally followed by either
LIFO or
FIFO, which are mutually exclusive. If
EXPIR is specified, messages with no expiration time are dequeued after all messages with an expiration time. If neither
FIFO nor
LIFO is specified,
FIFO is assumed. If no order is specified when a queue is created, the default order is
FIFO. For example, the following are settings are legal:
PRIO
PRIO,TIME,LIFO
TIME,PRIO,FIFO
TIME,FIFO
EXPIR
EXPIR,PRIO,FIFO
TIME,EXPIR,PRIO,FIFO
TA_CMD:
shell-command-string[0..127]
For example, if TA_CMDLW is
50m and
TA_CMDHW is
100m, the command specified in
TA_CMD will be executed when 100 messages are on the queue, and it will not be executed again until the queue has been drained below 50 messages and has filled again to 100 messages.
The messages threshold type specified via the TA_CMDHW and
TA_CMDLW attributes (when followed by an
m) applies to all messages in a queue, including both persistent and non-persistent messages, and therefore is not available as a threshold type for
TA_CMDNONPERSISTHW and
TA_CMDNONPERSISTLW.
This attribute specifies an expiration time for messages enqueued with no explicit expiration time. The expiration time may be either a relative expiration time or NONE. The relative expiration time is determined by associating a fixed amount of time with a message after the message arrives at the queue manager process. When a message's expiration time is reached and the message has not been dequeued or administratively deleted, all resources associated with the message are reclaimed by the system and statistics are updated. If a message expires during a transaction, the expiration does not cause the transaction to fail. Messages that expire while being enqueued or dequeued within a transaction are removed from the queue when the transaction ends. There is no notification that the message has expired. If no default expiration time is specified for a queue, messages without an explicit expiration time do not expire. When the queue's expiration time is modified, the expiration times of messages that were in the queue before the modification are not changed.
The format is +seconds where
seconds is the number of seconds allowed to lapse between the time that the queue manager successfully completes the operation and the time that the message is to expire. If
seconds is set to zero (
0) the message expires immediately.
The value of this attribute may also be set to the string NONE. The
NONE string indicates that messages enqueued to the queue with no explicit expiration time do not expire. You may change the expiration time for messages already in a queue with the
TA_EXPIRETIME attribute of the
T_APPQMSG class in the
APPQ_MIB.
This attribute specifies the default delivery policy for the queue when no delivery mode is specified for a message enqueued to the queue. When the value is PERSIST, messages enqueued to the queue without an explicitly specified delivery mode are delivered using the persistent (disk-based) delivery method. When the value is
NONPERSIST, messages enqueued to the queue without an explicitly specified delivery mode are delivered using the non-persistent (in memory) delivery method.When a queue's default delivery policy is modified, the delivery quality of service of messages that are in the queue before the modification are not changed. If the queue being modified is the reply queue named for any messages currently in the queue space, the reply quality of service is not changed for those messages as a result of changing the default delivery policy of the queue.
For non-persistent delivery, if the memory area is exhausted or fragmented such that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient persistent storage for the message. Similarly, if the persistent storage area is exhausted or fragmented such that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient non-persistent storage for the message. If the TA_MEMNONPERSIST attribute of the
T_APPQSPACE class is zero (
0) for a queue space, no space is reserved for non-persistent messages. In such a case, any attempt to enqueue a non-persistent message fails. This type of failure results, for example, when no delivery quality of service has been specified for a message and the
TA_DEFDELIVERYPOLICY attribute for the target queue has been set to
NONPERSIST.
The T_APPQMSG class represents messages stored in application queues. A message is not created by an administrator; instead, it comes into existence as a result of a call to
tpenqueue(). A message can be destroyed either by a call to
tpdequeue() or by an administrator. In addition, certain attributes of a message can be modified by an administrator. For example, an administrator can move a message from one queue to another queue within the same queue space or change its priority.
It is not possible to retrieve all instances of this class by leaving all key fields unset. Instead, sufficient key fields must be supplied to explicitly target a single application queue space. These required key fields are TA_APPQSPACENAME,
TA_QMCONFIG, and
TA_LMID, except when the application is unconfigured (that is, the
TUXCONFIG environment variable is not set), in which case
TA_LMID must be omitted. For example, if the
TA_APPQSPACENAME,
TA_QMCONFIG, and
TA_LMID attributes are set in a request using
tpcall(), all
T_APPQMSG objects in all queues of the specified queue space will be retrieved.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds}
|
|
|
|
|
|
{YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{PERSIST | NONPERSIST | DEFAULT}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{ YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds}
|
|
|
|
|
|
{ YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds}
|
|
|
|
|
|
{ YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds|NONE}
|
|
|
|
|
|
{ YY[ MM[ DD[ hh[ mm[ ss]]]]] | + seconds}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k )—GET key field d
( * )—required SET key field
|
A GET operation retrieves information about the selected messages. The following list describes the meaning of the
TA_STATE attribute returned in response to a
GET request.
A SET operation changes characteristics of the selected message. The following list describes the meaning of the
TA_STATE attribute returned by a
SET request. States not listed cannot be set.
The T_APPQSPACE class represents application queue spaces. An application queue space is an area in an Oracle Tuxedo system device; see the
T_DEVICE class in
TM_MIB(5) for more information about devices and their attributes. Each queue space typically contains one or more application queues, and each queue may have messages stored in it.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ INA | INI | OPE | ACT} ”
SET: “{ NEW | OPE | CLE | INV} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k )—GET key field ( r )—required field for object creation ( * )—required SET key field
|
GET: {
INActive |
INItializing |
OPEn |
ACTive}
A GET operation retrieves information about the selected application queue space. The following list describes the meaning of the
TA_STATE attribute returned in response to a
GET request.
SET: {
NEW |
OPEn |
CLEaning |
INValid}
A SET operation changes the selected application queue space or creates a new one. The following list describes the meaning of the
TA_STATE attribute returned by a
SET request. States not listed cannot be set.
If the value is specified in bytes (b) for this attribute, the system divides the specified value by the number of bytes per
page (page size is equivalent to the disk page size), rounds down the result to the nearest integer, and allocates that number of pages of memory. For example, assuming a page size of 1024 bytes (1KB), a requested value of 2000b results in a memory allocation of 1 page (1024 bytes), and a requested value of 2048b results in a memory allocation of 2 pages (2048 bytes). Requesting a value less than the number of bytes per page results in an allocation of 0 pages (0 bytes).
If the value is specified in blocks (B) for this attribute and assuming that one block of memory is equivalent to one page of memory, the system allocates the same value of pages. For example, a requested value of 50B results in a memory allocation of 50 pages.
If TA_MEMNONPERSIST for a queue space is zero (
0) for a queue space, no space is reserved for non-persistent messages. In this case, any attempt to enqueue a non-persistent message fails. This type of failure results, for example, when no delivery quality of service has been specified for a message and the
TA_DEFDELIVERYPOLICY attribute of the
T_APPQ class for the target queue has been set to
NONPERSIST. For non-persistent delivery, if the memory area is exhausted or fragmented such that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient persistent storage for the message. Similarly, if the persistent storage area is exhausted or fragmented such that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient non-persistent storage for the message.
The T_APPQTRANS class represents run-time attributes of transactions associated with application queues.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | ABY | ABD | COM | REA | DEC | HAB | HCO} ”
|
|
( k )—GET key field c
( * )—required SET key field
|
Transaction identifier as returned by tx_info() and mapped to a string representation. The data in this field should not be interpreted directly by the user except for equality comparison.
GET: {
ACTive |
ABortonlY |
ABorteD |
COMcalled |
REAdy |
DECided |
HAbord |
HCommit}
A GET operation retrieves run-time information about the selected transactions. The following list describes the meaning of the
TA_STATE attribute returned in response to a
GET request. All states are
ACTive equivalent for purposes of permissions checking.
A SET operation updates the state of the selected transactions. The following list describes the meaning of the
TA_STATE attribute returned by a
SET request. States not listed cannot be set.
|
•
|
SET operations are not allowed.
|
The field table tpadm must be available in the environment to allow access to attribute field identifiers. This can be done at the shell level as follows:
/* Allocate the buffer; see above */
/* Build the request to create a new device on SITE1 */
Fchg32(rqbuf, TA_OPERATION, 0, "SET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_DEVICE", 0);
Fchg32(rqbuf, TA_STATE, 0, "NEW", 0);
Fchg32(rqbuf, TA_CFGDEVICE, 0, "/dev/q/dsk001", 0);
Fchg32(rqbuf, TA_LMID, 0, "SITE1", 0);
size = 500;
Fchg32(rqbuf, TA_DEVSIZE, 0, (char *)size, 0);
/* Make the request; see above */
/* Reinitialize the same buffer for reuse */
Finit32(rqbuf, (FLDLEN) Fsizeof32(rqbuf));
/* Build the request to create the queue space */
Fchg32(rqbuf, TA_OPERATION, 0, "SET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_APPQSPACE", 0);
Fchg32(rqbuf, TA_STATE, 0, "NEW", 0);
Fchg32(rqbuf, TA_APPQSPACENAME, 0, "QSPACE1", 0);
Fchg32(rqbuf, TA_QMCONFIG, 0, "/dev/q/dsk001", 0);
Fchg32(rqbuf, TA_LMID, 0, "SITE1", 0);
Fchg32(rqbuf, TA_ERRORQNAME, 0, "errque", 0);
ipckey = 123456;
Fchg32(rqbuf, TA_IPCKEY, 0, (char *)ipckey, 0);
maxmsg = 100;
Fchg32(rqbuf, TA_MAXMSG, 0, (char *)maxmsg, 0);
maxpages = 200;
Fchg32(rqbuf, TA_MAXPAGES, 0, (char *)maxpages, 0);
maxproc = 50;
Fchg32(rqbuf, TA_MAXPROC, 0, (char *)maxproc, 0);
maxqueues = 10;
Fchg32(rqbuf, TA_MAXQUEUES, 0, (char *)maxqueues, 0);
maxtrans = 100;
Fchg32(rqbuf, TA_MAXTRANS, 0, (char *)maxtrans, 0);
/* Make the request; see above */
/* Build the request */
Fchg32(rqbuf, TA_OPERATION, 0, "SET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_APPQ", 0);
Fchg32(rqbuf, TA_STATE, 0, "NEW", 0);
Fchg32(rqbuf, TA_APPQNAME, 0, "errque", 0);
Fchg32(rqbuf, TA_APPQSPACENAME, 0, "QSPACE1", 0);
Fchg32(rqbuf, TA_QMCONFIG, 0, "/dev/q/dsk001", 0);
Fchg32(rqbuf, TA_LMID, 0, "SITE1", 0);
Fchg32(rqbuf, TA_APPQORDER, 0, "PRIO", 0);
/* Make the request; see above */
/* Build the request to retrieve all TMS_QM groups */
Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_GROUP", 0);
Fchg32(rqbuf, TA_TMSNAME, 0, "TMS_QM", 0);
fldid1 = TA_OPENINFO;
fldid2 = TA_LMID;
Fchg32(rqbuf, TA_FILTER, 0, (char *)fldid1, 0);
Fchg32(rqbuf, TA_FILTER, 0, (char *)fldid2, 1);
/* Make the request, assuming we are joined to the application */
rval = tpcall(".TMIB", rqbuf, 0, rpbuf, rplen, flags);
/* For each TMS_QM group, build the request to retrieve its queue space */
rval = Fget32(*rpbuf, TA_OCCURS, 0, (char *)occurs, NULL);
for (i = 0; i occurs; i++) {
/* Reinitialize the buffer and set all common attributes */
Finit32(rqbuf, (FLDLEN) Fsizeof32(rqbuf));
Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_APPQSPACE", 0);
/* Get the OPENINFO to determine device and queue space name */
/* OPENINFO has the format <resource-mgr>:<qmconfig>:<appqspacename> */
/* or on Windows <resource-mgr>:<qmconfig>;<appqspacename> */
rval = Fget32(rpbuf, TA_OPENINFO, i, openinfo, NULL);
/* The device is the 2nd field in OPENINFO */
qmconfig = strchr(openinfo, ':') + 1;
/* The queue space name is the 3rd field in OPENINFO */
#if defined(_TMDOWN) || defined(_TM_NETWARE)
#define pathsep ";" /* separator for PATH */
#else
#define pathsep ":" /* separator for PATH */
#endif
appqspacename = strchr(qmconfig, pathsep);
appqspacename[0] = '\e0'; /* NULL-terminate qmconfig */
appqspacename++; /* bump past the NULL */
/* Set the APPQSPACENAME and QMCONFIG keys */
Fchg32(rqbuf, TA_APPQSPACENAME, 0, appqspacename, 0);
Fchg32(rqbuf, TA_QMCONFIG, 0, qmconfig, 0);
/* Get the LMID (assume no migration for this group) */
rval = Fget32(rpbuf, TA_LMID, i, lmid, NULL);
Fchg32(rqbuf, TA_LMID, 0, lmid, 0);
/* Make the request */
rval = tpcall(".TMIB", rqbuf, 0, rpbuf2, rplen2, flags);
}
/* Build the request */ Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_APPQMSG", 0);
Fchg32(rqbuf, TA_APPQNAME, 0, "STRING", 0);
Fchg32(rqbuf, TA_APPQSPACENAME, 0, "QSPACE1", 0);
Fchg32(rqbuf, TA_QMCONFIG, 0, "/dev/q/dsk001", 0);
Fchg32(rqbuf, TA_LMID, 0, "SITE1", 0);
/* Make the request; see above */
/* Build the request */ Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "T_APPQTRANS", 0);
Fchg32(rqbuf, TA_APPQSPACENAME, 0, "QSPACE1", 0);
Fchg32(rqbuf, TA_QMCONFIG, 0, "/dev/q/dsk001", 0);
Fchg32(rqbuf, TA_LMID, 0, "SITE1", 0);
/* Make the request; see above */
tpacall(3c),
tpadmcall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
MIB(5),
TM_MIB(5)
AUTHSVR—Server providing per-user authentication
AUTHSVR is an Oracle Tuxedo provided server that offers the authentication service. This server may be used in a secure application to provide per-user authentication when clients join the application. This server accepts service requests containing
TPINIT typed buffers for client processes requesting access to the application. It uses the data field of the
TPINIT typed buffer as a user password and validates it against the configured password. If the request passes validation, an application key is returned with a successful return as the ticket to be used by the client.
The rcode parameter of
tpreturn(3c) is used to set the application key. It is returned (in
tpurcode) to the code that has called
tpinit(3c) upon either successful validation or permission failure.
If SECURITY is set to
USER_AUTH, per-user authentication is enforced. The name of the authentication service can be configured for the application using the
AUTHSVC parameter in the
RESOURCES section of the
UBBCONFIG file. For example, the following
AUTHSVC parameter setting specifies the authentication service (
AUTHSVC) advertised by
AUTHSVR when
SECURITY is set to
USER_AUTH.
If the AUTHSVC parameter is not specified, the authentication service defaults to
AUTHSVC.
By default, the file tpusr in the directory referenced by the first pathname defined in the application’s
APPDIR variable is searched for password information;
/etc/passwd is used if this file does not exist (although this file cannot be used correctly on systems that have a shadow password file). The file can be overridden by specifying the filename using a "
-f filename" option in the server command-line options (for example,
CLOPT="-A -- -f /usr/tuxedo/users"). Note that automatic propagation of the user file from the master machine to other machines in the configuration is done only if
$APPDIR/tpusr is used.
|
Note:
|
To use tpusradd(), tpusrdel(), and tpusrmod(), SECURITY for the target application must be set to USER_AUTH, ACL, or MANDATORY_ACL. Otherwise, the system returns an error when you attempt to use these programs.
|
The reserved client name values tpsysadm (system administrator) and
tpsysop (system operator) are treated specially by
AUTHSVR(5) when processing authentication requests. These values are not allowed to match wildcard client names in the user file.
Note that a standard AUTHSVR is shipped as part of the system in
${TUXDIR}/bin/AUTHSVR and has the semantics as described above. Sample source code is provided in
${TUXDIR}/lib/AUTHSVR.c. The
AUTHSVR can be replaced by an application authentication server that validates users and user data (which may not be a password) in an application-dependent fashion (for example, using Kerberos). If you plan to replace
AUTHSVR, take special note of the warning later in this reference page. It is also up to the application to determine what value is returned from the authentication service to be used for the application key (which is passed to each service).
If SECURITY is set to
ACL or
MANDATORY_ACL, per-user authentication is enforced, and access control lists are supported for access to services, application queues, and events. The name of the authentication service can be configured for the application using the
AUTHSVC parameter in the
RESOURCES section of the
UBBCONFIG file. For example, the following
AUTHSVC parameter setting specifies the authentication service (
..AUTHSVC) advertised by
AUTHSVR when
SECURITY is set to
ACL or
MANDATORY_ACL.
If the AUTHSVC parameter is not specified, the authentication service defaults to
..AUTHSVC.
|
Note:
|
AUTHSVR advertises the authentication service as AUTHSVC when SECURITY is set to USER_AUTH, and as ..AUTHSVC when SECURITY is set to ACL or MANDATORY_ACL. AUTHSVC and ..AUTHSVC point to the same authentication service.
|
The user file must be $APPDIR/tpusr. It is automatically propagated from the master machine to other active machines in the configuration. One instance of the
AUTHSVR must be run on the master machine. Additional copies can be run on other active machines in the configuration.
The reserved client name values tpsysadm (system administrator) and
tpsysop (system operator) are treated specially by
AUTHSVR(5) when processing authentication requests. These values are not allowed to match wildcard client names in the user file.
The application key that is returned by the AUTHSVR is the user identifier in the low order 17 bits and the group identifier in the next 14 bits (the high order bit is reserved for administrative keys). The application keys that correspond to
tpsysadm and
tpsysop are 0x80000000 and 0xC0000000, respectively. This application key is passed to every service in the
appkey element of the
TPSVCINFO structure.
For SECURITY ACL or
MANDATORY_ACL, you must use the standard
AUTHSVR shipped as part of the system in
${TUXDIR}/bin/AUTHSVR.
|
WARNING:
|
${TUXDIR}/lib/AUTHSVR.c is not the source file used to generate ${TUXDIR}/bin/AUTHSVR (don't clobber this executable); if you provide your own AUTHSVR, it is recommended that you install it in ${APPDIR}.
|
AUTHSVR is supported as an Oracle Tuxedo-supplied server on non-Workstation platforms.
Accesslog(5) assists with recording client login/logoff action with timestamp and location information. It creates an access log file and adds one line to the Tuxedo ULOG file. For more information, see
Examples and
ULOG File Entry.
Values are logon|logon with
AUTH.
|logoff|logoff with
AUTH|cleaned.
logon with
AUTH: client login with authentication required
logoff with
AUTH: authenticated client logoff
cleaned: client expired without
tpterm.
|
•
|
NATIVE: native TUXEDO & COBOL client.
|
|
•
|
/WS: workstation & .Net & WSCOBOL client.
|
Listing 2 shows an example
Accesslog file output.
|
Notes:
|
In the ULOG, Accesslog(5) output does not include system server, app server statistics. highwater and currentclientcount may be empty if it was not printed by BBL.
|
Listing 3 shows an example ULOG file with added
Accesslog(5) line.
If environment ALOGPFX is not specified, the default
$APPDIR/access is used. The date "mmddyy" (month, day, year) is appended to the log filename prefix. The access log filename length should less then 255 characters.
compilation—Instructions for compilation of Oracle Tuxedo ATMI system application components.
Link editing must be done by running buildclient or
buildserver, but the system allows more flexibility about how compiling is done. If you prefer, you can use the compile command of your choice to compile your files, and then run
buildclient or
buildserver to perform the link editing.
|
|
|
|
|
|
•
|
TUXDIR—always required for servers; also required for native clients
|
|
•
|
CC—if you want to use a non-default compiler
|
|
•
|
CFLAGS—if you want to specify flags to be passed to the compiler
|
|
|
|
|
•
|
FIELDTBLS—a comma-separated list of field table files
|
|
•
|
FLDTBLDIR—a colon-separated list of directories to search for the FIELDTBLS
|
|
|
|
TUXCONFIG—full pathname of the binary configuration file (default is the current directory)
|
|
|
|
|
|
|
•
|
WSENVFILE—file containing environment variable settings
|
|
•
|
WSDEVICE—network device to use for connection
|
|
•
|
WSTYPE—workstation machine type
|
|
#include <UNIX_header_files> (if needed by the application)
#include "fml.h"
where pgm is the name of the executable file.
If the -L option is not locally supported, use the following command, instead:
Here view_file is a set of one or more files containing source view descriptions.
|
Note:
|
viewc invokes the C compiler. The environment variable CC can be used to designate the compiler to use. The environment variable CFLAGS can be used to pass a set of parameters to the compiler.
|
DMADM—Domains administrative server
DMADM SRVGRP = "identifier"
SRVID = "number"
REPLYQ = "N"
DMADM is described in the
SERVERS section of the
UBBCONFIG file as a server running within a group, for example,
DMADMGRP. There should be only one instance of the
DMADM running in this group, and it must not have a reply queue (
REPLYQ must be set to “
N”).
The BDMCONFIG environment variable should be set to the pathname of the file containing the binary version of the
DMCONFIG file.
DMADM is supported as an Oracle Tuxedo system-supplied server on all supported server platforms.
DMADM must be installed on Oracle Tuxedo release 5.0 or later; other machines in the same domain with a release 5.0 gateway may be release 4.1 or later.
DMCONFIG—Text version of a Domains configuration file
A Domains configuration is a set of two or more domains (business applications) that can communicate and share services with the help of the Oracle Tuxedo Domains component. How multiple domains are connected and which services they make accessible to each other are defined in a Domains configuration file for each Oracle Tuxedo domain participating in the Domains configuration. The text version of a Domains configuration file is known as the
DMCONFIG file, although the configuration file may have any name as long as the content of the file conforms to the format described on this reference page.
The DMCONFIG file is parsed and loaded into a binary version, called
BDMCONFIG, by the
dmloadcf(1) utility. As with
DMCONFIG, the
BDMCONFIG file may be given any name; the actual name is the device or system filename specified in the
BDMCONFIG environment variable. One
BDMCONFIG file is required for each Tuxedo domain participating in a Domains configuration.
The DMCONFIG and
BDMCONFIG files are analogous to the
UBBCONFIG and
TUXCONFIG files used to define an Oracle Tuxedo domain. For a description of the
UBBCONFIG and
TUXCONFIG files, see
UBBCONFIG(5).
There is one Domains administrative server (
DMADM) process running in each Oracle Tuxedo domain involved in a Domains configuration. The
DMADM is the administrative server for all domain gateway groups running in a particular Oracle Tuxedo domain.
A domain gateway group consists of an Oracle Tuxedo system
gateway administrative server (
GWADM) process and an Oracle Tuxedo system domain gateway process.
An Oracle Tuxedo system domain gateway process provides communication services with a specific type of transaction processing (TP) domain; for example, the
GWTDOMAIN process enables Oracle Tuxedo applications to communicate with other Oracle Tuxedo applications. A domain gateway relays requests to another domain and receives replies.
A local domain access point is a user-specified logical name representing a set of services of the Oracle Tuxedo domain that is made available to other domains (remote domains). A local domain access point maps to a domain gateway group; both terms are used as synonyms.
A remote domain access point is a user-specified logical name representing a set services of a remote domain that is made available to the local domain. The remote domain may be another Oracle Tuxedo application or an application running on another TP system.
A remote service is a service provided by a remote domain that is made available to the local domain through a remote domain access point and a local domain access point.
A local service is a service of the local domain that is made available to remote domains through a local domain access point.
The DMCONFIG file is made up of the following specification sections:
|
•
|
DM_LOCAL (also known as DM_LOCAL_DOMAINS)
|
|
•
|
DM_TDOMAIN (section for domain gateways of type TDOMAIN)
|
|
•
|
DM_dom, where dom may be any of the following sections for other domain gateway types: SNACRM, SNASTACKS, SNALINKS, OSITP, OSITPX.
|
Lines in a DMCONFIG file beginning with an asterisk (*) indicate the beginning of a specification section. Each such line contains the name of the section immediately following the *. The asterisk is required when specifying a section name. The
DM_LOCAL section must precede the
DM_REMOTE section.
Parameters are generally specified by: KEYWORD = value; white space (space or tab character) is allowed on either side of the equal sign (
=). This format sets
KEYWORD to
value. Valid keywords are described below within each section.
Lines beginning with the reserved word DEFAULT contain parameter specifications that apply to all lines that follow them in the section in which they appear. Default specifications can be used in all sections. They can appear more than once in the same section. The format for these lines is:
DEFAULT: [KEYWORD1 =
value1 [
KEYWORD2 =
value2 [...]]]
The values set on this line remain in effect until reset by another DEFAULT line, or until the end of the section is reached. These values can also be overridden on non-
DEFAULT lines by placing the optional parameter setting on the line. If on a non-
DEFAULT line, the parameter setting is valid for that line only; lines that follow revert to the default setting. If
DEFAULT appears on a line by itself, all previously set defaults are cleared and their values revert to the system defaults.
If a value is numeric, standard C notation is used to denote the base, that is, 0x prefix for base 16 (hexadecimal), 0 prefix for base 8 (octal), and no prefix for base 10 (decimal). The range of values acceptable for a numeric parameter are given under the description of that parameter.
If a value is an identifier (a string value already known to the Oracle Tuxedo Domains component such as
TDOMAIN for the
TYPE parameter), standard C rules are typically used. A standard C
identifier starts with an alphabetic character or underscore and contains only alphanumeric characters or underscores. The maximum allowable length of an identifier is 30 bytes (not including the terminating
NULL).
"#" introduces a comment. A newline ends a comment.
For backwards compatibility, aliases are provided between the DMCONFIG terminology used prior to Oracle Tuxedo 7.1 and the improved Domains MIB terminology. For Oracle Tuxedo release 7.1 or later, both versions of
DMCONFIG terminology are accepted. The following table shows the mapping of the previous and improved terminology for the
DMCONFIG file.
For Oracle Tuxedo release 7.1 or later, the dmunloadcf command generates by default a
DMCONFIG file that uses the improved domains terminology. Use the
-c option to print a
DMCONFIG file that uses the previous domains terminology. For example:
prompt> dmunloadcf -c > dmconfig_prev
This section, also known as the DM_LOCAL_DOMAINS section, defines one or more local domain access point identifiers and their associated gateway groups. The section must have a local domain access point entry for each active gateway group defined in the
UBBCONFIG file. Each entry specifies the parameters required for the domain gateway process running in that group.
LocalAccessPoint required_parameters [
optional_parameters]
where LocalAccessPoint is the local domain access point identifier (logical name) that you choose to represent a particular gateway group defined in the
UBBCONFIG file.
LocalAccessPoint must be unique across the local and remote domains involved in a Domains configuration. As you will see in the description of the
DM_EXPORT section, you use the local domain access point to associate local services with the gateway group. The local services available through the local domain access point will be available to clients in one or more remote domains.
The TDOMAIN value indicates that this local domain access point is associated with a
GWTDOMAIN gateway instance and therefore can communicate with another Oracle Tuxedo application.
The SNAX value indicates that this local domain access point is associated with a
GWSNAX gateway instance and therefore can communicate with another TP domain via the SNA protocol.
The OSITP or
OSITPX value indicates that this local domain access point is associated with a
GWOSITP gateway instance and therefore can communicate with another TP domain via the OSI TP protocol. The
OSITP value indicates the use of the OSI TP 1.3 protocol, and the
OSITPX value indicates the use of the OSI TP 4.0 or later protocol. The
OSITPX value is supported only by Oracle Tuxedo 8.0 or later software.
The value of string can be a sequence of characters (for example, “
BA.CENTRAL01”), or a sequence of hexadecimal digits preceded by
0x (for example, “
0x0002FF98C0000B9D6”).
ACCESSPOINTID must be 30 bytes or fewer in length. If the value is a string, it must be 30 characters or fewer (counting the trailing
NULL).
AUDITLOG = string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Be aware that interdomain transactions generate blocking timeout conditions when transaction duration exceeds
BLOCKTIME. That is, for an interdomain transaction, if the
BLOCKTIME value is less than (a) the
TRANTIME timeout value specified in the
SERVICES section of the
TUXCONFIG file or (b) the timeout value passed in a
tpbegin() call to start the transaction, the timeout for the transaction is reduced to the
BLOCKTIME value. In contrast, for
intradomain transactions (that is, transactions handled within a single Oracle Tuxedo domain), the
BLOCKTIME value specified in the
RESOURCES section of the
TUXCONFIG file has
no effect on the timeout of an intradomain transaction.
A connection policy of ON_DEMAND means that a domain gateway attempts to establish a connection with a remote domain only when requested by either a client request to a remote service or a
dmadmin(1) connect command. The default for
CONNECTION_POLICY is
ON_DEMAND. Connection retry processing is not allowed when the connection policy is
ON_DEMAND.
A connection policy of ON_STARTUP means that a domain gateway attempts to establish a connection with its remote domains at gateway server initialization time. If
CONNECTION_POLICY is set to
ON_STARTUP, the remote services for a particular remote domain (that is, services advertised by the domain gateway) are advertised only if a connection is successfully established to the remote domain. Thus, if there is no active connection to the remote domain, the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds, but you can specify a different value for this interval using the
RETRY_INTERVAL parameter. Also, see the
MAXRETRY parameter.
A connection policy of INCOMING_ONLY means that a domain gateway does not attempt an initial connection upon startup and that remote services are initially suspended. The domain gateway is available for incoming connections from remote domains, and remote services are advertised when the domain gateway receives an incoming connection or an administrative connection (using the
dmadmin(1) connect command) is made. Connection retry processing is not allowed when the connection policy is
INCOMING_ONLY.
A PERSISTENT_DISCONNECT connection policy means that the local domain rejects connections from other domains. The domain gateway does not attempt to connect to the remote domain as well. Related remote service is suspended accordingly. The local domain is isolated until it is manually changed to another connection policy.
|
Note:
|
For domain gateways of type TDOMAIN running Oracle Tuxedo 8.1 or later software, CONNECTION_POLICY can be specified on a per remote domain basis in the DM_TDOMAIN section.
|
The minimum value for MAXRETRY is 0, and the maximum value is
MAXLONG (2147483647).
MAXLONG, the default, indicates that retry processing will be repeated indefinitely, or until a connection is established. Setting
MAXRETRY=0 turns off the automatic retry mechanism.
The minimum value for RETRY_INTERVAL is 0, and the maximum value is 2147483647. The default is 60. If
MAXRETRY is set to 0, setting
RETRY_INTERVAL is not allowed.
The CONNECTION_PRINCIPAL_NAME parameter may contain a maximum of 511 characters (excluding the terminating
NULL character). If this parameter is not specified, the connection principal name defaults to the
ACCESSPOINTID string for this local domain access point.
For default authentication plug-ins, if a value is assigned to the CONNECTION_PRINCIPAL_NAME parameter for this local domain access point, it must be the same as the value assigned to the
ACCESSPOINTID parameter for this local domain access point. If these values do not match, the local TDomain gateway process will
not boot, and the system will generate the following
userlog(3c) message:
ERROR: Unable to acquire credentials.
DMTLOGDEV = string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the Oracle Tuxedo filesystem that contains the Domains transaction log (TLOG) for this local domain access point. The
TLOG is stored as an Oracle Tuxedo system VTOC table on the device. If this parameter is not specified, the domain gateway group associated with this local domain access point is not allowed to process requests in transaction mode. Multiple local domain access points for the same machine can share the same Oracle Tuxedo filesystem, but each local domain access point must have its own log (a table in the
DMTLOGDEV) named as specified by the
DMTLOGNAME parameter.
Specifies the name of the TLOG for this local domain access point. This name must be unique when the same Oracle Tuxedo filesystem (as specified in
DMTLOGDEV) is used for several local domain access points. If this parameter is not specified, the default is the string
DMTLOG. The name must be 30 characters or less.
A YES value indicates Dynamic Remote Access Point is allowed. When this feature is enabled and all the remote access points that are capable of requesting dynamic registration, they do not need to be configured in the
/Domain configuration.
A NO value indicates Dynamic Remote Access Point is not allowed. This is the default behavior.
Specifies the numeric size, in pages, of the TLOG for this local domain access point. It must be greater than 0 and less than the amount of available space on the Oracle Tuxedo filesystem. If this parameter is not specified, the default is 100 pages.
If MTYPE is not specified, the default is to turn encoding/decoding on. If the value set for the
MTYPE field is the same in both the
DM_LOCAL and the
DM_REMOTE section of a
DMCONFIG file, data encoding/decoding is bypassed. The value set for
MTYPE can be any string value up to 15 characters in length. It is used only for comparison.
Specifies the type of application security to be enforced for this local domain access point. The SECURITY parameter currently has three valid values for domain gateways of type
TDOMAIN:
NONE,
APP_PW, or
DM_PW. The value
NONE (the default) indicates that no security is used. The value
APP_PW indicates that the application password security is to be enforced when a connection is established from a remote domain; the application password is defined in the
TUXCONFIG file. The value
DM_PW indicates that Domains password security is to be enforced when a connection is established from a remote domain; Domains passwords are defined through the
dmadmin(1) command.
The SECURITY parameter does not apply to domain gateways of type
OSITP. For gateways of type
OSITPX, the values
NONE or
DM_PW can be used. For gateways of type
SNAX, the values
NONE or
DM_USER_PW can be used.
The following DM_LOCAL section parameters do not apply to domain gateways of type
TDOMAIN but are included here for completeness:
|
•
|
BLOB_SHM_SIZE = numeric — applicable to domain gateways of type SNAX
|
|
•
|
MAXACCESSPOINT (also known as MAXRDOM) = numeric — applicable to domain gateways of type OSITP
|
|
•
|
MAXDATALEN = numeric — applicable to domain gateways of type OSITP
|
RemoteAccessPoint required_parameters [
optional_parameters]
where RemoteAccessPoint is a remote domain access point identifier (logical name) that you choose to identify each remote domain known to the local Oracle Tuxedo application.
RemoteAccessPoint must be unique across the local and remote domains involved in a Domains configuration. As you will see in the description of the
DM_IMPORT section, you use a remote domain access point to associate remote services with a particular remote domain. The remote services available through the remote domain access point will be available to clients in the local domain through a remote domain access point and a local domain access point.
The TDOMAIN value indicates that a local instance of the
GWTDOMAIN process will communicate with a remote Oracle Tuxedo application.
The SNAX value indicates that a local instance of the
GWSNAX process will communicate with a remote TP domain via the SNA protocol.
The OSITP value indicates that a local instance of the
GWOSITP process will communicate with a remote TP domain via the OSI TP 1.3 protocol.
The OSITPX value indicates that a local instance of the
GWOSITP process will communicate with a remote TP domain via the OSI TP 4.0 or later protocol. The
OSITPX value is supported only by Oracle Tuxedo 8.0 or later software.
ACCESSPOINTID must be 30 bytes or fewer in length. If the value is a string, it must be 30 characters or fewer (counting the trailing
NULL). The value of
string can be a sequence of characters or a sequence of hexadecimal digits preceded by
0x.
LOCAL means that the local domain
replaces the credential (identity) of any service request received from the remote domain
with the principal name specified in the
LOCAL_PRINCIPAL_NAME parameter for this remote domain access point.
GLOBAL means that the local domain does not replace the credential received with a remote service request; if no credential is received with a remote service request, the local domain forwards the service request to the local service
as is (which usually fails). If this parameter is not specified, the default is
LOCAL.
Note that the ACL_POLICY parameter controls whether or not the local domain replaces the credential of a service request received from a remote domain with the principal name specified in the
LOCAL_PRINCIPAL_NAME parameter. The
CREDENTIAL_POLICY parameter is related to this parameter and controls whether or not the local domain removes the credential from a local service request before sending the request to a remote domain.
The LOCAL_PRINCIPAL_NAME parameter may contain a maximum of 511 characters (excluding the terminating
NULL character). If this parameter is not specified, the local principal name defaults to the
ACCESSPOINTID string for this remote domain access point.
The CONNECTION_PRINCIPAL_NAME parameter may contain a maximum of 511 characters (excluding the terminating
NULL character). If this parameter is not specified, the connection principal name defaults to the
ACCESSPOINTID string for this remote domain access point.
For default authentication plug-ins, if a value is assigned to the CONNECTION_PRINCIPAL_NAME parameter for this remote domain access point, it must be the same as the value assigned to the
ACCESSPOINTID parameter for this remote domain access point. If these values do not match, any attempt to set up a connection between the local TDomain gateway and the remote TDomain gateway will fail, and the system will generate the following
userlog(3c) message:
ERROR: Unable to initialize administration key for domain domain_name.
LOCAL means that the local domain removes the credential (identity) from a local service request destined for this remote domain access point.
GLOBAL means that the local domain does not remove the credential from a local service request destined for this remote domain access point. If this parameter is not specified, the default is
LOCAL.
Note that the CREDENTIAL_POLICY parameter controls whether or not the local domain removes the credential from a local service request before sending the request to a remote domain. The
ACL_POLICY parameter is related to this parameter and controls whether or not the local domain replaces the credential of a service request received from a remote domain with the principal name specified in the
LOCAL_PRINCIPAL_NAME parameter.
If MTYPE is not specified, the default is to turn encoding/decoding on. If the value set for the
MTYPE field is the same in both the
DM_LOCAL and the
DM_REMOTE section of a
DMCONFIG file, data encoding/decoding is bypassed. The value set for
MTYPE can be any string value up to 15 characters. It is used only for comparison.
Together, the PRIORITY_TYPE and
INPRIORITY parameters specify the message priority handling for this remote domain access point. These parameters are supported by Oracle Tuxedo 8.0 or later software.
For the PRIORITY_TYPE parameter, the
LOCAL_RELATIVE and
LOCAL_ABSOLUTE values are valid for all remote domain types; the
GLOBAL value is valid only for remote domains of type
TDOMAIN. If not set, the
PRIORITY_TYPE parameter defaults to
LOCAL_RELATIVE.
PRIORITY_TYPE=LOCAL_RELATIVE means that the priority associated with a request from this remote domain access point (for example, via the
tpsprio call) is not used by the local domain. Instead, the priority of incoming requests from this remote domain access point is set relative to the
INPRIORITY value; this value may be greater than or equal to -99 (lowest priority) and less than or equal to 99 (highest priority), with 0 being the default. The setting of
INPRIORITY increments or decrements a service’s default priority as follows: up to a maximum of 100 or down to a minimum of 1, depending on its sign, where 100 is the highest priority. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
PRIORITY_TYPE=LOCAL_ABSOLUTE means that the priority associated with a request from this remote domain access point is not used by the local domain. Instead, the priority of incoming requests from this remote domain access point is set relative to the
INPRIORITY value; this value may be greater than or equal to 1 (lowest priority) and less than or equal to 100 (highest priority), with 50 being the default. The setting of
INPRIORITY increments or decrements a service’s default priority as follows: up to a maximum of 100 or down to a minimum of 1, depending on its sign, where 100 is the highest priority. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
PRIORITY_TYPE=GLOBAL means that the priority associated with a request from this remote domain access point is adjusted by the local domain. The priority of incoming requests from this remote domain access point is adjusted relative to the
INPRIORITY value; this value may be greater than or equal to -99 (lowest priority) and less than or equal to 99 (highest priority), with 0 being the default. If
INPRIORITY is set, the priority accompanying the incoming request is added to the
INPRIORITY value to create an absolute priority setting for the incoming request. If
INPRIORITY is not set or is set to 0, the priority accompanying the incoming request is used
as is by the local domain. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
The following DM_REMOTE section parameter does not apply to domain gateways of type
TDOMAIN but is included here for completeness:
CODEPAGE = string — applicable to domain gateways of type
SNAX and
OSITPX
A local service is a service made available to one or more remote domains through a local domain access point.
service [
optional_parameters]
where service is the identifier name of a particular local service; it must be 127 characters or fewer in length. This name is advertised by one or more servers running within the local Oracle Tuxedo application.
Specifies whether (Y) or not (
N) this local service is a conversational service. The default is
N.
The following DM_EXPORT section parameters do not apply to domain gateways of type
TDOMAIN but are included here for completeness.
|
•
|
INBUFTYPE = string — applicable to domain gateways of type SNAX, OSITP, and OSITPX
|
|
•
|
OUTBUFTYPE = string — applicable to domain gateways of type SNAX, OSITP, and OSITPX
|
|
•
|
COUPLING = { TIGHT | LOOSE} — applicable to domain gateways of type OSITPX
|
|
•
|
INRECTYPE = string — applicable to domain gateways of type OSITPX
|
|
•
|
OUTRECTYPE = string — applicable to domain gateways of type OSITPX
|
This section, also known as the DM_REMOTE_SERVICES section, provides information on services imported and available to the local domain through remote domain access points defined in the
DM_REMOTE section. If the
DM_IMPORT section is absent, or is present but empty, no remote services are available to the local domain.
A remote service is a service made available to the local domain through a remote domain access point and a local domain access point.
service [
optional_parameters]
where service is the identifier name advertised by the local Oracle Tuxedo application for a particular remote service; it must be 127 characters or fewer in length. A remote service may be imported from one or more remote domains.
RACCESSPOINT (also known as
RDOM)
= identifier1[
,identifier2][
,identifier3][
,identifier4]...[
,indentifier 10]
If you want to configure alternate remote domain access points with the identifier2,
identifier3, identifier4 arguments, you must specify
ON_STARTUP as the value of the
CONNECTION_POLICY parameter in the
DM_LOCAL section. (
CONNECTION_POLICY may also be specified in the
DM_TDOMAIN section for an Oracle Tuxedo 8.1 or later application.) If
identifier2 is configured, it is used for failover: When the remote domain associated with
identifier1 is unavailable, the remote domain associated with
identifier2 is used. Similarly, if
identifier3 ND identifier4 are configured, they are used for failover: When the remote domains associated with
identifier1,
identifier2 and
identifier3 are unavailable, the remote domain associated with
identifier4 is used.
numeric_value can be between 0 and 32,767 inclusive. If not specified, the default is 0 which indicates that the system-wide
BLOCKTIME value specified in the
UBBCONFIG RESOURCES section is used for the service.
Specifies whether (Y) or not (
N) this remote service is a conversational service. The default is
N.
The identifier is a
ROUTING_CRITERIA_NAME defined in the
DM_ROUTING section. The value of
identifier must be 127 characters or less in length. If multiple entries for the same service name are included with different remote domain access points (specified using the
RACCESSPOINT parameter), the value of the
ROUTING parameter should be the same for all of these entries.
The following DM_IMPORT section parameters do not apply to domain gateways of type
TDOMAIN but are included here for completeness:
|
•
|
INBUFTYPE = string — applicable to domain gateways of type SNAX, OSITP, and OSITPX
|
|
•
|
OUTBUFTYPE = string — applicable to domain gateways of type SNAX, OSITP, and OSITPX
|
|
•
|
AUTOPREPARE = { Y | N} — applicable to domain gateways of type OSITPX
|
|
•
|
INRECTYPE = string — applicable to domain gateways of type OSITPX
|
|
•
|
OUTRECTYPE = string — applicable to domain gateways of type OSITPX
|
|
•
|
TPSUT_TYPE = { INTEGER | PRINTABLESTRING} — applicable to domain gateways of type OSITPX
|
|
•
|
REM_TPSUT = string — applicable to domain gateways of type OSITPX
|
where string is a field in which users can enter a version number for the current
DMCONFIG file.
where ROUTING_CRITERIA_NAME is the
identifier name assigned to the
ROUTING parameter for the particular service entry in the
DM_IMPORT section.
ROUTING_CRITERIA_NAME must be 127 characters or less in length.
Specifies the name of the routing field. It must be 254 characters or less. It is assumed that the value of identifier is one of the following: a field name that is identified in an FML field table (for FML and FML32 buffers); an XML element or element attribute (for XML buffers); or an FML view table (for VIEW, X_C_TYPE, or X_COMMON buffers). Two environment variables,
FLDTBLDIR and
FIELDTBLS or FLDTBLDIR32 and
FIELDTBLS32, are used to locate FML field tables. Similarly, two environment variables,
VIEWDIR and
VIEWFILES or VIEWDIR32 and
VIEWFILES32, are used to locate FML view tables. If a field in an FML or FML32 buffer is used for routing, the value of that field must be a number less than or equal to 8191.
FIELD = “root_element[/
child_element][/
child_element][/. . .][/@
attribute_name]”
The value of FIELD specifies the name of a routing element or an element attribute. It is assumed that the value of
root_element is an element type (or name) or an element attribute name for an XML document or datagram. This information is used to identify the element content or element attribute value for data-dependent routing while sending a document or datagram. The element name and attribute name combined may contain no more than 30 characters. Because indexing is not supported, the Oracle Tuxedo system recognizes only the first occurrence of a given element type when processing an
XML buffer for data-dependent routing.
Indicates the type of routing field specified in the FIELD parameter. This parameter is used only for routing XML buffers. The value
type can be set to one of the following:
CHAR,
SHORT,
LONG,
FLOAT,
DOUBLE, or
STRING. The default type of the routing field is
STRING.
The value MIN can be used to indicate the minimum value for the data type of the associated
FIELD; for strings and carrays, it is the
NULL string; for character fields, it is 0; for numeric values, it is the minimum numeric value that can be stored in the field.
The value MAX can be used to indicate the maximum value for the data type of the associated
FIELD; for strings and carrays, it is effectively an unlimited string of octal-255 characters; for a character field, it is a single octal-255 character; for numeric values, it is the maximum numeric value that can be stored in the field. Thus, “
MIN - -5” is all numbers less than or equal to -5 and “
6 - MAX” is all numbers greater than or equal to 6. The meta-character
* (wildcard) in the position of a range indicates any values not covered by the other ranges previously seen in the entry; only one wildcard range is allowed per entry and it should be last (ranges following it will be ignored).
BUFTYPE = “type1[
:subtype1[,
subtype2 . . . ]][;
type2[:
subtype3[, . . . ]]] . . .
”
A list of types and subtypes of data buffers for which this routing entry is valid. The types are restricted to FML,
FML32,
VIEW,
VIEW32,
X_C_TYPE,
X_COMMON, or
XML. No subtype can be specified for type
FML,
FML32, or
XML; subtypes are required for types
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON (“
*” is not allowed). Duplicate type/subtype pairs cannot be specified for the same routing criteria name; more than one routing entry can have the same criteria name as long as the type/subtype pairs are unique. This parameter is required. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.
ACL_NAME required_parameters
where ACL_NAME is an identifier value used to specify an access control list; it may contain no more than 15 characters.
ACLIST = identifier[
,identifier]
where an ACLIST is composed of one or more remote domain access point names separated by commas. The wildcard character (
*) can be used to specify that all remote domain access points defined in the
DM_REMOTE section can access a particular local service exported through a particular local domain access point.
This section defines the network-specific information for TDomain gateways. The DM_TDOMAIN section should have an entry per local domain access point if requests from remote domains to local services are accepted through that local domain access point, and at least one entry per remote domain access point if requests from the local domain to remote services are accepted through that access point.
The DM_TDOMAIN section is used to configure the following network properties for an access point entry:
where AccessPoint is an identifier value used to identify either a local domain access point or a remote domain access point. The
AccessPoint identifier must match a previously defined local domain access point in the
DM_LOCAL section or a previously defined remote domain access point in the
DM_REMOTE section.
NWADDR = string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
If string has the form
“0xhex-digits” or
“\\xhex-digits”, it must contain an even number of valid hexadecimal digits. These forms are translated internally into a character array containing TCP/IP addresses. The value of
string may also be represented in either of the following forms as shown in
Table 11.
hostname is resolved to a TCP/IP host address at the time the address is bound using the locally configured name resolution facilities accessed via
gethostbyname(3c). The string
#.#.#.# is the dotted decimal format where each
# represents a decimal number in the range 0 to 255.
Port_number is a decimal number in the range 0 to 65535.
The NWDEVICE parameter is not required. In earlier releases, if the networking functionality is TLI-based, the network device name must be an absolute pathname.
A value of 0 means no encryption, while a value of
40,
56,
128,
or 256 specifies the encryption key length (in bits). The default is
0. If the minimum level of encryption cannot be met, link establishment fails.
A value of 0 means no encryption, while a value of
40,
56,
128 or
256 specifies the encryption key length (in bits). The default is
128.
If SSL_ONE_WAY is set, the domain that
accepts an SSL connection needs to authenticate itself to the domain that
initiates the connection using an SSL certificate. The initiating domain
does not need to authenticate itself to the other domain. This value is mainly intended for use with a
CONNECTION_POLICY to
INCOMING_ONLY, and should only be set when the domain that accepts incoming connections
does not need to authenticate connecting domains.
|
Note:
|
If NWPROTOCOL is not set or is set to LLE and SSL_RENEGOTIATION is set to a non-zero value, dmloadcf prints a warning message.
|
|
Note:
|
If NWPROTOCOL is not set or set to LLE and SSL_RENEGOTIATION is set to a non-zero value, dmloadcf prints a warning message.
|
CONNECTION_POLICY = {
LOCAL |
ON_DEMAND |
ON_STARTUP |
INCOMING_ONLY |
PERSISTENT_DISCONNECT}
The CONNECTION_POLICY parameter is available in the
DM_TDOMAIN section when running Oracle Tuxedo 8.1 or later software. Its value in the
DM_TDOMAIN section for a particular local or remote domain access point takes precedence over its global value in the
DM_LOCAL section. The ability to override the global connection policy enables you to configure connection policy on a per TDomain session basis.
Specifying no connection policy for a local domain access point defaults to the global connection policy specified in the
DM_LOCAL section. If you choose to specify a global connection policy in the
DM_TDOMAIN section, do not specify a global connection policy in the
DM_LOCAL section.
A connection policy of LOCAL means that a remote domain access point accepts the global connection policy defined in the
DM_LOCAL section.
LOCAL is the default connection policy for remote domain access points. Excluding
LOCAL, the connection policy value for a remote domain access point takes precedence over the connection policy value for a local domain access point.
A connection policy of ON_DEMAND means that the TDomain gateway attempts a connection only when requested by either a client request to a remote service or a
dmadmin(1) connect command. Connection retry processing is not allowed when the connection policy is
ON_DEMAND.
A connection policy of ON_STARTUP means that the TDomain gateway attempts to establish a connection at gateway server initialization time. For
ON_STARTUP, the remote services for a particular remote domain (that is, services advertised by the TDomain gateway) are advertised only if a connection is successfully established to the remote domain. Thus, if there is no active connection to the remote domain, the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds, but you can specify a different value for this interval using the
RETRY_INTERVAL parameter in the
DM_TDOMAIN section. Also, see the
MAXRETRY parameter in this section.
A connection policy of INCOMING_ONLY means that the TDomain gateway does not attempt an initial connection upon startup and that remote services are initially suspended. The TDomain gateway is available for incoming connections from a remote domain, and remote services are advertised when the gateway receives an incoming connection or an administrative connection (using the
dmadmin(1) connect command) is made. Connection retry processing is not allowed when the connection policy is
INCOMING_ONLY.
A connection policy of PERSISTENT_DISCONNECT means that the incoming connections from a remote domain are rejected. The local domain will not attempt to connect to the remote domain. Related remote service is suspended accordingly. The local domain is isolated until it is manually changed to another connection policy.
|
Note:
|
The PERSISTENT_DISCONNECT policy can only be used for a remote access point in the DM_TDOMAIN section.
|
Based on the CONNECTION_POLICY attribute you select, the local domain will try to connect to a TDomain session’s primary record. If the primary record fails to connect, it will then try to connect to the next sequential secondary/backup record. If all secondary record connections fail, it will retry the primary record information at a later time as determined by
RETRY_INTERVAL until
MAXRETRY is exhausted.
If not specified, LACCESSPOINT defaults to“*” and the TDomain session will connect to all local domain access points listed in the
DM_LOCAL section. You can substitute
LDOM for the
LACCESSPOINT parameter.
|
Note:
|
LACCESSPOINT can also use regular expression values to define multiple local domain access points. When the DMCONFIG file is compiled using dmloadcf, the regular expression values are expanded to their full local domain names in the BDMCONFIG file. LACCESSPOINT can only use regular expressions in the DMCONFIG file.
|
[MAXRETRY = {
numeric |
MAXLONG}
The minimum value for MAXRETRY is 0, and the maximum value is
MAXLONG (2147483647).
MAXLONG, the default, indicates that retry processing will be repeated indefinitely, or until a connection is established.
The minimum value for RETRY_INTERVAL is 0, and the maximum value is 2147483647. The default is 60. If
MAXRETRY is set to 0, setting
RETRY_INTERVAL is not allowed.
The TCPKEEPALIVE parameter applies only to domain gateways of type
TDOMAIN running Oracle Tuxedo 8.1 or later software. Its value for a remote domain access point takes precedence over its value for a local domain access point. The ability to override the local domain access point value enables you to configure TCP-level keepalive on a per remote domain basis.
A value of LOCAL means that a remote domain access point accepts the TCP-level keepalive value defined for the local domain access point.
LOCAL is the default TCP-level keepalive value for remote domain access points.
A value of NO means that TCP-level keepalive is disabled for this access point.
N is the default TCP-level keepalive value for local domain access points.
A value of YES means that TCP-level keepalive is enabled for this access point. When TCP-level keepalive is enabled for a connection, the keepalive interval used for the connection is the system-wide value configured for the operating system’s TCP keepalive timer. This interval is the maximum time that the TDomain gateway will wait without receiving any traffic on the connection. If the maximum time is exceeded, the gateway sends a TCP-level keepalive request message. If the connection is still open and the remote TDomain gateway is still alive, the remote gateway responds by sending an acknowledgement. If the local TDomain gateway does not receive an acknowledgement within a fixed period of time of sending the request message, it assumes that the connection is broken and releases any resources associated with the connection.
|
Note:
|
The TCPKEEPALIVE and DMKEEPALIVE parameters are not mutually exclusive, meaning that you can configure an interdomain connection using both parameters.
|
The DMKEEPALIVE parameter applies only to domain gateways of type
TDOMAIN running Oracle Tuxedo 8.1 or later software. Its value for a remote domain access point takes precedence over its value for a local domain access point. The ability to override the local domain access point value enables you to configure application-level keepalive on a per remote domain basis.
|
Note:
|
The DMKEEPALIVE and TCPKEEPALIVE parameters are not mutually exclusive, meaning that you can configure an interdomain connection using both parameters.
|
If DMKEEPALIVE is 0 (keepalive disabled) for this access point, setting
DMKEEPALIVEWAIT has no effect.
If DMKEEPALIVE is enabled for this access point and
DMKEEPALIVEWAIT is set to a value greater than
DMKEEPALIVE, the local TDomain gateway will send more than one application-level keepalive message before the
DMKEEPALIVEWAIT timer expires. This combination of settings is allowed.
If DMKEEPALIVE is enabled for this access point and
DMKEEPALIVEWAIT is set to 0, receiving an acknowledgement to a sent keepalive message is unimportant: any such acknowledgement is ignored by the TDomain gateway. The gateway continues to send keepalive messages every time the
DMKEEPALIVE timer times out.
Use this combination of settings to keep an idle connection open through a firewall.
If this DM_TDOMAIN entry is a local domain access point (as specified in the
DM_LOCAL section), its
NWADDR is a network address to be used to listen for incoming connections. Entries associated with a local domain access point can be specified more than once in the
DM_TDOMAIN section, to allow for migration of the services associated with a local access point to another machine in the Oracle Tuxedo domain.
Entries associated with a remote domain access point (as specified in the DM_REMOTE section) can also be specified more than once in the
DM_TDOMAIN section. If
FAILOVERSEQ is not specified, the first entry is considered to be the primary address, which means its
NWADDR is the first network address tried when a connection is being attempted to the remote domain access point. The second entry is considered to be the secondary address, which means its
NWADDR is the second network address tried when a connection cannot be established using the primary address.
|
Note:
|
If the FAILOVERSEQ parameter is used, it determines the primary and secondary addresses for TDomain session connection policies.
|
If this DM_TDOMAIN entry is another occurrence of a remote domain access point, the entry points to a secondary remote gateway that must reside in a different Oracle Tuxedo domain than the Oracle Tuxedo domain in which the primary remote gateway resides. The secondary and primary remote gateways must have the same
ACCESSPOINTID defined in the
DM_LOCAL section of their associated
DMCONFIG files; this arrangement is often referred to as a
mirrored gateway. This feature is not recommended for use with transactions or conversations. In addition, the mirrored gateway is not recommended for use when the primary remote gateway is available.
The BDMCONFIG environment variable is used to find the
BDMCONFIG configuration file.
The last of these representations is hexadecimal format. The 0002 is the first part of a TCP/IP address. The
091E is the port number
2334 translated into a hexadecimal number. After that each element of the IP address
155.2.193.12 is translated into a hexadecimal number. Thus the
155 becomes
9B,
2 becomes
02 and so on.
DM_MIB—Management Information Base for Domains
This DMCONFIG section name. . .
|
|
|
|
|
|
|
|
The equivalent DM_MIB classes for these
DMCONFIG sections are
T_DM_LOCAL and
T_DM_REMOTE, respectively.
This DMCONFIG section name. . .
|
|
|
|
|
|
|
|
The equivalent DM_MIB classes for these
DMCONFIG sections are
T_DM_EXPORT and
T_DM_IMPORT, respectively.
For backwards compatibility, aliases are provided between the DMCONFIG terminology used prior to Oracle Tuxedo 7.1 and the improved Domains MIB terminology. For Oracle Tuxedo release 7.1 or later,
dmloadcf accepts both versions of the
DMCONFIG terminology.
dmunloadcf, however, generates a
DMCONFIG file that uses the improved domains terminology by default. Use the
-c option of
dmunloadcf to generate a
DMCONFIG file that uses the previous domains terminology.
Use DM_MIB(5) in combination with the generic MIB reference page
MIB(5) to format administrative requests and interpret administrative replies.
DM_MIB(5) consists of the following classes:
MIB(5) defines the generic
TA_FLAGS attribute which is a long-valued field containing both generic and component MIB-specific flag values. At this time, there are no
DM_MIB-specific flag values defined.
The field tables for the attributes described in this reference page are found in the file udataobj/tpadm relative to the root directory of the Oracle Tuxedo System software installed on the system. The directory
${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the
FLDTBLDIR environment variable. The field table name
tpadm should be included in the comma-separated list specified by the
FIELDTBLS environment variable.
The T_DM_ACL class represents access control information for domains.
The list of remote domain access points associated with this access control list. TA_DMRACCESSPOINTLIST is a comma-separated list of remote domain access point names (that is, the value of the
TA_DMRACCESSPOINT attribute of a valid
T_DM_REMOTE object). The list can contain up to 50 remote domain access point identifier elements. Setting this attribute to
“*” means that all the remote domains in the configuration are associated with this entry.
“” means no remote domain access points are associated with this entry. The default is
“”.
A GET operation retrieves configuration information for the
T_DM_ACL object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_ACL object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
The T_DM_CONNECTION class represents the status of connections between domain access points.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | SUS | INI | INA | UNK} ”
|
|
|
|
|
|
|
|
“{ 0 | 40 | 56 | 128} ”Note1
|
|
|
|
On GET and
SET operations, a specific local domain access point must be specified for this attribute.
On GET and
SET operations, if
TA_DMRACCESSPOINT is absent, all the
T_DM_CONNECTION entries for the local access point specified by
TA_DMLACCESSPOINT are selected.
GET: “{
ACTive |
SUSpended |
INItializing |
INActive |
UNKnown}
”
A GET operation retrieves run-time information for the connection. The following states indicate the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates run-time information for the connection. The following states indicate the meaning of a
TA_STATE in a
SET request. States not listed may not be set.
The level of encryption in use on this connection. “0” means no encryption, while
“40”,
“56”, and
“128” specify the encryption length (in bits). This attribute is valid only for gateways running Oracle Tuxedo release 7.1 or higher. For all other gateways, this value is set to
“0”.
The Domain gateway administration (GWADM) server and the domain gateway supporting the local domain access point specified in the
TA_DMLACCESSPOINT attribute must be active in order to perform
GET or
SET operations on connections to that access point.
The T_DM_EXPORT class represents local resources that are exported to one or more remote domains through a local access point.
The local resource name for entries of resource type SERVICE (the service name),
QSPACE (the queue space name), and
QNAME (the queue name). For a
SERVICE entry, the value of this attribute corresponds to the value of the
TA_SERVICENAME attribute of an active
T_SVCGRP object. This resource is exported to remote domains with the same name or with the alias defined in the
TA_DMREMOTENAME or
TA_DMTE* attributes.
A GET operation retrieves configuration information for the
T_DM_EXPORT object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_EXPORT object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
The name of a T_DM_ACL object to use for security for this local resource. This attribute is not permitted if
TA_DMRESOURCETYPE=“QNAME”.
type[:
subtype]—Specifies the input buffer type, optionally followed by the subtype, for this local resource. If this attribute is present, it defines the buffer type [and subtype] accepted. This attribute should be defined for entries of
TA_DMRESOURCETYPE=“SERVICE” when using
SNAX, or when access is permitted from remote domain access points using
OSITP or
OSITPX with the UDT application context.
type[:
subtype]
— Specifies the output buffer type, optionally followed by subtype, for this local resource. If this attribute is present, it defines the buffer type [and subtype] output by the service. This attribute should be defined for entries of
TA_DMRESOURCETYPE=“SERVICE” when using
SNAX, or when access is permitted from remote domain access points using
OSITP or
OSITPX with the UDT application context.
TA_DMCOUPLING=“TIGHT” applies only when duplicate service requests come through the same remote domain access point. When the service requests are through different remote domain access points, the requests are always loosely coupled.
type[:
subtype]—Specifies the type, optionally followed by subtype, and in some case the format of the reply buffer that a particular client requires for this local service. This attribute can be omitted if the local service sends a buffer that is identical in type and structure to the buffer that the remote client expects. If you do not specify
TA_DMINRECTYPE, the type of buffer is unchanged.
type[:
subtype]—Specifies the type, optionally followed by subtype, of the buffer sent by the remote client for this local service. This attribute is used to enforce stronger type checking.
On SET operations that add or update an instance of this class, and where a specific local domain access point is specified in the
TA_DMLACCESSPOINT attribute, the access point must exist in the
T_DM_LOCAL class. If it does not, a “not defined” error is returned for the
TA_DMLACCESSPOINT attribute, and the operation fails.
The T_DM_IMPORT class represents remote resources that are imported through one or more remote domain access points and made available to the local domain through one or more local domain access points.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ SERVICE | QSPACE | QNAME} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ INTEGER | PRINTABLESTRING} ”
|
|
|
|
|
|
|
|
|
|
A GET operation retrieves configuration information for the
T_DM_IMPORT object. The following states indicate the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates the configuration information for the selected
T_DM_IMPORT object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
A boolean value (“Y” or
“N”) specifying whether this remote resource is conversational.
The name of a T_DM_ROUTING object to use for routing criteria for this remote resource (
“SERVICE” or
“QSPACE”).
type[:
subtype]—Specifies the input buffer type, optionally followed by subtype, for this remote resource. If this attribute is present, it defines the buffer type [and subtype] accepted. This attribute should be defined for entries of
DMRESOURCETYPE=“SERVICE” when using
SNAX, or when access is permitted to remote domain access points using
OSITP or
OSITPX with the UDT application context.
type[:
subtype]—Specifies the output buffer type, optionally followed by subtype, for this remote resource. If this attribute is present, it defines the buffer type [and subtype] output by the service. This attribute should be defined for entries of
DMTYPE=“SERVICE” when using
SNAX, or when access is permitted to remote domain access points using
OSITP or
OSITPX with the UDT application context.
Allows a single tpcall() involved in a global transaction to this remote service to automatically prepare the call. This optimization reduces the two-phase commit process to a single step. The remote OSITP domain must support this feature. The default is
“N”.
type[:
subtype]—Specifies the type, optionally followed by subtype, and in some case the format of the request buffer that this remote service requires. This attribute can be omitted if the local client sends a buffer that is identical in type and structure to the buffer that this remote service expects. If you do not specify
TA_DMINRECTYPE, the type of buffer is unchanged.
type[:
subtype]—Specifies the type, optionally followed by subtype, of the buffer sent by this remote service. This attribute is used to enforce stronger type checking.
The T_DM_LOCAL class defines a local domain access point. A local domain access point is used to control access to local services exported to remote domains and to control access to remote services imported from remote domains.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ TDOMAIN | SNAX | OSITP | OSITPX} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TA_BLOCKTIME in T_DOMAIN Note 1
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TA_MAXGTT in T_DOMAIN Note 2
|
|
|
|
|
“{ NONE | APP_PW | DM_PW | DM_USER_PW | CLEAR | SAFE | PRIVATE} ”
|
|
|
|
|
|
|
|
“{ ON_DEMAND | ON_STARTUP | INCOMING_ONLY | PERSISTENT_DISCONNECT} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The name of this T_DM_LOCAL entry—a user-specified local domain access point identifier (logical name) unique within the scope of the
T_DM_LOCAL and
T_DM_REMOTE access point names in this Domains configuration.
TA_DMTYPE:
“{
TDOMAIN |
SNAX |
OSITP |
OSITPX}
”
The type of domain for this local domain access point: “TDOMAIN” for an Oracle Tuxedo domain,
“SNAX” for an SNA domain,
“OSITP” for an OSI TP 1.3 domain, or
“OSITPX” for an OSI TP 4.0 or later domain. The presence or absence of other attributes depends on the value of this attribute.
Setting TA_DMTYPE=“OSITPX” is supported only by Oracle Tuxedo 8.0 or later software.
A GET operation retrieves configuration information for the
T_DM_LOCAL object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_LOCAL object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
TA_DMAUDITLOG:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Be aware that interdomain transactions generate blocking timeout conditions when transaction duration exceeds the value of the
TA_DMBLOCKTIME attribute. That is, for an interdomain transaction, if the value of the
TA_DMBLOCKTIME attribute is less than (a) the value of the
TA_TRANTIME attribute specified for the
T_SERVICE object or (b) the timeout value passed in the
tpbegin() call to start the transaction, the timeout for the transaction is reduced to the
TA_DMBLOCKTIME value. In contrast, for
intradomain transactions (that is, transactions handled within a single Oracle Tuxedo domain), the value of the
TA_BLOCKTIME attribute specified for the
T_DOMAIN object has
no effect on the timeout value of an intradomain transaction.
TA_DMTLOGDEV:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
The TLOG name for this local domain access point. If more than one
TLOG exists on the same device, each
TLOG must have a unique name.
The size in pages of the TLOG for this local domain access point. This size is constrained by the amount of space available on the device identified in
TA_DMTLOGDEV.
Valid only when TA_DMTYPE=“TDOMAIN”. Application password-based security is enabled.
Valid only when TA_DMTYPE=“TDOMAIN” or
“OSITPX”. Domain password-based security is enabled.
Valid only when TA_DMTYPE=“SNAX”. Translation of principal names is enabled.
The TA_DMMAXRETRY attribute is valid only when the connection policy is
“ON_STARTUP”.
The TA_DMCONNPRINCIPALNAME attribute may contain a maximum of 511 characters (excluding the terminating
NULL character). If this attribute is not specified, the connection principal name defaults to the
TA_DMACCESSPOINTID string for this local domain access point.
For default authentication plug-ins, if a value is assigned to the TA_DMCONNPRINCIPALNAME attribute for this local domain access point, it must be the same as the value assigned to the
TA_DMACCESSPOINTID attribute for this local domain access point. If these values do not match, the local domain gateway process will
not boot, and the system will generate the following
userlog(3c) message:
ERROR: Unable to acquire credentials.
If TA_DMMACHINETYPE is not specified, the default is to turn encoding/decoding on. If the value set for the
TA_DMMACHINETYPE attribute is the same in both the
T_DM_LOCAL and
T_DM_REMOTE classes for a connection, data encoding/decoding is bypassed. The value set for
TA_DMMACHINETYPE can be any string value up to 15 characters in length. It is used only for comparison.
When the Domain gateway administration (GWADM) server supporting the local domain access point specified in the
TA_DMLACCESSPOINT attribute is active, you cannot
SET the
TA_STATE to
INValid or update the following attributes:
TA_DMACCESSPOINTID,
TA_DMSRVGROUP,
TA_DMTYPE,
TA_DMTLOGDEV,
TA_DMTLOGNAME,
TA_DMTLOGSIZE,
TA_DMMAXRAPTRAN,
TA_DMMAXTRAN, or
TA_DMMACHINETYPE.
The T_DM_OSITP class defines the OSI TP 1.3 protocol related configuration information for a specific local or remote domain access point.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ CAE | PRELIMINARY | OLTP_TM2200} ”
|
|
|
|
A GET operation retrieves configuration information for the
T_DM_OSITP object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_OSITP object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
On SET operations that add or update an instance of this class, the specific local or remote domain access point specified in the
TA_DMACCESSPOINT attribute must exist in the
T_DM_LOCAL class or the
T_DM_REMOTE class. If the domain access point does not exist, a “not defined” error is returned for the
TA_DMACCESSPOINT attribute, and the operation fails.
The T_DM_OSITPX class defines the OSI TP 4.0 or later protocol related configuration information for a specific local or remote domain access point. The
T_DM_OSITPX class is supported only by Oracle Tuxedo 8.0 or later software.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ CAE | PRELIMINARY | OLTP_TM2200 | NATIVE_A_SERIES} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A GET operation retrieves configuration information for the
T_DM_OSITPX object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_OSITPX object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
|
|
A new T_DM_OSITPX object is created. This state change is allowed in the state “INValid” and results in the state “VALid”.
|
|
|
Modify an existing T_DM_OSITPX object. This combination is not allowed in the “INValid” state. A successful return leaves the object state unchanged.
|
|
|
The T_DM_OSITPX object is deleted. This state change is allowed in the state “VALid” and results in the state “INValid”.
|
“#.#.#.#:port_number” IP Address
“//hostname:port_number” DNS Name
“//hostname:port_number;//hostname:port_number; ...”
Specifies when the DNS name for the network address defined by the TA_DMNWADDR attribute should be resolved for the domain gateway (
GWOSITP) associated with this local domain access point. If this attribute is set (or defaulted) to
“STARTUP”, the resolution of hostname to an actual IP address takes place at gateway startup. If this attribute is set to
“RUNTIME”, the resolution of hostname to an actual IP address takes place at gateway run time.
Specifies the version of the XATMI protocol used to communicate with a remote system. This attribute is valid only when describing a remote domain access point. Valid values are:
“NATIVE_A_SERIES” (used with Unisys MCP OLTP systems that support
this encoding type)
On SET operations that add or update an instance of this class, the specific local or remote domain access point specified in the
TA_DMACCESSPOINT attribute must exist in the
T_DM_LOCAL class or the
T_DM_REMOTE class. If the domain access point does not exist, a “not defined” error is returned for the
TA_DMACCESSPOINT attribute, and the operation fails.
The T_DM_PASSWORD class represents configuration information for interdomain authentication through access points of type
TDOMAIN.
A GET operation retrieves configuration information for the selected
T_DM_PASSWORD object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
SET:
“{
NEW |
INValid |
RECrypt}
”
A SET operation updates configuration information for the selected
T_DM_PASSWORD object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
The T_DM_PRINCIPAL_MAP class represents configuration information for mapping principal names to and from external principal names across access points of type
SNAX.
A GET operation retrieves configuration information for the selected
T_DM_PRINCIPAL entry. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_PRINCIPAL entry. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
The T_DM_REMOTE class represents remote domain access point configuration information. Local resources that may be exported through one or more local domain access points are made accessible to a remote domain through a remote domain access point. Similarly, remote resources are imported from a remote domain through a remote domain access point.
The name of this T_DM_REMOTE entry—a user-specified remote domain access point identifier (logical name) unique within the scope of the
T_DM_LOCAL and
T_DM_REMOTE access point names in this Domains configuration.
TA_DMTYPE:
“{
TDOMAIN |
SNAX |
OSITP |
OSITPX}
”
The type of domain for this remote domain access point: “TDOMAIN” for an Oracle Tuxedo domain,
“SNAX” for an SNA domain,
“OSITP” for an OSI TP 1.3 domain, or
“OSITPX” for an OSI TP 4.0 or later domain. The presence or absence of other attributes depends on the value of this attribute.
Setting TA_DMTYPE=“OSITPX” is supported only by Oracle Tuxedo 8.0 or later software.
A GET operation retrieves configuration information for the
T_DM_REMOTE object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_REMOTE object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
Together, the TA_DMPRIORITY_TYPE and
TA_DMINPRIORITY attributes specify the message priority handling for this remote domain access point. These attributes are supported by Oracle Tuxedo 8.0 or later software.
For the TA_DMPRIORITY_TYPE attribute, the
“LOCAL_RELATIVE” and
“LOCAL_ABSOLUTE” values are valid for all remote domain types; the
“GLOBAL” value is valid only for remote domains of type
TDOMAIN. If not set, the
TA_DMPRIORITY_TYPE attribute defaults to
“LOCAL_RELATIVE”.
TA_DMPRIORITY_TYPE=“LOCAL_RELATIVE” means that the priority associated with a request from this remote domain access point (for example, via the
tpsprio call) is not used by the local domain. Instead, the priority of incoming requests from this remote domain access point is set relative to the
TA_DMINPRIORITY value; this value may be greater than or equal to -99 (lowest priority) and less than or equal to 99 (highest priority), with 0 being the default. The setting of
TA_DMINPRIORITY increments or decrements a service’s default priority as follows: up to a maximum of 100 or down to a minimum of 1, depending on its sign, where 100 is the highest priority. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
TA_DMPRIORITY_TYPE=“LOCAL_ABSOLUTE” means that the priority associated with a request from this remote domain access point is not used by the local domain. Instead, the priority of incoming requests from this remote domain access point is set relative to the
TA_DMINPRIORITY value; this value may be greater than or equal to 1 (lowest priority) and less than or equal to 100 (highest priority), with 50 being the default. The setting of
TA_DMINPRIORITY increments or decrements a service’s default priority as follows: up to a maximum of 100 or down to a minimum of 1, depending on its sign, where 100 is the highest priority. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
TA_DMPRIORITY_TYPE=“GLOBAL” means that the priority associated with a request from this remote domain access point is adjusted by the local domain. The priority of incoming requests from this remote domain access point is adjusted relative to the
TA_DMINPRIORITY value; this value may be greater than or equal to -99 (lowest priority) and less than or equal to 99 (highest priority), with 0 being the default. If
TA_DMINPRIORITY is set, the priority accompanying the incoming request is added to the
TA_DMINPRIORITY value to create an absolute priority setting for the incoming request. If
TA_DMINPRIORITY is not set or is set to 0, the priority accompanying the incoming request is used
as is by the local domain. For requests to the remote domain access point, the priority associated with a request will accompany the request to the remote domain access point.
LOCAL means that the local domain
replaces the credential (identity) of any service request received from the remote domain
with the principal name specified in the
TA_DMLOCALPRINCIPALNAME attribute for this remote domain access point.
GLOBAL means that the local domain does not replace the credential received with a remote service request; if no credential is received with a remote service request, the local domain forwards the service request to the local service
as is (which usually fails). If this attribute is not specified, the default is
LOCAL.
Note that the TA_DMACLPOLICY attribute controls whether or not the local domain replaces the credential of a service request received from a remote domain with the principal name specified in the
TA_DMLOCALPRINCIPALNAME attribute. The
TA_DMCREDENTIALPOLICY attribute is related to this attribute and controls whether or not the local domain removes the credential from a local service request before sending the request to a remote domain.
The TA_DMLOCALPRINCIPALNAME attribute may contain a maximum of 511 characters (excluding the terminating
NULL character). If this attribute is not specified, the local principal name defaults to the
TA_DMACCESSPOINTID string for this remote domain access point.
The TA_DMCONNPRINCIPALNAME attribute may contain a maximum of 511 characters (excluding the terminating
NULL character). If this attribute is not specified, the connection principal name defaults to the
TA_DMACCESSPOINTID string for this remote domain access point.
For default authentication plug-ins, if a value is assigned to the TA_DMCONNPRINCIPALNAME attribute for this remote domain access point, it must be the same as the value assigned to the
TA_DMACCESSPOINTID attribute for this remote domain access point. If these values do not match, any attempt to set up a connection between the local domain gateway and the remote domain gateway will fail, and the system will generate the following
userlog(3c) message:
ERROR: Unable to initialize administration key for domain domain_name.
LOCAL means that the local domain removes the credential (identity) from a local service request destined for this remote domain access point.
GLOBAL means that the local domain does not remove the credential from a local service request destined for this remote domain access point. If this attribute is not specified, the default is
LOCAL.
Note that the TA_DMCREDENTIALPOLICY attribute controls whether or not the local domain removes the credential from a local service request before sending the request to a remote domain. The
TA_DMACLPOLICY attribute controls whether or not the local domain replaces the credential of a service request received from a remote domain with the principal name specified in the
TA_DMLOCALPRINCIPALNAME attribute.
When any gateway administrative server (GWADM)
supporting a local domain access point of the same domain type as this request is active, you cannot
SET the
TA_STATE to
INValid or update the following attributes:
TA_DMACCESSPOINTID,
TA_DMTYPE,
TA_DMMACHINETYPE, or
TA_DMCODEPAGE.
You cannot delete an instance of the T_DM_REMOTE class if it is referenced by any instances of the following classes:
T_DM_ACL,
T_DM_IMPORT,
T_DM_OSITP,
T_DM_OSITPX,
T_DM_ROUTING, or
T_DM_TDOMAIN.
The T_DM_RESOURCES class represents Domains-specific configuration information.
The T_DM_ROUTING class represents routing criteria information for routing requests to a domain through a remote domain access point.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ CHAR | SHORT | LONG | FLOAT | DOUBLE | STRING} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“type1[:
subtype1[,
subtype2 . . . ]][;
type2[:
subtype3[,
subtype4 . . . ]] . . . ]
”
List of types and subtypes of data buffers for which this routing entry is valid. A maximum of 32 type/subtype combinations is allowed. The types are restricted to the following: FML,
FML32,
XML,
VIEW,
VIEW32,
X_C_TYPE, or
X_COMMON. No subtype can be specified for type
FML,
FML32, or
XML; subtypes are required for types
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON (“*” is not allowed). Note that subtype names should not contain semicolon, colon, comma, or asterisk characters. Duplicate type/subtype pairs cannot be specified for the same routing criterion name; more than one routing entry can have the same criterion name as long as the type/subtype pairs are unique. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.
For FML (and
FML32) buffer types,
TA_DMFIELD contains an FML field name that must be defined in an FML field table. When routing is performed, the field name is retrieved using the
FLDTBLDIR and
FIELDTBLS (
FLDTBLDIR32 and
FIELDTBLS32 for FML32) environment variables.
For VIEW (and
VIEW32) buffer types,
TA_DMFIELD contains a VIEW field name that must be defined in an FML VIEW table. When routing is performed, the field name is retrieved using the
VIEWDIR and
VIEWFILES (
VIEWDIR32 and
VIEWFILES32 for VIEW32) environment variables.
For an XML buffer type,
TA_DMFIELD contains either a routing element type (or name) or a routing element attribute name.
“root_element[/
child_element][/
child_element]
[/. . .][/@
attribute_name]
”
The type of the routing field specified in the TA_DMFIELD attribute. The type can be
CHAR,
SHORT,
LONG,
FLOAT,
DOUBLE, or
STRING; only one type is allowed. This attribute is required if
TA_DMBUFTYPE is
XML; it must be absent if
TA_DMBUFTYPE is
FML,
VIEW,
X_C_TYPE, or
X_COMMON.
“lower[-
upper]:
raccesspoint”
lower and
upper are signed numeric values or character strings in single quotes.
lower must be less than or equal to
upper. To embed a single quote in a character string value, it must be preceded by two backslashes (for example,
'O\\'Brien'). The value
MIN can be used to indicate the minimum value for the data type of the associated field on the machine. The value
MAX can be used to indicate the maximum value for the data type of the associated field on the machine. Thus,
“MIN--5” is all numbers less than or equal to -5, and
“6-MAX” is all numbers greater than or equal to 6.
The meta-character “*
” (wildcard) in the position of a range indicates any values not covered by the other ranges previously seen in the entry. Only one wildcard range is allowed per entry and it should be last (ranges following it are ignored).
The raccesspoint parameter indicates the remote domain access point to which the request is routed if the field matches the range. A
raccesspoint of
“*” indicates that the request can go to any remote domain access point that imports the desired service.
A GET operation retrieves configuration information for the
T_DM_ROUTING object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_ROUTING object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
The T_DM_RPRINCIPAL class represents password configuration information for remote principal names.
|
Note:
|
The combination of TA_DMRACCESSPOINT and TA_DMRPRINNAME must be unique within the scope of TA_DM_RPRINCIPAL entries in the Domains configuration.
|
|
Note:
|
The combination of TA_DMRACCESSPOINT and TA_DMRPRINNAME must be unique within the scope of TA_DM_RPRINCIPAL entries in the Domains configuration.
|
A GET operation retrieves configuration information for the
T_DM_RPRINCIPAL object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_RPRINCIPAL object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
The T_DM_SNACRM class defines the SNA-CRM-specific configuration for the named local domain access point.
The name of this T_DM_SNACRM entry.
TA_DMSNACRM is an identifier unique within the scope of the SNA CRM entries within the Domains configuration used to identify this SNA CRM entry.
A GET operation retrieves configuration information for the
T_DM_SNACRM object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_SNACRM object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
On SET operations that add or update an instance of this class, the local domain access point specified in the
TA_DMLACCESSPOINT must exist in the
T_DM_LOCAL class. If the access point does not exist, a “not defined” error is returned for the
TA_DMLACCESSPOINT attribute, and the operation fails.
The T_DM_SNALINK class represents SNAX-specific configuration information for a remote domain access point.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ LOCAL | IDENTIFY | VERIFY | PERSISTENT | MIXIDPE} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The name of the T_DM_SNALINK entry. An identifier, unique within the scope of the SNA LINK entries within the Domains configuration, used to identify this
TA_DMSNALINK entry.
A GET operation retrieves configuration information for the
T_DM_SNALINK object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_SNALINK object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
TA_DMSECTYPE:
“{
LOCAL |
IDENTIFY |
VERIFY |
PERSISTENT |
MIXIDPE}
”
Deleting or updating an instance of the T_DM_SNALINK class that refers to a
T_DM_SNASTACK class instance is not permitted under the following condition: the
T_DM_SNASTACK class instance refers to a
T_DM_SNACRM class instance that references a local domain access point for which the Domain gateway administration (
GWADM) server is active.
On SET operations that add or update an instance of this class:
|
•
|
The remote domain access point specified in the TA_DMRACCESSPOINT attribute must exist in the T_DM_REMOTE class. If the access point does not exist, a "not defined" error is returned for the TA_DMRACCESSPOINT attribute, and the operation fails.
|
|
•
|
The SNA stack reference name specified in the TA_DMSNASTACK attribute must exist in the T_DM_SNASTACK class. If the reference name does not exist, a “not defined” error is returned for the TA_DMSNASTACK attribute, and the operation fails.
|
The T_DM_SNASTACK class defines an SNA stack to be used by a specific SNA CRM.
The name of this T_DM_SNASTACK entry.
TA_DMSNASTACK is an identifier unique within the scope of
T_DM_SNASTACK entry names in the Domains configuration.
Identifies the T_DM_SNACRM entry of the SNA CRM in which this SNA protocol stack definition is used.
A GET operation retrieves configuration information for the
T_DM_SNASTACK object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_SNASTACK object. The following states indicate the meaning of
TA_STATE in a
SET request. States not listed may not be set.
On SET operations that add or update an instance of this class, the SNA CRM name specified in the
TA_DMSNACRM attribute must exist in the
T_DM_SNACRM class. If the name does not exist, a “not defined” error is returned for the
TA_DMSNACRM attribute, and the operation fails.
The T_DM_TDOMAIN class defines the TDomain specific configuration for a local or remote domain access point.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ 0 | 40 | 56 | 128|256} ” Note 2
|
|
|
|
|
|
“{ 0 | 40 | 56 | 128|256} ” Note 2
|
|
|
|
|
|
“{ LOCAL | ON_DEMAND | ON_STARTUP | INCOMING_ONLY | PERSISTENT_DISCONNECT} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TA_DMNWADDR:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
A GET operation retrieves configuration information for the
T_DM_TDOMAIN object. The following state indicates the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates configuration information for the selected
T_DM_TDOMAIN object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
Note:
|
For "INValid" requests to remove a DM_TDOMAIN entry:
|
After this MIB request, a high priority "dco" request is immediately sent to GWTDOMAIN of the related local domain. The connection is dropped immediately after GWTDOMAIN schedules the
"dco" request. All ongoing service requests fail.
The TA_DMCONNECTION_POLICY attribute is available in the
T_DM_TDOMAIN class when running Oracle Tuxedo 8.1 or later software. Its value in the
T_DM_TDOMAIN class for a particular local or remote domain access point takes precedence over its global value in the
T_DM_LOCAL class. The ability to override the global connection policy enables you to configure connection policy on a per remote domain basis.
Specifying no connection policy for a local domain access point defaults to the global connection policy specified in the
T_DM_LOCAL class. If you choose to specify a global connection policy in the
T_DM_TDOMAIN class, do not specify a global connection policy in the
T_DM_LOCAL class.
A connection policy of “LOCAL” means that a remote domain access point accepts the global connection policy specified in the
T_DM_LOCAL class.
“LOCAL” is the default connection policy for remote domain access points. Excluding
“LOCAL”, the connection policy value for a remote domain access point takes precedence over the connection policy value for a local domain access point.
A connection policy of “ON_DEMAND” means that the TDomain gateway attempts a connection only when requested by either a client request to a remote service or a
dmadmin(1) connect command. Connection retry processing is not allowed when the connection policy is
“ON_DEMAND”.
A connection policy of “ON_STARTUP” means that the TDomain gateway attempts to establish a connection at gateway server initialization time. For
“ON_STARTUP”, the remote services for a particular remote domain (that is, services advertised by the TDomain gateway) are advertised only if a connection is successfully established to the remote domain. Thus, if there is no active connection to the remote domain, the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds, but you can specify a different value for this interval using the
TA_DMRETRY_INTERVAL attribute in the
T_DM_TDOMAIN class. Also, see the
TA_DMMAXRETRY attribute in this class.
A connection policy of “INCOMING_ONLY” means that the TDomain gateway does not attempt an initial connection upon startup and that remote services are initially suspended. The TDomain gateway is available for incoming connections from a remote domain, and remote services are advertised when the gateway receives an incoming connection or an administrative connection (using the
dmadmin(1) connect command) is made. Connection retry processing is not allowed when the connection policy is
“INCOMING_ONLY”.
A connection policy of “PERSISTENT_DISCONNECT” means that the incoming connections from the remote domain is rejected and the local domain will not attempt to connect to the remote domain. Related remote service is suspended accordingly. The local domain is isolated until it is manually changed to another connection policy. Remote services are available until manually changed to another connection policy and administrative connection (using the
dmadmin(1) connect command) is made.
The record with the lowest FAILOVERSEQ value is the primary record for that TDomain session. There is only one primary record for a TDomain session, all remaining records for the same TDomain session are called secondary/backup records. With the exceptions of
NWADDR,
NWDEVICE, and
FAILOVERSEQ, the primary record is the source for all TDomain session configuration parameters and attributes. All other parameters and attributes listed in secondary/backup records are ignored.
Based on the CONNECTION_POLICY attribute you select, the local domain will try to connect to a TDomain session’s primary record. If the primary record has a failover, it will then try to connect to the next sequential secondary/backup record. If all secondary record connections fail, it will retry the primary record information at a later time as determined by
RETRY_INTERVAL until
MAXRETRY is exhausted.
If a DM_MIB SET request does not specify a
TA_DMLACCESSPOINT value or a
DM_MIB SET TA_DMLACCESSPOINT request is from Tuxedo releases prior to 9.0, the output TDomain session record in the
BDMCOMFIG file uses the default
LACCESPOINT =”*”.
|
Note:
|
DM_MIB does not allow regular expression use with TA_DMLACCESSPOINT.
|
The minimum value for TA_DMMAXRETRY is 0, and the maximum value is
MAXLONG (2147483647).
MAXLONG, the default, indicates that retry processing will be repeated indefinitely, or until a connection is established.
The minimum value for TA_DMRETRY_INTERVAL is 0, and the maximum value is
MAXLONG (2147483647). The default is 60. If
TA_DMMAXRETRY is set to 0, setting
TA_DMRETRY_INTERVAL is not allowed.
If SSL_ONE_WAY is set, the domain that
accepts an SSL connection needs to authenticate itself to the domain that
initiates the connection using an SSL certificate. The initiating domain
does not need to authenticate itself to the other domain. This value is mainly intended for use with a
CONNECTION_POLICY to
INCOMING_ONLY, and should only be set when the domain that accepts incoming connections
does not need to authenticate connecting domains.
|
Note:
|
If TA_DMNW_PROTOCOL is not set or set to LLE and TA_DMSSL_RENEGOTIATION is set to a non-zero value, the MIB call prints a warning message; however, the requested values are still set. The MIB operation then returns TAUPDATED or TAOK (unless some other error occurs).
|
|
Note:
|
If TA_DMNW_PROTOCOL is not set or set to LLE and TA_DMSSL_RENEGOTIATION is set to a non-zero value, the MIB call prints a warning message; however, the requested values are still set. The MIB operation then returns TAUPDATED or TAOK (unless some other error occurs).
|
The TA_DMTCPKEEPALIVE attribute applies only to domain gateways of type
TDOMAIN running Oracle Tuxedo 8.1 or later software. Its value for a remote domain access point takes precedence over its value for a local domain access point. The ability to override the local domain access point value enables you to configure TCP-level keepalive on a per remote domain basis.
A value of “LOCAL” means that a remote domain access point accepts the TCP-level keepalive value defined for the local domain access point.
“LOCAL” is the default TCP-level keepalive value for remote domain access points.
A value of “NO” means that TCP-level keepalive is disabled for this access point.
“NO” is the default TCP-level keepalive value for local domain access points.
A value of “YES” means that TCP-level keepalive is enabled for this access point. When TCP-level keepalive is enabled for a connection, the keepalive interval used for the connection is the system-wide value configured for the operating system’s TCP keepalive timer. This interval is the maximum time that the TDomain gateway will wait without receiving any traffic on the connection. If the maximum time is exceeded, the gateway sends a TCP-level keepalive request message. If the connection is still open and the remote TDomain gateway is still alive, the remote gateway responds by sending an acknowledgement. If the local TDomain gateway does not receive an acknowledgement within a fixed period of time of sending the request message, it assumes that the connection is broken and releases any resources associated with the connection.
|
Note:
|
The TA_DMTCPKEEPALIVE and TA_DMKEEPALIVE attributes are not mutually exclusive, meaning that you can configure an interdomain connection using both attributes.
|
The TA_DMKEEPALIVE attribute applies only to domain gateways of type
TDOMAIN running Oracle Tuxedo 8.1 or later software. Its value for a remote domain access point takes precedence over its value for a local domain access point. The ability to override the local domain access point value enables you to configure application-level keepalive on a per remote domain basis.
|
Note:
|
The TA_DMKEEPALIVE and TA_DMTCPKEEPALIVE attributes are not mutually exclusive, meaning that you can configure an interdomain connection using both attributes.
|
If TA_DMKEEPALIVE is 0 (keepalive disabled) for this access point, setting
TA_DMKEEPALIVEWAIT has no effect.
If TA_DMKEEPALIVE is enabled for this access point and
TA_DMKEEPALIVEWAIT is set to a value greater than
TA_DMKEEPALIVE, the local TDomain gateway will send more than one application-level keepalive message before the
TA_DMKEEPALIVEWAIT timer expires. This combination of settings is allowed.
If TA_DMKEEPALIVE is enabled for this access point and
TA_DMKEEPALIVEWAIT is set to 0, receiving an acknowledgement to a sent keepalive message is unimportant: any such acknowledgement is ignored by the TDomain gateway. The gateway continues to send keepalive messages every time the
TA_DMKEEPALIVE timer times out.
Use this combination of settings to keep an idle connection open through a firewall.
The T_DM_TRANSACTION class represents run-time information about transactions that span domains. This object can be used to find out what remote domain access points are involved in the transaction, the parent domain access point, the transaction state, and other information.
For GET operations, the attributes
TA_DMTPTRANID,
TA_DMTXACCESSPOINT and
TA_DMTXNETTRANID may be supplied to select a particular transaction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ABD | ABY | ACT | COM | DEC | DON | HAB | HCO | HEU | REA | UNK} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ABD | ABY | ACT | COM | DEC | DON | HAB | HCO | HHZ | HMI | REA | UNK} ”
|
|
|
|
GET: “{
ABorteD |
ABortonlY |
ACTive |
COMcalled |
DECided |
DONe |
HABort |
HCOmmit |
HEUristic |
REAdy |
UNKnown}
”
A GET operation retrieves run-time information for the
T_DM_TRANSACTION object. The following states indicate the meaning of a
TA_STATE attribute value returned in response to a
GET request. States not listed are not returned.
A SET operation updates run-time information for the selected
T_DM_TRANSACTION object or objects. The following state indicates the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
If the transaction originated from a remote domain, TA_DMTXACCESSPOINT is the name of the remote domain access point through which it originated. If the transaction originated within this domain,
TA_DMTXACCESSPOINT is the name of the local domain access point.
If the transaction originated from a remote domain, TA_DMTXNETTRANID is the external transaction identifier received from the remote domain access point through which it originated. If the transaction originated within this domain,
TA_DMTXNETTRANID contains the same value as the
TA_DMTPTRANID attribute.
GET:
“{
ABD |
ABY |
ACT |
COM |
DEC |
DON |
HAB |
HCO |
HHZ |
HMI |
REA |
UNK}
”
A GET operation will retrieve run-time information for the transaction branch (when it is available for a particular domain gateway type).
On GET and
SET operations, a specific local domain access point must be specified for the
TA_DMLACCESSPOINT attribute.
On GET and
SET operations, the Domain gateway administration (
GWADM) server for the local access point identified in the
TA_DMLACCESSPOINT attribute must be active. Otherwise, a “not defined” error is returned.
tpacall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
MIB(5),
TM_MIB(5)
EVENTS—List of system-generated events
The string ERROR,
WARN, or
INFO, to indicate the severity of this event.
.SysMachineFullMaxaccessers
.SysMachineFullMaxwsclients
.SysTransactionHeuristicAbort
.SysTransactionHeuristicCommit
EVENT_MIB—Management Information Base for EventBroker
EVENT_MIB(5) should be used in combination with the generic MIB reference page,
MIB(5), to format administrative requests and interpret administrative replies. Requests formatted as described in
MIB(5) and a component MIB reference page may be used to request an administrative service using any one of a number of existing ATMI interfaces in an active application. For additional information pertaining to all
EVENT_MIB(5) class definitions, see
EVENT_MIB(5) Additional Information on page 191.
The pattern expression of TA_EVENT_EXPR in each class determines whether it is a
SYSTEM EVENT request or an
USER EVENT request. The determination on which one to query is made as follows:
|
•
|
A basic GET request without TA_EVENT_EXPR or TA_EVENT_SERVER specified will always go to the SYSTEM EVENT request and will not return USER EVENT request.
|
|
•
|
A GET request with TA_EVENT_EXPR specified but not TA_EVENT_SERVER will go to the SYSTEM EVENT request if the expressions starts with “\.”. Otherwise, it will go to the USER EVENT request.
|
|
•
|
A GET request with TA_EVENT_SERVER specified with a value of “SYSTEM” will go to the SYSTEM EVENT request. A value of “USER” will direct the request to the USER EVENT.
|
The field table for the attributes described in this reference page is found in the file udataobj/evt_mib (relative to the root directory of the Oracle Tuxedo system software). The directory
${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the
FLDTBLDIR32 environment variable and the field table name
evt_mib should be included in the comma-separated list specified by the
FIELDTBLS32 environment variable.
The T_EVENT_CLIENT class represents a set of subscriptions registered with the EventBroker for client-based notification.
When an event is detected, it is compared to each T_EVENT_CLIENT object. If the event name matches the value in
TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is sent to the specified client's unsolicited message handling routine.
A GET operation will retrieve configuration information for the matching
T_EVENT_CLIENT object(s).
A SET operation will update configuration information for the
T_EVENT_CLIENT object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_EVENT_CLIENT object. Successful return leaves the object in the ACTive state.
|
|
|
Delete T_EVENT_CLIENT object. Successful return leaves the object in the INValid state.
|
The T_EVENT_COMMAND class represents a set of subscriptions registered with the EventBroker that trigger execution of system commands. When an event is detected, it is compared to each
T_EVENT_COMMAND object. If the event name matches the value in
TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is formatted and passed to the system's command interpreter.
A GET operation will retrieve configuration information for the matching
T_EVENT_COMMAND object(s).
A SET operation will update configuration information for the
T_EVENT_COMMAND object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_EVENT_COMMAND object. Successful return leaves the object in the ACTive state.
|
|
|
Delete T_EVENT_COMMAND object. Successful return leaves the object in the INValid state.
|
The T_EVENT_QUEUE class represents a set of subscriptions registered with the EventBroker for queue-based notification. When an event is detected, it is compared to each
T_EVENT_QUEUE object. If the event name matches the value in
TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is stored in the specified reliable queue.
A GET operation will retrieve configuration information for the matching
T_EVENT_QUEUE object(s).
A SET operation will update configuration information for the
T_EVENT_QUEUE object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_EVENT_QUEUE object. Successful return leaves the object in the ACTive state.
|
|
|
Delete T_EVENT_QUEUE object. Successful return leaves the object in the INValid state.
|
This value, if present, is passed in to tpenqueue()'s
TPQCTL control structure to request notification via the /Q subsystem with the message to be placed on the queue ahead of the specified message.
The T_EVENT_SERVICE class represents a set of subscriptions registered with the EventBroker for service-based notification. When an event is detected, it is compared to each
T_EVENT_SERVICE object. If the event name matches the value in
TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is sent to the specified Oracle Tuxedo service routine.
A GET operation will retrieve configuration information for the matching
T_EVENT_SERVICE object(s).
A SET operation will update configuration information for the
T_EVENT_SERVICE object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_EVENT_SERVICE object. Successful return leaves the object in the ACTive state.
|
|
|
Delete T_EVENT_SERVICE object. Successful return leaves the object in the INValid state.
|
The T_EVENT_USERLOG class represents a set of subscriptions registered with the EventBroker for writing system
userlog(3c) messages. When an event is detected, it is compared to each
T_EVENT_USERLOG object. If the event name matches the value in
TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is formatted and passed to the Oracle Tuxedo
userlog(3c) function.
A GET operation will retrieve configuration information for the matching
T_EVENT_USERLOG object(s).
A SET operation will update configuration information for the
T_EVENT_USERLOG object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_EVENT_USERLOG object. Successful return leaves the object in the ACTive state.
|
|
|
Delete T_EVENT_USERLOG object. Successful return leaves the object in the INValid state.
|
factory_finder.ini is the FactoryFinder configuration file for Domains. This text (ASCII) file is parsed by the
TMFFNAME service when it is started as a Master NameManager. The file contains information used by NameManagers to control the import and the export of object references for factory objects with other domains. To use the information in the
factory_finder.ini file, you must specify the
factory_finder.ini file in the
-f option of the TMFFNAME server process.
Parameters are generally specified by: KEYWORD = value, which sets
KEYWORD to
value. Valid keywords are described within each section.
KEYWORDs are reserved; they cannot be used as values, unless they are quoted.
The # character introduces a comment. A newline ends a comment.
where factory_id.factory_kind is the local name (identifier) of the factory. This name must correspond to the identifier of a factory object registered by one or more Oracle Tuxedo server applications with the Oracle Tuxedo FactoryFinder.
The factory_kind must be specified for
TMFFNAME to locate the appropriate factory. An entry that does not contain a
factory_kind value does not default to a value of
FactoryInterface.
where factory_id.factory_kind is the name (identifier) of the factory object used by the local Oracle Tuxedo domain for a particular remote factory object. Remote factory objects are associated with a particular remote domain.
|
Note:
|
If you use the TobjFactoryFinder interface, the factory_kind must be FactoryInterface.
|
The name Ferror expands to a modifiable
lvalue that has type
int, the value of which is set to a positive error number by several FML library routines.
Ferror need not be the identifier of an object; it might expand to a modifiable
lvalue resulting from a function call. It is unspecified whether
Ferror is a macro or an identifier declared with external linkage. If a
tperrno() macro definition is suppressed to access an actual object, or if a program defines an identifier with the name
Ferror, the behavior is undefined.
Ferror32 provides a similar capability for users of FML32 routines. An application that checks the value of
Ferror32 must include the
fml32.h header file.
See the ERRORS section of the individual FML library routines for a more detailed description of the meaning of the error codes returned by each routine.
FML functions allow field values to be typed. Currently the following types are supported: char,
string,
short,
long,
float,
double,
carray (character array),
ptr (pointer to a buffer),
FML32 (embedded FML32 buffer), and
VIEW32 (embedded VIEW32 buffer). The
ptr,
FML32, and
VIEW32 types are supported only for the FML32 interface. Constants for field types are defined in
fml.h (
fml32.h for FML32). So that fielded buffers can be truly self-describing, the type of a field is carried along with the field by encoding the field type in the FLDID. Thus, a FLDID is composed of two elements: a field type, and a field number. In 32-bit FML, field numbers must be between 10,001 and 30,000,000. The numbers 1-10,000 and 30,000,001-33,554,431 are reserved for system use. In 16-bit FML, field numbers must be between 101 and 8,191. The numbers 1-100 are reserved for system use.
For efficiency, it is desirable that the field name to field identifier mapping be available at compile time. For utility, it is also desirable that these mappings be available at run time. To accommodate both these goals, FML represents field tables in text files, and provides commands to generate corresponding C header files. Thus, compile time mapping is done by the C preprocessor, cpp, by the usual
#define macro. Run-time mapping is done by the function
Fldid() (or
Fldid32() for FML32), which maps its argument, a field name, to a field identifier by consulting the source field table files.
|
•
|
Lines beginning with the string *base contain a base for offsetting subsequent field numbers. This optional feature provides an easy way to group and renumber sets of related fields.
|
|
•
|
rel-numb is the relative numeric value of the field. It is added to the current base to obtain the field number of the field.
|
|
•
|
type is the type of the field, and is specified as one of the following: char, string, short, long, float, double, carray, ptr, FML32, or VIEW32.
|
The command mkfldhdr (or
mkfldhdr32) converts a field table, as described above, into a file suitable for processing by the C compiler. Each line of the generated header file is of the form:
where name is the name of the field, and
fldid is its field identifier. The field identifier includes the field type and field number, as previously discussed. The field number is an absolute number, that is, base + rel-number. The resulting file is suitable for inclusion in a C program.
Functions such as Fldid(), which access field tables, and commands such as
mkfldhdr() and
vuform(), which use them, both need the shell variables
FLDTBLDIR and
FIELDTBLS (
FLDTBLDIR32 and
FIELDTBLS32 for FML32) to specify the source directories and files, respectively, from which the in-memory version of field tables should be created.
FIELDTBLS specifies a comma-separated list of field table filenames. If
FIELDTBLS has no value,
fld.tbl is used as the name of the field table file. The
FLDTBLDIR environment variable is a colon-separated list of directories in which to look for each field table whose name is not an absolute pathname. (The search for field tables is very similar to the search for executable commands using the
PATH variable.) If
FLDTBLDIR is not defined, it is taken to be the current directory. Thus, if
FIELDTBLS and
FLDTBLDIR are not set, the default is to take
fld.tbl from the current directory.
GAUTHSVR—General LDAP-based authentication server
GAUTHSVR is a System/T provided server that offers the authentication service . This server may be used in a secure application to provide per-user authentication when clients join the application. This server accepts service requests containing TPINIT typed buffer as a user password and validates it against the configured password that is stored in LDAP Server. If the request passes validation, then an application key is returned with a successful return as the ticket for the client to use.
By default, the file $TUXDIR/udataobj/tpgauth is used for obtaining LDAP configuration information. The file can be overridden by specifying the file name, using a
”-f filename” option in the server command line option. For example,
CLOPT=”-A -- -f/usr/tuxedo/myapp/myldap”.
If SECURITY is set to
USER_AUTH or higher, per-user authentication is enforced. The name of the authentication service can be configured for the application. If not specified, it defaults to
AUTHSVC which is the default service advertised for
GAUTHSVR.
If SECURITY is set to
ACL or
MANDATORY_ACL, per-user authentication is enforced and access control lists are supported for access to services, application queues, and events. The name of the authentication service must be
AUTHSVC which is the default service advertised by
GAUTHSVR for these security levels.
GAUTHSVR is supported as a Tuxedo System/T-supplied server on non-Workstation platforms.
GWADM—Domains gateway administrative server
GWADM SRVGRP = "
identifier"
SRVID = "
number"
REPLYQ = "N"
CLOPT = "-A -- [
-a {
on |
off}] [
-t {
on |
off}]"
GWADM should be defined in the
SERVERS section of the
UBBCONFIG file as a server running within a particular gateway group, that is,
SRVGRP must be set to the corresponding
GRPNAME tag specified in the
GROUPS section. The
SVRID parameter is also required and its value must consider the maximum number of gateways allowed within the gateway group.
There should be only one instance of a GWADM per Domains gateway group, and it should
not be part of the MSSQ defined for the gateways associated with the group. Also,
GWADM should have the
REPLYQ attribute set to
N.
The CLOPT option is a string of command-line options that is passed to the
GWADM when it is booted. This string has the following format:
This option turns off or
on the audit log feature for this local domain access point. The default is
off. The
dmadmin program can be used to change this setting while the gateway group is running (see
dmadmin(1)).
This option turns off or
on the statistics gathering feature for the local domain access point. The default is
off. The
dmadmin program can be used to change this setting while the gateway group is running (see
dmadmin(1)).
The GWADM server must be booted before the corresponding gateways.
GWADM is supported as an Oracle Tuxedo system-supplied server on all supported server platforms.
GWADM must be installed on Oracle Tuxedo release 4.2.1 or later; other machines in the same domain with a release 4.2.2 gateway can be release 4.1 or later.
GWTDOMAIN SRVGRP = "
identifier"
SRVID = "
number"
RQADDR = "
queue_name"
REPLYQ =
value RESTART =
Y [
MAXGEN =
value] [
GRACE =
value]
CLOPT = "
-A -- [-s][-U inbound-message-size-limit-in-bytes ]-x limit[:{[duration]:[period]}]”
GWTDOMAIN is the domain gateway process that provides interdomain communication.
GWTDOMAIN processes communicate with other
GWTDOMAIN processes in remote domains.
Domain gateways are described in the SERVERS section of the
UBBCONFIG file and the
BDMCONFIG file. Domain gateways must be always associated with a particular gateway group, that is,
SRVGRP must be set to the corresponding
GRPNAME tag specified in the
GROUPS section.
The SVRID parameter is also required and its value must consider the maximum number of gateways allowed within the domain group. The
RESTART parameter should be set to
Y. The
REPLYQ parameter may be set to
Y or
N.
The CLOPT option is a string of command-line options that is passed to
GWTDOMAIN when it is booted. The following run-time parameters are recognized for a gateway process:
-U inbound-message-size-limit-in-bytes
The GWTDOMAIN process must be in the same group as the
GWADM(5) process, with the
GWADM listed first. Multiple
GWTDOMAIN processes can be configured for a domain; each must be configured in a different Oracle Tuxedo group.
The location, server group, server ID, and other generic server-related parameters are associated with the ISL using the standard configuration file mechanisms for servers. ISL command-line options allow for customization.
The domain finds an address for hostname using the local name facilities (usually DNS). The host must be the local machine, and the local name resolution facilities must unambiguously resolve
hostname to the address of the local machine.
In the second format, the "#.#.#.#" is the dotted decimal format. In dotted decimal format, each
# must be a number from 0 to 255. This dotted decimal number represents the IP address of the local machine.
In both of the above formats, port_number is the TCP port number at which the domain process listens for incoming requests.
port_number can be a number between 0 and 65535 or a name. If
port_number is a name, it must be found in the network services database on your local machine.
|
Note:
|
The Java Tobj_Bootstrap object uses a short type to store the port_number. Therefore, you must use a port_number in the range of 0 to 32767 if you plan to support connections from Java clients.
|
|
Note:
|
The network address that is specified by programmers in the Bootstrap constructor or in TOBJADDR must exactly match the network address in the application’s UBBCONFIG file. The format of the address as well as the capitalization must match. If the addresses do not match, the call to the Bootstrap constructor will fail with a seemingly unrelated error message: ERROR: Unofficial connection from client at
<tcp/ip address>/<port-number>:
For example, if the network address is specified as //TRIXIE:3500 in the ISL command line option string, specifying either //192.12.4.6:3500 or //trixie:3500 in the Bootstrap constructor or in TOBJADDR will cause the connection attempt to fail. On UNIX systems, use the uname -n command on the host system to determine the capitalization used. On Windows NT systems, see the host system's Network control panel to determine the capitalization used.
|
A value of detect causes the ISL/ISH to raise a
NO_PERMISSION exception when an unofficial connection is detected. A value of
warn causes the ISL/ISH to log a message to the user log exception when an unofficial connection is detected; no exception will be raised. A value of
none causes the ISL/ISH to ignore unofficial connections.
A value of client configures this option for the client; a value of
handler configures this option for the ISL; and a value of
both will configure both sides of the connection. The default value is
none, in which case neither side has the
KEEPALIVE option configured.
|
Note:
|
The KEEPALIVE interval is an operating system parameter, so changing the value affects any other applications that enable KEEPALIVE. Many platforms have a two-hour default value that may be longer than desired.
|
This option requires that the –O (uppercase letter O) option is also specified. The value of this option must be greater than 0, but not more than 4096. An additional requirement is that the value of this option, (
outbound-max-connections) times the maximum number of handlers, must be less than 32767. The default for this option is 20.
A value of detect causes the Oracle ORB to verify that the host specified in the object reference used to make the connection matches the domain name specified in the peer server’s digital certificate. If the comparison fails, the Oracle ORB refuses the authenticate the peer and drops the connection. The
detect value is the default value.
A value of warn causes the Oracle ORB to verify that the host specified in the object reference used to make the connection matches the domain name specified in the peer’s digital certificate. If the comparison fails, the Oracle ORB logs a message to the user log but continues to process the connection.
The -v parameter is only available if licenses for SSL and LLE (link level encryption) are installed.
|
|
|
|
|
|
|
|
Use the Tobj_Bootstrap::register_callback_port method to register the callback port.
|
Use the CORBA::ORB::create_policy method to set BiDirPolicy on the POA.
|
|
|
|
|
If the foreign ORB supports the POA and BiDirPolicy, use the CORBA::ORB::create_policy method to set BiDirPolicy on the POA.
|
|
|
|
|
|
|
|
|
|
KAUTHSVR—Tuxedo Kerberos-based network authentication server
KAUTHSVR is a Kerberos-based Tuxedo authentication server
. Its purpose is two fold:
KAUTHSVR must be manually configured in the
UBBCONFIG file in order to complete Tuxedo user authentication if you want to use Kerberos the default authentication mechanism. There is a slight difference in how
KAUTHSVR is configured for UNIX and Windows platforms. For more information, see
“Using the Kerberos Authentication Plug-in.”
KAUTHSVR must have its own principal name associated with it. To specify which principal name
KAUTHSVR uses, you must configure it in the
UBBCONFIG file. The
CLOPT option uses the
-p parameter to establish its principal name. For example,
-p <principal name>. The principal name and its password must be configured in the Kerberos database and the local key table.
|
•
|
you can use the CLOPT option to tell KAUTHSVR where its KTAB is. The KAUTHSVR CLOPT option uses the -k parameter to specify where KTAB is located. For example," -k <key table full path name>".
|
|
•
|
you can also specify the KTAB location as an environmental variable. For example, " KRB5_KTNAME=<key table full path name>".
|
When KAUTHSVR is configured on a Windows platform a key table is not needed. However, it must have an account password. There are two ways to setup a
KAUTHSVR password:
|
•
|
Configure in the UBBCONFIG file SERVERS section related with KAUTHSVR. For example:
|
When TUXCONFIG is created, you must input the password at the command prompt.
|
Note:
|
The name kauthsvc in SEC_PRINCIPAL_NAME is used as an example only.
|
LAUTHSVR—WebLogic Server embedded LDAP-based authentication server
LAUTHSVR is a System/T provided server that offers the authentication service while the user security information is located in WebLogic Server. This server may be used in a secure application to provide per-user authentication when clients join the application. This server accepts service requests containing TPINIT typed buffer as a user password and validates it against the configured password that is stored in WebLogic Server. If the request passes validation, then an application key is returned with a successful return as the ticket for the client to use.
By default, the file $TUXDIR/udataobj/tpldap is used for obtaining LDAP configuration information. The file can be overridden by specifying the file name, using a
”-f filename” option in the server command line option. For example,
CLOPT=”-A -- -f/usr/tuxedo/myapp/myldap”. There is no automatic propagation of this configuration file from the master machine to other machines in the Tuxedo UBBCONFIG file. To use multiple LAUTHSVRs, you must provide separate configurations on the various machines.
If SECURITY is set to
USER_AUTH or higher, per-user authentication is enforced. The name of the authentication service can be configured for the application. If not specified, it defaults to
AUTHSVC which is the default service advertised for
LAUTHSVR.
If SECURITY is set to
ACL or
MANDATORY_ACL, per-user authentication is enforced and access control lists are supported for access to services, application queues, and events. The name of the authentication service must be
AUTHSVC which is the default service advertised by
LAUTHSVR for these security levels.
LAUTHSVR is supported as a Tuxedo System/T-supplied server on non-Workstation platforms.
METAREPOS - Tuxedo service metadata repository buffer format
TA_OPERATION,
TA_CLASS,
TA_CURSOR,
TA_OCCURS,
TA_FLAGS,
TA_FILTER,
TA_MIBTIMEOUT, and
TA_CURSORHOLD
TA_CLASS,
TA_OCCURS,
TA_MORE,
TA_CURSOR, and
TA_ERROR
|
Note:
|
The METAREPOS has the following generic MIB(5)field limitations:
|
|
•
|
Only MIB_PREIMAGE (a TA_FLAGS field flag) is used in metadata repository operation. The other two flags, MIB_LOCAL and MIB_SELF, are omitted.
|
|
•
|
TA_MIBTIMEOUT is ignored by . TMMETAREPOS service, tpsetrepos(3c) and tpgetrepos(3c).
|
TAOK - No service updates were made to the metadata repository
TAUPDATED - All service updates were made to the metadata repository
TAPARTIAL - Partial service updates were made to the metadata repository
METAREPOS service-level attribute fields are used to describe services. The
TA_REPOSSERVICE attribute is a key field that is used to name services and uniquely identify them for retrieval or
get operations.
TA_REPOSSERVICE can accept regular expressions as defined in
rex(1). For example, using the regular expression value
"*" with
TA_REPOSSERVICE retrieves all service information in a metadata repository.
For set operations,
TA_REPOSSERVICE must include a Tuxedo service name and
cannot be interpreted as a regular expression.
METAREPOS parameter-level attribute fields are used to describe service parameters. Common
occurrence numbers are used to associate different attribute fields as part of a common parameter.The
nth service parameter is described by the occurrence number
n-1 of all parameter-level attribute fields.
For example, the first service parameter is described by the
first occurrence of the attribute field as “0”; the
second service parameter is described by the
second occurrence of the attribute field as “1”, and so on.
TA_REPOSEMBED is used to provide information about service parameters that have
sub-parameter values, or in other words, embedded data.
The TA_REPOSEMBED parameter value corresponds to the information contained between matching parentheses
“(” and
“)”in the
repository_input file or the unloaded
-t repository_file. For more information on the
repository_input file and
repository_file, see
tmloadrepos(1) and
tmunloadrepos(1).
A GET operation retrieves information for the selected service object(s). The following state(s) define
TA_STATE returned in response to a
GET request.
A SET operation updates information for the selected service object(s). The following state(s) define
TA_STATE set in a set request. States not listed cannot be set
"tuxedo
" stands for a Tuxedo originated service definition.
"webservice
" stands for a SALT proxy service definition generated by BEA SALT wsdlcvt utility.
The service(s) input buffer type. Valid values: FML,
FML32,
VIEW,
VIEW32,
STRING,
CARRAY,
XML,
X_OCTET,
X_COMMON,
X_C_TYPE,
MBSTRING or a custom-defined type. Only one type is allowed.
Optional only for FML/FML32 field parameter, field id. Note that this field cannot be written or updated.
Valid values are: anyType, boolean, base64Binary, hexBinary, float, double, anyURI, QName, NOTATION, duration, dateTime, time, date, gYearMonth, gYear, gMonthDay, gDay, gMonth, string, normalizedString, token, language, Name, NCName, NMTOKEN, NMTOKENS, ID, IDREF, IDREFS, ENTITY, ENTITIES, decimal, integer, nonPositiveInteger, negativeInteger, nonNegativeInteger, positiveInteger, long, unsignedLong, int, unsignedInt, short, unsignedShort, byte, unsignedByte
|
Note:
|
TA_REPOSEMBED field also is used to encapsulate attributes of each service once there might be multiple services in one FML32 buffer. Please see figure 6-1 and 6-2 for more information.
|
Currently, METAREPOS input and output is in
FML32 buffer format and is used to describe one or more instances of service metadata information. This
FML32 typed buffer format is define in two modes: Standard Mode and Single Mode.
|
Note:
|
For SET operations, TA_ERROR and TA_STATUS are included in each TA_REPOSEMBED buffer to indicate the set result of each service.
|
1. SET operations (adding or updating) to outstanding multiple services
1. SET operations to only one outstanding particular service
MIB—Management Information Base
The ?$paratext>? section gives examples of the use of existing ATMI verbs and the additional FML32 fields as they might be used for administrative interaction with component MIBs.
The most direct way to interface to FML32 is to include the <fml32.h> header file instead of the standard <
fml.h> header file and then to use the FML32 version of each relevant FML interface specified in the
Oracle Tuxedo ATMI FML Function Reference. For example, one would use
Fchg32() instead of using
Fchg().
Call Oracle Tuxedo system MIB service, ".TMIB", with a populated FML32 typed buffer as input and with an allocated FML32 typed buffer in which to store the output returned from the service. The buffer length for the input buffer may be specified as 0 since FML32 is a self-describing buffer type. The
TPNOTRAN flag should be used if the call is being made within a transaction; otherwise, there are no specific requirements or restrictions on the use of the flags defined for this verb.
Asynchronously call Oracle Tuxedo system MIB service, ".TMIB", with a populated FML32 typed buffer as input. The buffer length for the input buffer may be specified as 0 since FML32 is a self-describing buffer type. The
TPNOTRAN flag should be used if the call is being made within a transaction; otherwise, there are no specific requirements or restrictions on the use of the flags defined for this verb.
Enqueue a request to the Oracle Tuxedo system MIB service, ".TMIB", for later processing. The buffer length for the input buffer may be specified as 0 since FML32 is a self-describing buffer type. There are no specific requirements or restrictions on the use of the flags defined for this verb; however, the
TMQFORWARD(5) server configured by the application to handle forwarding of these requests should be started with the
-n (
tpcall() with
TPNOTRAN flag set) and
-d (delete) options.
This flag is used to modify retrievals from certain classes defined in this MIB. For a number of classes in this
MIB, there exists both global information (available at any site in an active application) and local information (available on the particular site where the object is active). Requests to retrieve information from these classes will by default retrieve only the global information and not the local for efficiency. If the application user is willing to wait for local information to be collected, possibly from multiple sites, this flag should be set on the retrieval request. Classes with local information have local attributes listed last in the attribute table with a subheading indicating that they are local attributes. Classes which have only local information will automatically default to retrieving local information even if this flag value is not set.
indicates that a pre-image check must be passed before a SET operation will be performed. A pre-image check insures that occurrence 0 of any
MIB specific class attributes match the existing object. If so, the object is updated using occurrence 1 of any
MIB specific class attributes. Attributes occurring less than two times are not considered for pre-image checking. Multiply occurring fields are checked if their associated count attribute is specified twice.
Application programs written to interface with component MIBs must include certain header files. <fml32.h> defines macros, structures and function interfaces necessary for accessing and updating FML32 typed buffers.
<fml1632.h> defines a mapping from the generic FML interface macros, structures and functions to the FML32 versions and may optionally be included.
<tpadm.h> defines the FML32 field names contained in this reference page. Additionally, any component MIB specific header files must be included to gain access to FML32 field definitions specific to that component MIB.
/*
* Does not include error processing, bigger_size provided
* by the user, not by the system. Fchg32 used to insure that
* field occurrence 0 is set if we are reusing a buffer.
*/
if (Fchg32(rqbuf, TA_MIBFIELD, 0, "ABC", 0) == -1) {
if (Ferror32 == FNOSPACE) {
rqbuf = tprealloc(rqbuf,
bigger_size);
Fchg32(rqbuf, TA_MIBFIELD, 0, "ABC", 0);
}
}
TA_OPERATION specifies the operation to be performed on the MIB being accessed. Valid operations are
GET,
GETNEXT and
SET.
TA_CLASS specifies the MIB class being accessed. Class names are defined within the component MIB reference pages. If
TA_OPERATION is
GETNEXT, an additional attribute,
TA_CURSOR, is required.
TA_CURSOR is a field returned on a previous
GET or
GETNEXT operation. It is used by the system on the subsequent request to determine retrieval position.
The optional attributes TA_OCCURS,
TA_FLAGS,
TA_FILTER,
TA_MIBTIMEOUT and
TA_CURSORHOLD may be used in addition to the required attributes to further tailor the request.
/* GET 1st 5 objects */
Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "classname", 0);
n = 5;
Fchg32(rqbuf, TA_OCCURS, 0, n, 0);
/* Make request, see Sending MIB Requests below */
/* Reply is stored in rpbuf and contains cursor */
/*
* GETNEXT 5 objects. Transfer TA_CURSOR from rpbuf.
* Reuse rqbuf generated above. Dispose of snapshot after
* request, that is, set TA_CURSORHOLD to 0.
*/
Fchg32(rqbuf, TA_OPERATION, 0, "GETNEXT", 0);
Fchg32(rqbuf, TA_CURSOR, 0, Ffind32(rpbuf, TA_CURSOR, 0, NULL), 0);
n = 0;
Fchg32(rqbuf, TA_CURSORHOLD, 0, n, 0);
/* Make request, see Sending MIB Requests below */
Component MIB key fields specified on a SET operation are used to identify the particular object to be updated. Non-key fields are processed as updates to the object identified by the key fields. The user may optionally specify a pre-image which must match the current object image before an update (
SET) is allowed. A user indicates that a pre-image is provided by setting the
MIB_PREIMAGE bit in the
TA_FLAGS attribute of the request. The key fields specifying the object to be updated are taken from the pre-image (field occurrence 0). If key fields are also specified in the post-image, they must match exactly or the request fails. Only attributes that are part of the class and have two attribute values specified in the input buffer are considered for pre-image matching. Attributes with single values are processed as new values to be set for the indicated class object.
Fchg32(rqbuf, TA_OPERATION, 0, "GET", 0);
Fchg32(rqbuf, TA_CLASS, 0, "classname", 0);
Fchg32(rqbuf, TA_MIBKEY, 0, "keyvalue", 0);
n = 1;
Fchg32(rqbuf, TA_OCCURS, 0, n, 0); /* GET 1st matching occurrence */
/* Make request, see Sending MIB Requests below, reply in rpbuf */
/* Use rpbuf as pre-image and update TA_MIBFIELD value
* if matching
*/
Fcpy32(newrq, rpbuf);
Fconcat32(newrq, rpbuf); /* Add 2nd identical copy */
Fchg32(newrq, TA_OPERATION, 0, "SET", 0);
n = MIB_PREIMAGE;
Fchg32(newrq, TA_FLAGS, 0, n, 0);
Fchg32(newrq, TA_MIBFIELD, 1, "newval", 0); /* Post-image */
/* Make request, see Sending MIB Requests below */
All component MIB requests flow through the core Oracle Tuxedo component MIB service, ".TMIB". This service not only acts as an agent for servicing
TM_MIB(5) requests, it also directs requests targeted for other component MIBs so that the user need not be concerned with matching service names to MIBs and classes. Service requests can be generated using any of the request/response oriented service verbs in ATMI:
tpcall(),
tpacall() and
tpenqueue(). The user has access to all flags and capabilities defined for these interface functions. The only constraint imposed here is that the "
.TMIB" service must be invoked outside the scope of any transaction. This means that when using
tpcall() or
tpacall() to direct administrative requests within a transaction, the
TPNOTRAN flag should be used or the user will get a failure (
TPETRAN). When using
tpenqueue() to direct requests, the
TMQFORWARD server must be started with the
-n option so that the forwarded service requests may be made outside of transactional boundaries.
/* Build request as shown above */
/* Send request and wait for reply */
flags = TPNOTRAN | TPNOCHANGE | TPSIGRSTRT;
rval = tpcall(".TMIB", rqbuf, 0, rpbuf, rplen, flags);
/* Send request and get descriptor back */
flags = TPNOTRAN | TPSIGRSTRT;
cd = tpacall(".TMIB", rqbuf, 0, flags);
/* Enqueue request, assumes qctl already setup */
flags = TPSIGRSTRT;
rval = tpenqueue("queue", ".TMIB", qctl, rqbuf, 0, flags);
/* Build request as shown above */
/* Send request and wait for reply */
flags = TPNOTRAN | TPNOCHANGE | TPSIGRSTRT;
rval = tpcall(".TMIB", rqbuf, 0, rpbuf, rplen, flags);
/* Receive reply using call descriptor */
flags = TPNOCHANGE | TPSIGRSTRT;
rval = tpgetrply(cd, rpbuf, rplen, flags);
/* Receive reply using TPGETANY, may need to change buffer type */
flags = TPGETANY | TPSIGRSTRT;
rval = tpgetrply(rd, rpbuf, rplen, flags);
/* Dequeue reply, assumes qctl already setup */
flags = TPNOCHANGE | TPSIGRSTRT;
rval = tpdequeue("queue", "replyq", qctl, rpbuf, rplen, flags);
Set to a non-negative return value. TAOK indicates that the request was successful but no information was updated. This can happen because no changes were specified or because the changes specified match the current state of the object.
TAUPDATED indicates that the request was successful and the information was updated.
TAPARTIAL indicates that the request was successful but the update was only made partially within the system. This may occur because of network failures or message congestion and the system will synchronize the unupdated sites as soon as possible.
Requests to any component MIB cannot be part of an application transaction. Therefore, any calls to tpcall() or
tpacall() directed to a component MIB and made within an active transaction should set the
TPNOTRAN flag on the call. However, requests may be enqueued for future delivery to a component MIB using the ATMI verb
tpenqueue() within a transaction. The enqueuing of the request will take place within a transaction while the processing within the component MIB will not. The use of the
TMQFORWARD(5) server in this context requires that
TMQFORWARD be started with the
-n command line option so that request may be forwarded to the MIB service in non-transactional mode. Because of the non-transactional nature of component MIB services, it is also recommended that the
-d option for
TMQFORWARD be used so that service failures are delivered to the failure queue immediately rather than retrying the request.
SET operations on classes with one or more
SET keys defined (see * above) must include values for one or more of the attribute values defined as
SET keys. The
SET keys specified must be sufficient to identify exactly one object within the class.
SET keys are always key fields for object retrieval and therefore the (k) notation is implied though not specified.
SET keys are not however always required fields when creating
NEW objects and will be marked with the (r) notation if they are required.
|
|
Attribute may be updated when the object is in an ACTive or ACTive equivalent state. See the description of the TA_STATE attribute value for each class to determine which states qualify as ACTive equivalent.
|
|
|
Attribute may be updated when the object is in an ACTive or ACTive equivalent state. See the description of the TA_STATE attribute value for each class to determine which states qualify as ACTive equivalent. This attribute represents transient information and updates to this attribute value are not persistent across distinct activations of the object.
|
|
|
Attribute may be updated when the object is in an ACTive or ACTive equivalent state. However, there are limitations on when the change will affect objects of this or other classes. Consult the textual description of the attribute in the Attribute Semantics section for the class for more details. See the description of the TA_STATE attribute value for each class to determine which states qualify as ACTive equivalent.
|
The TA_STATE attribute field is a member of each class defined. The semantics of this attribute are defined on a class by class basis. For the sake of brevity,
TA_STATE values are often specified in a three character shorthand notation. When an expanded version of a
TA_STATE value is shown, the three shorthand letters are capitalized and the rest of the letters (if any) are displayed in lowercase. Input
TA_STATE values may be in either shorthand or long notation and are case insensitive. Output
TA_STATE values are always full length uppercase. The following example should help clarify the use of the
TA_STATE attribute:
The T_CLASS class represents attributes of administrative classes within an Oracle Tuxedo system application. Its primary use is to identify class names.
A GET operation retrieves information for the selected
T_CLASS object(s). The following state indicates the meaning of a
TA_STATE returned in response to a
GET request. States not listed are not returned.
|
|
T_CLASS object is defined. All objects of this class exist in this state. This state is INActive-equivalent for the purposes of permissions checking.
|
SET operations are not permitted on this class.
The T_CLASSATT class represents characteristics of administrative attributes on a class/attribute basis.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
A GET operation will retrieve information for the selected
T_CLASSATT object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_CLASSATT object is defined. All objects of this class exist in this state. This state is INActive equivalent for the purposes of permissions checking.
|
A SET operation will update configuration information for the selected
T_CLASSATT object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_CLASSATT object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify T_CLASSATT object. Allowed only when in the VALid state. Successful return leaves the object state unchanged.
|
|
|
Delete or reset T_CLASSATT object for application. State change allowed only when in the VALid state. Successful return leaves the object in either the INValid state or the VALid state. Objects of this class that are built-in, that is, explicitly known to the system, will revert to their default permissions on this state change and continue to exist in the VALid state. Objects of this class that belong to add-on components for which the class attributes are not explicitly known will be deleted on this state change and transition to the INValid state.
|
Default for this attribute when creating a NEW object in this class. Note that for classes where
NEW objects may not be created through the Admin API, this attribute will always be returned as a 0 length string. Attributes that may not be
SET when creating a
NEW object are also returned as 0 length strings. Attributes which have
long values will have defaults returned as the string representing the long value. Some attributes have special characteristics indicated by the special values indicated below that may be returned here.
An attempt was made to SET an attribute for which the user does not have write permissions or the user attempted a
GET on a class for which the user does not have read permissions.
TA_BADFLD is set to indicate the field identifier that failed permissions checking.
A SET operation failed due to a mismatch between the specified pre-image and the current object.
TA_BADFLD is set to indicate the field identifier that failed the pre-image checking.
A SET operation did not specify class keys identifying a unique object to be updated.
See the "USAGE" section earlier for some brief example uses of existing APIs in interfacing with generic MIB processing. More detailed examples are provided with each component MIB reference page that make use of real component MIB classes and attributes.
${TUXDIR}/include/tpadm.h,
${TUXDIR}/udataobj/tpadm
tpacall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
AUTHSVR(5),
TM_MIB(5),
TMQFORWARD(5)
The nl_types.h header file contains the following definitions:
Used by nl_langinfo() to identify items of
langinfo() data. Values for objects of type
nl_item are defined in
langinfo.h.
Used by gencat() when no
$set directive is specified in a message text source file. This constant can be used in subsequent calls to
catgets() as the value of the set identifier parameter.
servopts—Run-time options for server processes
AOUT CLOPT= [-A][-s{@
filename|
service[,
service...][:
func]}]
[-e
stderr_file][-h][-l
locktype][-n
prio]
[-o
stdout_file][-P][-p [L][
low_water][,[
terminate_time]]
[:[
high_water][,
create_time]][-r][-t][ --
uargs][-
v]
servopts is not a command. Rather, it is a list of run-time options recognized by servers in an Oracle Tuxedo system.
-s { @
filename |
service[,
service...][:
func] }
Lock the server in core. The argument for locktype is
t,
d, or
p according to whether the text (
TXTLOCK), data (
DATLOCK), or the entire process (text and data—
PROCLOCK), should be locked. See
plock(2) for details. The lock fails if the server is not run as root. There is no way to unlock a server once it is locked.
nice the server according to the
prio argument. Giving the process better priority (a negative argument) requires it to be run with the
UID of
root. See
nice(2) for details.
|
•
|
SUSP (suspended) when booting and tpsvrinit () is running. Requests to a suspended service will fail and return TPNOENT immediately. If tpsvrinit () runs for an extended period of time, the -P option helps avoid service requests timeout at the booting stage.
|
|
•
|
AVAIL (available) after tpsvrinit () has completed and the server is ready to receive requests.
|
|
Note:
|
It is highly recommended to use this CLOPT with application servers only. Do not use it as the default CLOPT, since it may affect all system servers, for example, TMUSREVT, TMSYSEVT, GWTDOMAIN, GWADM, TMS, TMQUEUE, etc.
|
The "-P" option can also be used with CORBA application servers.
-p [
L][
low_water][,[
terminate_time]][:[
high_water][,
create_time]]
If the -p option is specified with the
L argument, then, if the load meets or exceeds a threshold (specified by the
high_water argument) for a specified amount of time (in seconds), the system will spawn additional servers. If, however, the value of
high_water is 1, then the single server responsible for spawning another server will not do so as long as it is handling messages.
|
Note:
|
For UNIX platforms only—the alarm() system call does not work as expected in servers running under server pool management. Because the code that terminates idle servers uses the alarm() call, user-written code intended to establish a customized signal handler fails to do so, despite the fact that calls to Usignal() do not result in errors.
|
low_water,
terminate_time,
high_water, and
create_time
low_water,
terminate_time,
high_water, and
create_time
The -c option adds a comment line, in which the specified domain ID is reported, to any command output that reports on the processes associated with the domain in question, such as the output of the
ps command. This comment helps an administrator who is managing multiple domains to interpret a single output stream that refers to several domains.
nice(2),
plock(2),
getopt(3) in a UNIX system reference manual
TM_MIB—Management Information Base for core Oracle Tuxedo system
TM_MIB(5) should be used in combination with the generic MIB reference page
MIB(5) to format administrative requests and interpret administrative replies. Requests formatted as described in
MIB(5) using classes and attributes described in this reference page may be used to request an administrative service using any one of a number of existing ATMI interfaces in an active application. Inactive applications may also be administered using the
tpadmcall() function interface. For additional information pertaining to all
TM_MIB(5) class definitions, see
TM_MIB(5) Additional Information on page 427.
TM_MIB(5) consists of the following classes.
|
•
|
OVERVIEW—high level description of the attributes associated with the class.
|
|
•
|
LIMITATIONS—limitations in the access to and interpretation of this class.
|
MIB(5) defines the generic
TA_FLAGS attribute, which is a
long containing both generic and component MIB specific flag values. The following are the
TM_MIB(5) specific flag values supported. These flag values should be or’d with any generic MIB flags.
A flag used when activating or deactivating T_MACHINE,
T_GROUP, or
T_SERVER objects to cause unsolicited notification messages to be sent to the originating client just prior to and just after the activation or deactivation of each server object selected.
The field table for the attributes described in this reference page is found in the file udataobj/tpadm relative to the root directory of the Oracle Tuxedo system software installed on the system. The directory
${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the
FLDTBLDIR environment variable, and the field table name
tpadm should be included in the comma-separated list specified by the
FIELDTBLS environment variable.
For the purpose of pre-image processing (MIB_PREIMAGE flag bit set), local attributes for classes that have global attributes are not considered. Additionally, indexed fields and the indexes that go with them are not considered, for example,
T_TLOG class,
TA_TLOGCOUNT,
TA_TLOGINDEX,
TA_GRPNO,
TA_TLOGDATA attributes.
The T_BRIDGE class represents run-time attributes pertaining to connectivity between logical machines making up an application. These attribute values represent connection status and statistics.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | INA | SUS | PEN} ”
SET: “{ ACT | INA | SUS | PEN} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
Logical name of the network group.When both source and destination TA_LMID identifiers are in the same
TA_NETGROUP, the
T_BRIDGE class will present all instances of related fields per
TA_NETGROUP.
TA_NETGROUP may be used as a key field on
GET requests.
TA_NETGROUP values other than
DEFAULTNET may not be used on
SET operations in this Oracle Tuxedo release (release 6.4).
GET:
“{
ACTive |
INActive |
SUSpended |
PENding}
”
A GET operation will retrieve run-time information for the selected
T_BRIDGE object(s). A
TA_LMID attribute value with only one logical machine identifier matches all active connections from
LMID1 to other machines in the application. In this case, each retrieved record will contain an expanded
TA_LMID attribute value with the destination
LMID filled in. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
SET:
“{
ACTive |
INActive |
SUSpended |
PENding}
”
A SET operation will update run-time information for the selected
T_BRIDGE object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Modify an existing T_BRIDGE object. This combination is allowed only when in the ACTive or SUSpended state. Successful return leaves the object state unchanged.
|
|
|
Activate the T_BRIDGE object by establishing a connection between the indicated logical machines. This operation will fail if only one logical machine is specified, if either of the two machines is not active, or if the source logical machine is not reachable. While the T_BRIDGE object is establishing the asynchronous connection, the Bridge process will do other work. Using the state change to PENding is recommended. State change allowed in the INActive and SUSpended states. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the PENding state.
|
|
|
Deactivate the T_BRIDGE object by closing the connection between the indicated logical machines. This operation will fail if only one logical machine is specified or if the two machines are not connected. State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state.
|
|
|
Suspend the T_BRIDGE object by closing the connection between the indicated logical machines and by setting the TA_SUSPTIME attribute as indicated. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state. Limitation: Note that since the statistics reported are from the viewpoint of the source logical machine, resetting those statistics will cause them to be out of sync with the statistics reported by the destination logical machine for the same connection.
|
|
|
Activate the T_BRIDGE object by establishing an asynchronous connection between the indicated logical machines. This operation will fail if only one logical machine is specified, if either of the two machines is not active, or if the source machine is not reachable. When in the PENding state, the success or failure of the connection request has not yet been determined. However, the Bridge process may continue to process other events and data while the connection is outstanding. State change allowed in the INActive and SUSpended states. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the PENding state.
|
The T_CLIENT class represents run-time attributes of active clients within an application. These attribute values identify and track the activity of clients within a running application.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ DIPIN | SIGNAL | THREAD | IGNORE} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
GET:
“{
ACTive |
SUSpended |
DEAd}
”
A GET operation will retrieve run-time information for the selected
T_CLIENT object(s). Note that client information is kept in local bulletin board tables only. Therefore, for maximum performance, inquiries on client status should be restricted using key fields as much as possible. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_CLIENT object active. This is not an indication of whether the client is idle or busy. A non 0 value retrieved for either the TA_CURCONV attribute or the TA_CURREQ attribute indicates a busy client.
|
|
|
T_CLIENT object active and suspended from making further service requests ( tpcall() or tpacall()) and from initiating further conversations ( tpconnect()). See SET SUSpended below for details. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_CLIENT object identified as active in the bulletin board but currently not running due to an abnormal death. This state will exist only until the BBL local to the client notices the death and takes action to clean up the client's bulletin board resources. This state is ACTive equivalent for the purpose of determining permissions.
|
SET:
“{
ACTive |
SUSpended |
DEAd}
”
A SET operation will update run-time information for the selected
T_CLIENT object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Activate a SUSpended T_CLIENT object. State change allowed only when in the SUSpended state. Successful return leaves the object in the ACTive state.
|
|
|
Modify an existing T_CLIENT object. This combination is allowed only when in the ACTive or SUSpended state. Successful return leaves the object state unchanged.
|
|
|
Suspend the T_CLIENT object from making service requests ( tpcall() or tpacall()), initiating conversations ( tpconnect()), beginning transactions ( tpbegin()), and enqueuing new requests ( tpenqueue()). Clients within a transaction will be permitted to make these calls until they abort or commit the current transaction, at which time they will become suspended. Invocations of these routines will result in a TPESYSTEM error return and a system log message being generated indicating the situation. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state.
|
|
|
Abortively deactivate the T_CLIENT object. State change allowed only when in the ACTive or SUSpended state. The recommended method for deactivating clients is to first broadcast a warning message ( tpbroadcast)), then to suspend them (see SET SUSpended above), and finally to abortively deactivate them by setting the state to DEAd. Successful return leaves the object in the DEAd state.
Limitation: Workstation handlers (T_CLIENT: TA_WSH == Y) may not be set to a state of DEAd.
The system may not be able to kill the client due to platform or signaling restrictions. In this case, a native client will be abortively terminated at its next access to ATMI, and a Workstation client's connection to a WSH will be preemptively torn down.
|
Reports the current tpsblktime(TPBLK_ALL)blocktime value per client. If
TPBLK_ALL has not been set, then the
TA_TPBLK_ALL value is 0.
Setting of the TP_COMMIT_CONTROL characteristic for this client. See the description of the Oracle Tuxedo System ATMI function
tpscmt() for details on this characteristic.
Server group number (T_GROUP:
TA_GRPNO) of the last service request made or conversation initiated from this client.
TA_NADDR:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Each # (pound) sign represents a decimal number in the range of 0 to 255. The value of
port_number is a decimal number in the range of 0 to 65535.
TA_NOTIFY:
“{
DIPIN |
SIGNAL |
THREAD |
IGNORE}
”
The T_CONN class represents run-time attributes of active conversations within an application.
A GET operation will retrieve run-time information for the selected
T_CONN object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
SET operations are not permitted on this class.
Number of tpsend() calls done by the originator.
Number of tpsend() calls done by the subordinate.
The T_DEVICE class represents configuration and run-time attributes of raw disk slices or UNIX system files being used to store Oracle Tuxedo system device lists. This class allows for the creation and deletion of device list entries within a raw disk slice or UNIX system file.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
The offset, in blocks, at which space on this TA_DEVICE begins for use within the Oracle Tuxedo System VTOC specified by
TA_CFGDEVICE. Limitation: This attribute must be set to 0 for the first device list entry (
TA_DEVICE) on the Oracle Tuxedo filesystem (
TA_CFGDEVICE).
Device index for TA_DEVICE within the device list addressed by
TA_CFGDEVICE. This attribute value is used for identification purposes only in getting and setting attribute values relating to particular devices within an Oracle Tuxedo filesystem.
A GET operation will retrieve run-time information for the selected
T_DEVICE object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
A SET operation will update information for the selected
T_DEVICE object or add the indicated object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create or re-installed T_DEVICE object for application. State change allowed only when in the INValid or VALid state. Successful return leaves the object in the VALid state. If this state transition is invoked in the INValid state, the object is created; otherwise, it is re-initialized. The creation of the first TA_DEVICE device list entry on the TA_CFGDEVICE Oracle Tuxedo filesystem will automatically create and initialize the necessary VTOC and UDL structures on TA_CFGDEVICE. The first device list entry created for a particular TA_CFGDEVICE must have equivalent values for the TA_DEVICE attribute.
|
|
|
Delete T_DEVICE object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state. Note that TA_DEVINDEX 0 is special and must be deleted last.
|
The T_DOMAIN class represents global application attributes. These attribute values serve to identify, customize, size, secure, and tune an Oracle Tuxedo system application. Many of the attribute values represented here serve as application defaults for other classes represented in this MIB.
There is exactly one object of the T_DOMAIN class for each application. Because of this, there are no key fields defined for this class. A
GET operation on this class will always return information representing this single object. Likewise, a
SET operation will update it.
GETNEXT is not permitted with this class.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SET: “{ NEW | INV | ACT | INA | FIN} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ DIPIN | SIGNAL | THREAD | IGNORE} ”
|
|
|
|
|
|
“{ FASTPATH | PROTECTED} [ ,NO_OVERRIDE] ”
|
|
|
|
|
|
|
|
“{[ LAN | SSL | MIGRATE | ACCSTATS | NO_XA | NO_AA],*} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ NONE | APP_PW | USER_AUTH | ACL | MANDATORY_ACL} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Master (LMID1) and backup (
LMID2) logical machine identifiers. The master identifier (
LMID1) must correspond to the local machine for
INActive applications.
SHM mode applications (see
TA_MODEL below) may set only the master logical machine identifier. Modifications to this attribute value in an
ACTive MP application (see
TA_MODEL below) have the following semantics:
Assuming current active master LMID A, current backup master LMID
B, and secondary LMIDs
C, D, . . ., the following scenarios define the semantics of permitted changes to the
TA_MASTER attribute in a running
MP mode application.
Note that master migration may be either orderly or partitioned. Orderly migration takes place when the master machine is ACTive and reachable. Otherwise, partitioned migration takes place. All newly established or reestablished network connections will verify that the two sites connecting share a common view of where the master machine is. Otherwise, the connection will be refused and an appropriate log message generated. The master and backup machines in an
ACTive application must always have an Oracle Tuxedo release number greater than or equal to all other machines active in the application. The master and backup machines must be of the same release. Modifications to the
TA_MASTER attribute must preserve this relationship.
Configuration type. SHM specifies a single machine configuration; only one
T_MACHINE object may be specified.
MP specifies a multi-machine or network configuration;
MP must be specified if a networked application is being defined.
GET:
“{
ACTive |
INActive}
”
A GET operation will retrieve configuration and run-time information for the
T_DOMAIN object. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_DOMAIN object defined and the master machine is active.
|
|
|
T_DOMAIN object defined and application is inactive.
|
SET:
“{
NEW |
INValid |
ACTive |
INActive |
FINactive}
”
A SET operation will update configuration and run-time information for the
T_DOMAIN object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_DOMAIN object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state. Note that this state change will also create a NEW T_MACHINE object with TA_LMID inferred from TA_MASTER, TA_PMID based on the local system name, and TA_TUXCONFIG and TA_TUXDIR determined from the environment variables TUXCONFIG and TUXDIR respectively. Other configurable attributes of the T_MACHINE class may be set at this time by including values in the T_DOMAIN NEW request. If a value for TA_APPDIR is not specified, it will default to the current directory.
|
|
|
Modify T_DOMAIN object. Allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.
|
|
|
Delete T_DOMAIN object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
|
|
|
|
|
|
|
System administration processes, such as the BBL, restartsrv,
cleanupsrv,
tmshutdown(), and
tmadmin(), need not be accounted for in this value, but the DBBL, all bridge processes, all system-supplied and application server processes, and all potential client processes at a particular site need to be counted. (Examples of system-supplied servers are
AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS (see
T_GROUP:TA_TMSNAME attribute),
TMS_QM,
GWTDOMAIN, and
WSL.) If the application is booting workstation listeners (WSLs) at a particular site, both the WSLs and the number of potential workstation handlers (WSHs) that may be booted need to be counted.
Note that for Oracle Tuxedo pre-release 7.1 (6.5 or earlier), both the TA_MAXACCESSERS and
TA_MAXSERVERS attributes for an application play a part in the user license checking scheme. Specifically, a machine is not allowed to boot if the number of
TA_MAXACCESSERS for that machine + the number of
TA_MAXACCESSERS for the machine (or machines) already running in the application is greater than the number of
TA_MAXSERVERS + user licenses for the application. Thus, the total number of
TA_MAXACCESSERS for an application must be less than or equal to the number of
TA_MAXSERVERS + user licenses for the application.
Oracle Tuxedo system needs the bulletin board string pool size ( MAXQUEUES * 257 * 2 + 8224 ) at a minimum, where
MAXQUEUES is the
TA_MAXQUEUES attribute value in the same
T_DOMAIN class. If this attribute is set with value that smaller than the minimum required size, Oracle Tuxedo system automatically changes the value to the minimum required size.
Regardless of the value specified for TA_MAXSPDATA, the Oracle Tuxedo system will
not allocate an amount of string pool space outside of a system-calculated range based on (1) the strings actually specified in the
TUXCONFIG file and (2) the amount of space that would be required if all 256-byte capable strings were specified. The
tmloadcf(1) command will report a warning if the user-specified value is outside of this range and then set the value to the closest acceptable value.
Note that of the TUXCONFIG parameters whose maximum allowable length has been increased to 256 bytes, only the
GROUPS section
TMSNAME parameter and the
SERVERS section
AOUT and
RCMD parameters are actually stored in the bulletin board. The others are read in at process startup time and stored in process memory.
If the TA_MAXTRANTIME timeout value is less than the
TRANTIME timeout value specified for an
AUTOTRAN service or the timeout value passed in a
tpbegin(3c) call to start a transaction, the timeout for a transaction is reduced to the
TA_MAXTRANTIME value.
TA_MAXTRANTIME has no effect on a transaction started on a machine running Oracle Tuxedo 8.0 or earlier software, except that when a machine running Oracle Tuxedo 8.1 or later software is infected by the transaction, the transaction timeout value is capped—reduced if necessary—to the
TA_MAXTRANTIME value configured for that machine.
Even if the TRANTIME value specified in the
SERVICES section of the
UBBCONFIG file is greater than the
TA_MAXTRANTIME value, the
tmloadcf(1) command loads the configuration without error. Any Oracle Tuxedo 8.1 or later machine infected with the
AUTOTRAN transaction will automatically reduce the transaction timeout to the
TA_MAXTRANTIME value configured for that machine.
All instances of system-supplied and application servers available to an application need to be accounted for in the bulletin board server table, which is a global table, meaning that the same server table resides on each machine in the application. Examples of system-supplied servers are AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS (see
T_GROUP:TA_TMSNAME attribute),
TMS_QM,
GWTDOMAIN, and
WSL.
Initial setting of the TP_COMMIT_CONTROL characteristic for all client and server processes in an Oracle Tuxedo system application.
LOGGED initializes the
TP_COMMIT_CONTROL characteristic to
TP_CMT_LOGGED; otherwise, it is initialized to
TP_CMT_COMPLETE. See the description of the Oracle Tuxedo System ATMI function
tpscmt() for details on the setting of this characteristic.
TA_NOTIFY:
“{
DIPIN |
SIGNAL |
THREAD |
IGNORE}
”
The value DIPIN specifies that dip-in-based notification detection should be used. This means that the system will detect notification messages only on behalf of a client process while within ATMI calls. The point of detection within any particular ATMI call is not defined by the system, and dip-in detection will not interrupt blocking system calls.
DIPIN is the default notification detection method.
The value SIGNAL specifies that signal-based notification detection should be used. This means that the system sends a signal to the target client process after the notification message has been made available. The system installs a signal-catching routine on behalf of clients selecting this method of notification.
The value THREAD specifies that
THREAD notification should be used. This means that the system dedicates a separate thread for the receipt of unsolicited messages and dispatches the unsolicited message handler in that thread. Only one unsolicited message handler executes at one time per Oracle Tuxedo application association. This value is allowed only on platforms that offer support for multithreading. COBOL clients cannot use
THREAD notification, and will default to
DIPIN if
THREAD is in effect.
The value IGNORE specifies that by default, notification messages are to be ignored by application clients. This would be appropriate in applications where only clients that request notification at
tpinit() time should receive unsolicited messages.
|
Note:
|
The SIGNAL notification method is not available for MS-DOS clients.
|
TA_OPTIONS:
“{[
LAN |
SSL|
MIGRATE |
ACCSTATS |
NO_XA |
NO_AA]
,*}
”
LAN—networked application.
SSL—initiates
SSL securitiy. If not entered,
LLE security is used.
MIGRATE—allow server group migration.
ACCSTATS—exact statistics (
SHM mode only).
NO_XA—do not allow XA transactions.
NO_AA—the auditing and authorization plugin functions will not be called.
TA_SECURITY:
“{
NONE |
APP_PW |
USER_AUTH |
ACL |
MANDATORY_ACL}
”
Type of application security. A 0-length string value or NONE for this attribute indicates that security is/will be turned off. The identifier
APP_PW indicates that application password security is to be enforced (clients must provide the application password during initialization). Setting this attribute requires a non-0 length
TA_PASSWORD attribute. The identifier
USER_AUTH is similar to
APP_PW but, in addition, indicates that per-user authentication will be done during client initialization. The identifier
ACL is similar to
USER_AUTH but, in addition, indicates that access control checks will be done on service names, queue names, and event names. If an associated
ACL is not found for a name, it is assumed that permission is granted. The identifier
MANDATORY_ACL is similar to
ACL but permission is denied if an associated
ACL is not found for the name.
|
Note:
|
If the NO_AA value is enabled in the TA_OPTIONS attribute, the security values NONE, APP_PW, and USER_AUTH will continue to work properly—except that no authorization or auditing will take place. The remaining modes of security, ACL and MANDATORY_ACL will continue to work properly—but will only use the default Oracle security mechanism.
|
Multiplier of the TA_SCANUNIT attribute indicating time between DBBL status checks on registered BBLs. The DBBL checks to ensure that all BBLs have reported in within the
TA_BBLQUERY cycle. If a BBL has not been heard from, the DBBL sends a message to that BBL asking for status. If no reply is received, the BBL is partitioned. Passing a value of 0 for this attribute on a
SET operation will cause the attribute to be reset to its default. This attribute value should be set to at least twice the value set for the
TA_SANITYSCAN attribute value (see below).
Multiplier of the TA_SCANUNIT attribute indicating the minimum amount of time a blocking ATMI call will block before timing out. Passing a value of 0 for this attribute on a
SET operation will cause the attribute to be reset to its default.
Multiplier of the TA_SCANUNIT attribute indicating maximum amount of time a DBBL should wait for replies from its BBLs before timing out. Passing a value of 0 for this attribute on a
SET operation will cause the attribute to be reset to its default.
Multiplier of the TA_SCANUNIT attribute indicating time between basic sanity checks of the system. Sanity checking includes client/server viability checks done by each BBL for clients/servers running on the local machine as well as BBL status check-ins (
MP mode only). Passing a value of 0 for this attribute on a
SET operation will cause the attribute to be reset to its default.
TA_SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. A principal name at a particular configuration level can be overridden at a lower level. If
TA_SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
TA_DOMAINID string for this domain.
Note that TA_SEC_PRINCIPAL_NAME is one of a trio of attributes, the other two being
TA_SEC_PRINCIPAL_LOCATION and
TA_SEC_PRINCIPAL_PASSVAR. The latter two attributes pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
TA_SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two attributes to a
NULL (zero length) string.
TA_SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
TA_SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
If set to “Y”, every process running in this domain requires a digital signature on its input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
SIGNATURE_REQUIRED to
“Y” at a particular level means that signatures are required for all processes running at that level or below.
If set to “Y”, every process running in this domain requires an encrypted input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
TA_ENCRYPTION_REQUIRED to
“Y” at a particular level means that encryption is required for all processes running at that level or below.
The T_FACTORY MIB class represents occurrences of factories registered with the FactoryFinder. The available factories for the application are reflected in this MIB and can be shown to the administrator via the Administration Console or command-line tools. The scope is global.
A GET operation will retrieve configuration and run-time information for the selected
T_FACTORY objects.
The following state indicates the meaning of a
TA_STATE returned in response to a
GET request:
|
|
The T_FACTORY object is registered with the FactoryFinder.
|
The T_GROUP class represents application attributes pertaining to a particular server group. These attribute values represent group identification, location, and DTP information.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SET: “{ NEW | INV | ACT | RAC |INA | MIG} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
Primary machine logical machine identifier for this server group (LMID1) and optional secondary logical machine identifier (
LMID2). The secondary LMID indicates the machine to which the server group can be migrated (if the
MIGRATE option is specified in the
T_DOMAIN:
TA_OPTIONS attribute). A single LMID specified on a GET operation will match either the primary or secondary LMID. Note that the location of an active group is available in the
TA_CURLMID attribute. Logical machine identifiers specified with the
TA_LMID attribute must be already configured. Limitation: Modifications to this attribute for an active object may only change the backup LMID designation for the group.
GET:
“{
ACTive |
INActive |
MIGrating}
”
A GET operation will retrieve configuration and run-time information for the selected
T_GROUP object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_GROUP object defined and active (TMS and/or application servers). Server groups with non NULL strings for the TA_TMSNAME attribute are considered active if the TMSs associated with the group are active. Otherwise, a group is considered active if any server in the group is active.
|
|
|
T_GROUP object defined and inactive.
|
|
|
T_GROUP object defined and currently in a state of migration to the secondary logical machine. The secondary logical machine is the one listed in TA_LMID that does not match TA_CURLMID. This state is ACTive equivalent for the purpose of determining permissions.
|
SET:
“{
NEW |
INValid |
ACTive |
ReACtivate |
INActive |
MIGrating}
”
A SET operation will update configuration and run-time information for the selected
T_GROUP object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_GROUP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.
|
|
|
Modify an existing T_GROUP object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.
|
|
|
Delete T_GROUP object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
Activate the T_GROUP object. State change allowed only when in the INActive or MIGrating state. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x).
If the group is currently in the INActive state, TMS and application servers (subject to restriction by TA_FLAGS settings) are started on the primary logical machine if the primary logical machine is active; otherwise, the TMS and application servers are started on the secondary logical machine if it is active. If neither machine is active, the request fails.
If the group is currently in the MIGrating state, the active secondary logical machine (identified as the alternate to TA_CURLMID in the TA_LMID list) is used to start TMS and application servers if it is active. Otherwise, the request fails. The TMIB_NOTIFY TA_FLAG value should be used when activating a server group if status on individual servers is required.
|
|
|
Identical to a transition to the ACTive state except that this state change is also allowed in the ACTive state in addition to being allowed in the INActive and MIGrating states.
The TMIB_NOTIFY TA_FLAG value should be used when reactivating a server group if status on individual servers is required.
|
|
|
Deactivate the T_GROUP object. TMS and application servers (subject to restriction by TA_FLAGS settings) are deactivated. State change allowed only when in the ACTive or MIGrating state. Successful return leaves the object in the INActive state.
The TMIB_NOTIFY TA_FLAG value should be used when deactivating a server group if status on individual servers is required.
|
|
|
Deactivate the T_GROUP object on its active primary logical machine ( TA_CURLMID) and prepare the group to be migrated to the secondary logical machine. State change allowed only when in the ACTive state. Successful return leaves the object in the MIGrating state.
|
|
|
Suspend all application services in the group. (Note: Individual services can be suspended through the T_SVCGROUP class.) A SET operation to this state is allowed only when the group is in the ACTive state. The operation leaves the group in the ACTive state, but with all its application services in a suspended state. Limitation: Operation will fail in a mixed-release application where any pre-release 6.4 machine is active.
|
|
|
Unsuspend all application services in the group marked as suspended. A SET operation to this state value is allowed only when the group is in the ACTive state. The operation leaves the group in the ACTive state.
|
TA_ENVFILE:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
PATH is set in the environment to:
where path is the value of the first
PATH= line in the machine environment file, if one exists (subsequent
PATH= lines is ignored). This
PATH is used as a search path for servers that are specified with a simple or relative pathname (that is, one that does not begin with slash).
where lib is the value of the first
LD_LIBRARY_PATH= line appearing in the machine environment file, if one exists (subsequent
LD_LIBRARY_PATH= lines are ignored).
As part of server initialization (before tpsvrinit(3c) is called), a server reads and exports variables from both the machine and server
ENVFILE files. If a variable is set in both the machine and server
ENVFILE, the value in the server
ENVFILE will override the value in the machine
ENVFILE with the exception of
PATH which is appended. A client processes only the machine
ENVFILE file. When the machine and server
ENVFILE files are processed, lines that are not of the form
ident= is ignored, where
ident contains only underscore or alphanumeric characters.
If a PATH= line is encountered,
PATH is set to:
where path is the value of the first
PATH= line appearing in the environment file (subsequent
PATH= lines are ignored). If
PATH appears in both the machine and server files,
path is defined as
path1:path2, where
path1 is from the machine
ENVFILE, and
path2 is from the server
ENVFILE. If a
LD_LIBRARY_PATH= line is encountered,
LD_LIBRARY_PATH is set to:
where lib is the value of the first
LD_LIBRARY_PATH= line appearing in the environment file (subsequent
LD_LIBRARY_PATH= lines are ignored). Attempts to reset
TUXDIR,
APPDIR, or
TUXCONFIG are ignored and a warning is displayed if the value does not match the corresponding
T_GROUP attribute value.
|
•
|
On Windows box, by convention, a network PATH contains no drive letters. With that in mind, if PATH set is started by only one backslash character (for example, " \pathToSet"), one more backslash would be automatically generated afterwards at startup to match UNC (Windows Network) Path syntax.
|
If a non NULL string other than
TMS is specified for the
TA_TMSNAME attribute, the
TA_OPENINFO attribute value provides the resource manager dependent information needed when initiating access to the resource manager. Otherwise, the
TA_OPENINFO attribute value is ignored.
A NULL string value for the
TA_OPENINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to
open access to the resource.
The format of the TA_OPENINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (
:).
where TUXEDO/QM is the published name of the Oracle Tuxedo /Q XA interface,
qmconfig is replaced with the name of the
QMCONFIG (see
qmadmin(1)) on which the queue space resides, and
qspace is replaced with the name of the queue space. For Windows, the separator after
qmconfig must be a semicolon (
;).
If a non NULL string other than
TMS is specified for the
TA_TMSNAME attribute, the
TA_CLOSEINFO attribute value provides the resource manager-dependent information needed when terminating access to the resource manager. Otherwise, the
TA_CLOSEINFO attribute value is ignored.
A NULL string value for the
TA_CLOSEINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to
close access to the resource.
The format of the TA_CLOSEINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (
:).
If a non NULL string is specified for the
TA_TMSNAME attribute, the
TA_TMSCOUNT attribute value indicates the number of transaction manager servers to start for the associated group. Otherwise, this attribute value is ignored. It is recommended to set
TA_TMSCOUNT to less than
11 to save resources.
TA_TMSNAME:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Transaction manager server a.out associated with this group. This attribute must be specified for any group entry whose servers will participate in distributed transactions (transactions across multiple resource managers and possibly machines that are started with
tpbegin(), and ended with
tpcommit()/
tpabort()).
The value TMS is reserved to indicate use of the
NULL XA interface. If a non-empty value other than
TMS is specified, a
TLOGDEVICE must be specified for the machine(s) associated with the primary and secondary logical machines for this object.
TA_SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. A principal name at a particular configuration level can be overridden at a lower level. If
TA_SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
TA_DOMAINID string for this domain.
Note that TA_SEC_PRINCIPAL_NAME is one of a trio of attributes, the other two being
TA_SEC_PRINCIPAL_LOCATION and
TA_SEC_PRINCIPAL_PASSVAR. The latter two attributes pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
TA_SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two attributes to a
NULL (zero length) string.
TA_SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
TA_SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
If set to “Y”, every process running in this group requires a digital signature on its input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
SIGNATURE_REQUIRED to
“Y” at a particular level means that signatures are required for all processes running at that level or below.
If set to “Y”, every process running in this group requires an encrypted input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
TA_ENCRYPTION_REQUIRED to
“Y” at a particular level means that encryption is required for all processes running at that level or below.
The T_RMS class represents application attributes pertaining to all the DTP information in one server group that support multiple RMS.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SET: “{ NEW | INV | ACT | RAC |INA} ”
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
GET: "
{ACTive | INActive}"
A GET operation will retrieve configuration and run-time information for the selected
T_RMS object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_RMS object defined and active (TMS). If the TA_TMSNAME is not NULL, this object is considered active if the TMSs associated are active.
|
|
|
T_RMS object defined and inactive.
|
A SET operation will update configuration and run-time information for the selected
T_ RMS object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_ RMS object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.
|
|
|
Modify an existing T_ RMS object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.
|
|
|
Delete T_RMS object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
Activate the T_RMS object. State change allowed only when in the INActive state. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x).
|
|
|
The TMIB_NOTIFY TA_FLAG value should be used when reactivating a server group if status on individual servers is required.
|
|
|
Deactivate the T_RMS object. TMSs are deactivated. State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state.
The TMIB_NOTIFY TA_FLAG value should be used when deactivating a server group if status on individual servers is required.
|
Name of the T_RMS object. This name must be unique within all objects in the
T_RMS class. And it cannot contain an asterisk (*), comma, or colon.
If a non NULL string is specified for the TA_TMSNAME attribute, the
TA_TMSCOUNT attribute value indicates the number of transaction manager servers to start for the associated group. Otherwise, this attribute value is ignored. It is recommended to set
TA_TMSCOUNT to less than
11 to save resources.
If a non NULL string other than TMS is specified for the
TA_TMSNAME attribute, the
TA_OPENINFO attribute value provides the resource manager dependent information needed when initiating access to the resource manager. Otherwise, the
TA_OPENINFO attribute value is ignored. A NULL string value for the
TA_OPENINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to open access to the resource. The format of the
TA_OPENINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor transaction (XA) interface followed immediately by a colon (:). For Oracle Tuxedo /Q databases, the format is:
where TUXEDO/QM is the published name of the Oracle Tuxedo /Q XA interface, qmconfig is replaced with the name of the QMCONFIG (see qmadmin(1)) on which the queue space resides, and qspace is replaced with the name of the queue space. For Windows, the separator after qmconfig must be a semicolon (;). For other vendor databases, the format of the
TA_OPENINFO string is specific to the particular vendor providing the underlying resource manager.
If a non NULL string other than TMS is specified for the TA_TMSNAME attribute, the
TA_CLOSEINFO attribute value provides the resource manager-dependent information needed when terminating access to the resource manager. Otherwise, the
TA_CLOSEINFO attribute value is ignored. A NULL string value for the
TA_CLOSEINFO attribute means that the resource manager for this group (if specified) does not require any application specific information to close access to the resource. The format of the
TA_CLOSEINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor transaction (XA) interface followed immediately by a colon
(:). Limitation: Run-time modifications to this attribute will not affect active servers in the group.
If TA_RMAUTO=Y is specified, the connection to the RM is established via
tpopen() when the servers are booted up. When a client calls the service (which is monitored by TMS), the corresponding RM
xa_start is invoked automatically. If
TA_RMAUTO=N is specified, you must invoke
tprmopen and
tmrmstart explicitly in their application servers. The default is
Y. If the
TA_TMSNAME parameter is set to
NULL, this item is ignored. The number of the
T_RMS objects which belong to the same server group with
AUTO=Y must between
0 and
15 inclusive.
The T_IFQUEUE MIB class represents run-time attributes of an interface as it pertains to a particular server queue (
T_QUEUE) in a CORBA environment. This is primarily a read-only class providing access to the inherited configuration attributes of an interface as well as statistics relating to the interface on the queue. Additionally, this class gives administrators finer granularity in suspending and activating interfaces. This class provides the link between an interface name and the server processes capable of processing method invocations on the interface, that is,
TA_RQADDR can be used as a key search field on the
T_SERVER class.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | SUS | PAR} ”
SET: “{ ACT | SUS} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ method | transaction | process} ”
|
|
|
|
|
|
|
“{ always | never | optional | ignore} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k ) - GET key field ( l ) - local Field ( * ) - GET/ SET key, one or more required for SET operations
|
|
GET: “{
ACTive |
SUSpended |
PARtitioned}
”
A GET operation will retrieve configuration information for the selected
T_IFQUEUE objects. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request. States not listed will not be returned.
|
|
T_IFQUEUE object represents an available interface in the running system.
|
|
|
T_IFQUEUE object represents a currently suspended interface in the running system.
|
|
|
T_IFQUEUE object represents a currently partitioned interface in the running system.
|
SET: “{
ACTive |
SUSpended}
”
|
|
Activate the T_IFQUEUE object. State change only allowed when in the SUSpended state. Successful return leaves object in ACTive state.
|
|
|
Suspend the T_IFQUEUE object. State change only allowed when in the ACTive state. Successful return leaves object in SUSpended state.
|
This T_INTERFACE object imposes the indicated load on the system. Interface loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request.
This T_INTERFACE object has the indicated dequeuing priority. If multiple interface requests are waiting on a queue for servicing, the higher priority requests will be handled first.
The T_INTERFACE MIB class represents configuration and run-time attributes of CORBA interfaces at both the domain and server group levels.
A domain-level T_INTERFACE object is one that is not associated with a Server Group. Its
TA_SRVGRP attribute contains a
NULL string (string of length 0, "").
A server group level T_INTERFACE object is one that has an associated server group (i.e., its
TA_SRVGRP attribute contains a valid server group name for the domain). This Server Group level representation of an interface also provides a container for managing interface state (
TA_STATE) and for collecting accumulated statistics.
An associated server group level T_INTERFACE object must exist for any CORBA Interfaces that are activated in a server. The activation of interfaces in a server is controlled by the state of a
T_IFQUEUE object for the interface. Activation of a
T_IFQUEUE object causes its attributes to be initialized with the values specified for the associated server group level
T_INTERFACE object. If such an object does not exist, one will be dynamically created. This dynamically-created server group level
T_INTERFACE object will be initialized with the attributes of the domain level
T_INTERFACE object for the interface if one exists. If an associated domain level
T_INTERFACE object does not exist, system specified default configuration values will be applied. Once activated, interfaces are always associated with a server group level
T_INTERFACE object.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | INA | SUS | PAR} ”
SET: “{ NEW | INV | ACT | REA | SUS} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ method | transaction | process} ”
|
|
|
|
|
|
|
“{ always | never | optional | ignore} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( k ) - GET key field ( l ) - local Field ( r ) - required field for object creation ( SET TA_STATE NEW) ( * ) - GET/ SET key, one or more required for SET operations
|
Following are the semantics for GET and
SET TA_STATE values on the
T_INTERFACE class. Where semantics differ between group and domain level objects, those differences are noted.
GET: “{
ACTive |
INActive |
SUSpended |
PARtitioned}
”
A GET operation will retrieve configuration information for the selected
T_INTERFACE objects. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request. States not listed will not be returned.
|
|
T_INTERFACE object is defined and at least one corresponding T_IFQUEUE entry is in the ACTive state.
Note: For a group level T_INTERFACE object, corresponding T_IFQUEUE entries are those with matching TA_INTERFACENAME and TA_SRVGRP attributes. For a domain level T_INTERFACE object, corresponding T_IFQUEUE entries are those with matching TA_INTERFACENAME attributes regardless of their TA_SRVGRP value.
|
|
|
T_INTERFACE object is defined and there are no corresponding T_IFQUEUE entries in any ACTive equivalent state.
|
|
|
T_INTERFACE object is defined and amongst all corresponding T_IFQUEUE entries there are none in the ACTive state and at least one in the SUSpended state. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_INTERFACE object is defined and amongst all corresponding T_IFQUEUE entries there are:
|
3.
|
At least one in the PARtitioned state. This state is ACTive equivalent for the purpose of determining permissions.
|
|
SET: “{
NEW |
INValid |
ACTive |
REActivate |
SUSpended}
”
A SET operation will update configuration and run-time information for the selected
T_INTERFACE object. Note that modifications may affect more than one server group when making domain level changes and run-time modifications may affect more than one server if multiple servers are currently offering an interface. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_INTERFACE object for application. State change only allowed when in the INValid state. Successful return leaves object in INActive state. Creation of a domain level T_INTERFACE object will affect existing group level objects with the same TA_INTERFACENAME value by resetting all TA_FBROUTINGNAME values if a new value is explicitly specified. All other configuration attribute settings will not affect existing group level T_INTERFACE objects.
|
|
|
Delete T_INTERFACE object for application. State change only allowed when in the INActive state. Successful return leaves object in INValid state.
|
|
|
Activate the T_INTERFACE object. Setting this state on the domain level object has the effect of activating all corresponding T_IFQUEUE entries that are currently SUSpended throughout the domain. Setting this state on the group level object will affect only servers within the group offering the interface. State change only allowed when in the SUSpended state. Successful return leaves object in ACTive state.
|
|
|
Reactivate the T_INTERFACE object. Setting this state on the domain level object has the effect of activating all corresponding T_IFQUEUE entries that are currently SUSpended throughout the domain. Setting this state on the group level object will affect only servers within the group offering the interface. State change only allowed when in the ACTive or SUSpended states. Successful return leaves object in ACTive state. This state permits global activation of T_IFQUEUE entries suspended at the group level without having to individually activate each group level T_INTERFACE object.
|
|
|
Suspend the T_INTERFACE object. Setting this state on the domain level object has the effect of suspending all corresponding T_IFQUEUE entries that are currently ACTive throughout the domain. Setting this state on the group level object will affect only servers within the group offering the interface. State change only allowed when in the ACTive state. Successful return leaves object in SUSpended state.
|
|
|
A value of N will have no effect at run time. Behavior will be as though the setting was Y.
|
|
|
A value of Y will have no effect at run time. The interface will never be involved in a transaction.
|
|
|
A value of Y will have no effect at run time. The interface will never be involved in a transaction.
|
This T_INTERFACE object imposes the indicated load on the system. Interface loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request.
This T_INTERFACE object has the indicated dequeuing priority. If multiple interface requests are waiting on a queue for servicing, the higher priority requests will be handled first.
Note: Updating this value at run-time for domain level objects should cause a warning, since the only use would be to set the default for a subsequent boot of the application.
Current logical machine with which the active equivalent group level T_INTERFACE object is associated. This attribute is blank, i.e., "" for domain level objects unless a local query is performed, i.e.,
TA_FLAGS has the
MIB_LOCAL bit set. In the local case, multiple domain level objects will be returned for the same interface, one per machine, with the local values retrieved from each machine represented in the separate objects.
The T_INTERFACE MIB is a mapping from an interface to an Oracle Tuxedo service. The MIB server can implement some of the get/set operations for an interface by calling the existing logic for the associated
T_SERVICE object.
The T_MACHINE class represents application attributes pertaining to a particular machine. These attribute values represent machine characteristics, per-machine sizing, statistics, customization options, and UNIX system filenames.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SET: “{ NEW | INV | ACT | RAC | INA | FIN | CLE} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ MASTER | BACKUP | OTHER} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
T_MACHINE Class: LOCAL Attributes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
TA_TUXCONFIG:
string[2..256] (up to 64 bytes for Oracle Tuxedo 8.0 or earlier)
TA_TUXDIR:
string[2..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
TA_APPDIR:
string[2..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
GET:
“{
ACTive |
INActive |
PARtitioned}
”
A GET operation will retrieve configuration and run-time information for the selected
T_MACHINE object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_MACHINE object defined and active (administrative servers, that is, DBBL, BBL, and Bridge).
|
|
|
T_MACHINE object defined and inactive.
|
|
|
T_MACHINE object defined, listed in accessible bulletin boards as active, but currently unreachable. This state is ACTive equivalent for the purpose of determining permissions.
|
SET:
“{
NEW |
INValid |
ACTive |
ReACtivate |
INActive |
ForceINactive |
CLEaning}
”
A SET operation will update configuration and run-time information for the selected
T_MACHINE object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_MACHINE object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.
|
|
|
Modify an existing T_MACHINE object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.
|
|
|
Delete T_MACHINE object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
Activate the T_MACHINE object. Necessary administrative servers such as the DBBL, BBL, and Bridge are started on the indicated site as well as application servers configured to run on that site (subject to restriction by TA_FLAGS settings). For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). State change allowed only when in the INActive state. Successful return leaves the object in the ACTive state.
The TMIB_NOTIFY TA_FLAG value should be used when activating a machine if status on individual servers is required.
|
|
|
Activate the T_MACHINE object. Necessary administrative servers such as the DBBL, BBL, and Bridge are started on the indicated site as well as application servers configured to run on that site (subject to restriction by TA_FLAGS settings). For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). State change allowed only when in either the ACTive or INActive state. Successful return leaves the object in the ACTive state.
The TMIB_NOTIFY TA_FLAG value should be used when reactivating a machine if status on individual servers is required.
|
|
|
Deactivate the T_MACHINE object. Necessary administrative servers such as the BBL and Bridge are stopped on the indicated site as well as application servers running on that site (subject to restriction by TA_FLAGS settings). State change allowed only when in the ACTive state and when no other application resources are active on the indicated machine. Successful return leaves the object in the INActive state.
The TMIB_NOTIFY TA_FLAG value should be used when deactivating a machine if status on individual servers is required.
|
|
|
Deactivate the T_MACHINE object without regard to attached clients. Necessary administrative servers such as the BBL and Bridge are stopped on the indicated site as well as application servers running on that site (subject to restriction by TA_FLAGS settings). State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state.
The TMIB_NOTIFY TA_FLAG value should be used when deactivating a machine if status on individual servers is required.
|
|
|
Initiate cleanup/scanning activities on and relating to the indicated machine. If there are dead clients or servers on the machine, they will be detected at this time. If the machine has been partitioned from the application MASTER site, global bulletin board entries for that machine will be removed. This combination is allowed when the application is in the ACTive state and the T_MACHINE object is in either the ACTive or PARtitioned state. Successful return for a non-partitioned machine leaves the state unchanged. Successful return for a partitioned machine leaves the object in the INActive state.
|
Limitation: State change to ForceINactive or
INActive allowed only for non-master machines. The master site administrative processes are deactivated via the
T_DOMAIN class.
TA_ENVFILE:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
where path is the value of the first
PATH= line appearing in the machine environment file, if one exists (subsequent
PATH= lines will be ignored). This
PATH will be used as a search path for servers that are specified with a simple or relative pathname (that is, that doesn't begin with slash).
LD_LIBRARY_PATH will be set in the environment to:
where lib is the value of the first
LD_LIBRARY_PATH= line appearing in the machine environment file, if one exists (subsequent
LD_LIBRARY_PATH= lines will be ignored).
As part of server initialization (before tpsvrinit() is called), a server will read and export variables from both the machine and server
ENVFILE files. If a variable is set in both the machine and server
ENVFILE, the value in the server
ENVFILE will override the value in the machine
ENVFILE with the exception of
PATH which is appended. A client will process only the machine
ENVFILE file. When the machine and server
ENVFILE files are processed, lines that are not of the form
ident= will be ignored, where
ident begins with an underscore or alphabetic character, and contains only underscore or alphanumeric characters. If a
PATH= line is encountered,
PATH will be set to:
where path is the value of the first
PATH= line appearing in the environment file (subsequent
PATH= lines are ignored). If
PATH appears in both the machine and server files,
path is
path1:path2, where
path1 is from the machine
ENVFILE, and
path2 is from the server
ENVFILE. If a
LD_LIBRARY_PATH= line is encountered,
LD_LIBRARY_PATH will be set to:
where lib is the value of the first
LD_LIBRARY_PATH= line appearing in the environment file (subsequent
LD_LIBRARY_PATH= lines are ignored). Attempts to reset
TUXDIR,
APPDIR, or
TUXCONFIG will be ignored and a warning will be printed if the value does not match the corresponding
T_MACHINE attribute value.
|
•
|
On Windows box, by convention, a network PATH contains no drive letters. With that in mind, if PATH set is started by only one backslash character (for example, " \pathToSet"), one more backslash would be automatically generated afterwards at startup to match UNC (Windows Network) Path syntax.
|
TA_ULOGPFX:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Absolute pathname prefix of the path for the userlog() file on this machine. The
userlog() filename is formed by appending the string
.mmddyy to the
TA_ULOGPFX attribute value.
mmddyy represents the month, day, and year that the messages were generated. All application and system
userlog() messages generated by clients and servers running on this machine are directed to this file.
System administration processes, such as the BBL, restartsrv,
cleanupsrv,
tmshutdown(), and
tmadmin(), need not be accounted for in this value, but the DBBL, all bridge processes, all system-supplied and application server processes, and all potential client processes at this site need to be counted. (Examples of system-supplied servers are
AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS—see
T_GROUP TA_TMSNAME attribute,
TMS_QM,
GWTDOMAIN, and
WSL.) If the application is booting workstation listeners (WSLs) on this site, both the WSLs and the number of potential workstation handlers (WSHs) that may be booted need to be counted.
Note that for Oracle Tuxedo pre-release 7.1 (6.5 or earlier), both the TA_MAXACCESSERS and
TA_MAXSERVERS (see
T_DOMAIN:
TA_MAXSERVERS attribute) attributes for an application play a part in the user license checking scheme. Specifically, a machine is not allowed to boot if the number of
TA_MAXACCESSERS for that machine + the number of
TA_MAXACCESSERS for the machine (or machines) already running in the application is greater than the number of
TA_MAXSERVERS + user licenses for the application. Thus, the total number of
TA_MAXACCESSERS for an application must be less than or equal to the number of
TA_MAXSERVERS + user licenses for the application.
The TA_MAXWSCLIENTS attribute is only used when the Oracle Tuxedo system Workstation feature is used. The appropriate setting of this attribute helps to conserve interprocess communication (IPC) resources since Workstation client access to the system is multiplexed through an Oracle Tuxedo system-supplied surrogate, the workstation handler (WSH).
TA_TLOGDEVICE:
string[0..256] (up to 64 bytes for Oracle Tuxedo 8.0 or earlier)
Setting TA_BRTHREADS to
“Y” makes sense only if a machine has multiple CPUs. However, having multiple CPUs is not a prerequisite for setting
TA_BRTHREADS to
“Y”.
Configurations with TA_BRTHREADS set to
“Y” on the local machine and
TA_BRTHREADS set (or defaulted) to
“N” on the remote machine are allowed, but the throughput between the machines will not be greater than that for the single-threaded Bridge process.
|
Note:
|
If BRTHREADS=Y and the Bridge environment contains TMNOTHREADS=Y, the Bridge starts up in threaded mode and logs a warning message to the effect that the Bridge is ignoring the TMNOTHREADS setting. The TMNOTHREADS environment variable was added to the Oracle Tuxedo product in release 8.0.
|
TA_NADDR:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
If string has the form
“0xhex-digits” or
“\\xhex-digits”, it must contain an even number of valid hex digits. These forms are translated internally into a character array containing the hexadecimal representations of the string specified.
Table 55 lists the IPv4 and IPv6 address formats.
TA_NLSADDR:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Network address used by the tlisten(1) process servicing the network on the node identified by this logical machine. This network address is of the same format as that specified for the
TA_NADDR attribute above.
TA_FADDR: string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the complete network address to which local processes such as tmboot,
tmloadcf, and Bridge can bind before making an outbound connection. This address must be a TCP/IP address. This attribute, along with the
TA_FRANGE attribute, determines the range of TCP/IP ports to which a process attempts to bind before making an outbound connection. If this attribute is set to the
NULL or empty string, the operating system randomly chooses a local port with which to bind.
If string has the form
“0xhex-digits”, it must contain an even number of valid hex digits. These forms are translated internally into a character array containing the hexadecimal representations of the string specified.
Threshold message size at which compression will occur for remote traffic and optionally
local traffic.
remote and
local may be either non-negative numeric values or the string
MAXLONG, which is dynamically translated to the maximum long setting for the machine. Setting only the
remote value will default
local to
MAXLONG.
Limitation: This attribute value is not part of the T_MACHINE object for active sites running Oracle Tuxedo system release 4.2.2 or earlier. However, site release identification is not determined until run time, so this attribute may be set and accessed for any inactive object. When an Oracle Tuxedo release 4.2.2 or earlier site is activated, the configured value is not used.
Limitation: This attribute value is not part of the T_MACHINE object for active sites running Oracle Tuxedo release 4.2.2 or earlier. However, site release identification is not determined until run time, so this attribute may be set and accessed for any inactive object. When an Oracle Tuxedo release 4.2.2 or earlier site is activated, the configured value is not used.
Limitation: This attribute value is not part of the T_MACHINE object for active sites running Oracle Tuxedo release 4.2.2 or earlier. However, site release identification is not determined until run time, so this attribute may be set and accessed for any inactive object. When an Oracle Tuxedo release 4.2.2 or earlier site is activated, the configured value is not used.
TA_ROLE:
“{
MASTER |
BACKUP |
OTHER}
”
The role of this machine in the application. “MASTER” indicates that this machine is the master machine,
“BACKUP” indicates that it is the backup master machine, and
“OTHER” indicates that the machine is neither the master nor backup master machine.
TA_SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. A principal name at a particular configuration level can be overridden at a lower level. If
TA_SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
TA_DOMAINID string for this domain.
Note that TA_SEC_PRINCIPAL_NAME is one of a trio of attributes, the other two being
TA_SEC_PRINCIPAL_LOCATION and
TA_SEC_PRINCIPAL_PASSVAR. The latter two attributes pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
TA_SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two attributes to a
NULL (zero length) string.
TA_SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
TA_SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
If set to “Y”, every process running on this machine requires a digital signature on its input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
SIGNATURE_REQUIRED to
Y at a particular level means that signatures are required for all processes running at that level or below.
If set to “Y”, every process running on this machine requires an encrypted input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
TA_ENCRYPTION_REQUIRED to
“Y” at a particular level means that encryption is required for all processes running at that level or below.
Number of tpconnect() operations performed from this machine.
Number of tpdequeue() operations performed from this machine.
Number of tpenqueue() operations performed from this machine.
Number of tppost() operations performed from this machine.
Number of tpacall() or
tpcall() operations performed from this machine.
Number of tpsubscribe() operations performed from this machine.
SHM mode (see
T_DOMAIN:
TA_MODEL attribute) applications can have only one
T_MACHINE object.
MP mode (see
T_DOMAIN:
TA_MODEL attribute) applications with the
LAN option set (see
T_DOMAIN:
TA_OPTIONS attribute) may have up to the maximum number of configurable
T_MACHINE objects as defined by the
T_DOMAIN:
TA_MAXMACHINES attribute. Many attributes of this class are tunable only when the application is inactive on the site. Since the master machine must at least be active in a minimally active application, the use of the ATMI interface routines to administer the application is not possible with respect to the master machine object. The function
tpadmcall() is being provided as a means configuring an unbooted application and may be used to set these attributes for the master machine.
The T_MSG class represents run-time attributes of the Oracle Tuxedo system managed UNIX system message queues.
A GET operation will retrieve run-time information for the selected
T_MSG object(s). The following state indicates the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_MSG object active. This corresponds exactly to the related T_MACHINE object being active.
|
SET operations are not permitted on this class.
The T_NETGROUP class represents application attributes of network groups. Network groups are groups of LMIDs which can communicate over the
TA_NADDR network addresses defined in the
T_NETMAP class.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
A GET operation will retrieve configuration information for the selected
T_NETGROUP object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_NETGROUP object is defined and inactive. Note that this is the only valid state for this class. NETGROUPs are never ACTive.
|
a SET operation will update configuration information for the selected
T_NETGROUP object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_NETGROUP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_NETGROUP object. Only allowed in the VALid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_NETGROUP object from application. State change allowed only when in the VALid state and only if there are no objects in the T_NETMAP class which have this network group object as a key. Successful return leaves the object in the INValid state.
|
The T_NETMAP class associates
TA_LMIDs from the
T_MACHINE class in the
TM_MIB to a
TA_NETGROUP object from the
T_NETGROUP class. In other words, this class contains assignments of logical machines to network groups. A
TA_LMID may be included in many
TA_NETGROUP groups. When one LMID connects to another LMID, the Bridge process determines the subset of network groups to which the two LMIDs belong. When the pair of LMIDs are in several common groups, they are sorted in descending
TA_NETPRIO order (
TA_NETGRPNO is the secondary sort key). The Network groups with the same
TA_NETPRIO will flow network data in parallel. Should a networking error prevent data from flowing through all the highest priority group(s), only then the next lower priority network group(s) are used for network traffic (
failover). All network groups with a higher priority than the ones flowing data are retried periodically. Once a network connection is established with a higher
TA_NETPRIO value, no further data is scheduled for the lower priority one. Once the lower priority connection is drained, it is disconnected in an orderly fashion (
failback).
A GET operation will retrieve run-time information for the selected
T_NETMAP object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_NETMAP object is defined. Note that this is the only valid state for this class. Network mappings are never ACTive.
|
A SET operation will update configuration information for the selected
T_NETMAP object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed cannot be set.
|
|
Create T_NETMAP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_NETMAP object. Successful return leaves the object state unchanged.
|
|
|
|
TA_NADDR:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
If string has the form
“0xhex-digits”, it must contain an even number of valid hex digits. These forms are translated internally into a character array containing the hexadecimal representations of the string specified.
TA_FADDR: string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the complete network address to which local processes such as tmboot,
tmloadcf, and Bridge and can bind before making an outbound connection. This address must be a TCP/IP address. This attribute, along with the
TA_FRANGE attribute, determines the range of TCP/IP ports to which a process attempts to bind before making an outbound connection. If this attribute is set to the
NULL or empty string, the operating system randomly chooses a local port with which to bind.
If string has the form
“0xhex-digits”, it must contain an even number of valid hex digits. These forms are translated internally into a character array containing the hexadecimal representations of the string specified.
When 128-bit encryption is licensed, TA_MAXENCRYPTBITS defaults to
128. When 56-bit encryption is licensed, the default is
56. When no encryption is licensed, the default is
0 bits. Note that when Bridge processes connect, they negotiate to the highest common
TA_MAXENCRYPTBITS.
The T_QUEUE class represents run-time attributes of queues in an application. These attribute values identify and characterize allocated Oracle Tuxedo system request queues associated with servers in a running application. They also track statistics related to application workloads associated with each queue object.
Note that when a GET operation with the
MIB_LOCAL flag is performed in a multi-machine application, multiple objects will be returned for each active queue—one object for each logical machine where local attribute values are collected.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | MIG | SUS | PAR} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
T_QUEUE Class:LOCAL Attributes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
GET:
“{
ACTive |
MIGrating |
SUSpended |
PARtitioned}
”
A GET operation will retrieve run-time information for the selected
T_QUEUE object(s). The
T_QUEUE class does not address configuration information directly. Configuration related attributes discussed here must be set as part of the related
T_SERVER objects. The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
|
|
|
The server(s) associated with this T_QUEUE object is currently in the MIGrating state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
The server(s) associated with this T_QUEUE object is currently in the SUSpended state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
The server(s) associated with this T_QUEUE object is currently in the PARtitioned state. See the T_SERVER class for more details on this state. This state is ACTive equivalent for the purpose of determining permissions.
|
A SET operation will update run-time information for the selected
T_QUEUE object. State changes are not allowed when updating
T_QUEUE object information. Modification of an existing
T_QUEUE object is allowed only when the object is in the
ACTive state.
The period of time, in seconds, over which the T_QUEUE:
TA_MAXGEN limit applies. This attribute is meaningful only for restartable servers, that is, if the
T_QUEUE:
TA_RESTART attribute is set to "
Y". A value of 0 for this attribute indicates that a server should always be restarted.
TA_RCMD:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Limitation: If the T_DOMAIN:
TA_LDBAL attribute is "
N" or the
T_DOMAIN:
TA_MODEL attribute is "
MP",
TA_TOTNQUEUED is not returned. In the same configuration, updates to this attribute are ignored. Consequently, when this attribute is returned
TA_LMID and
TA_SOURCE have the same value.
Limitation: If the T_DOMAIN:
TA_LDBAL attribute is "
N" or the
T_DOMAIN:
TA_MODEL attribute is "
MP",
TA_TOTWKQUEUED is not returned. In the same configuration, updates to this attribute are ignored. Consequently, when this attribute is returned
TA_LMID and
TA_SOURCE have the same value.
Limitation: If the T_DOMAIN:
TA_LDBAL attribute is
“N” or the
T_DOMAIN:
TA_MODEL attribute is
“MP”,
TA_NQUEUED is not returned. Consequently, when this attribute is returned
TA_LMID and
TA_SOURCE have the same value.
Workload currently enqueued to this queue from the TA_SOURCE logical machine. If the
T_DOMAIN:
TA_MODEL attribute is set to
SHM and the
T_DOMAIN:
TA_LDBAL attribute is set to "
Y", the
TA_WKQUEUED attribute reflects the application-wide workload enqueued to this queue. However, if
TA_MODEL is set to
MP and
TA_LDBAL is set to "
Y", this attribute reflects the workload enqueued to this queue from the
TA_SOURCE logical machine during a recent timespan. This attribute is used for load balancing purposes. So as to not discriminate against newly started servers, this attribute value is zeroed out on each machine periodically by the
BBL.
The T_ROUTING class represents configuration attributes of routing specifications for an application. These attribute values identify and characterize application data-dependent routing criteria with respect to field names, buffer types, and routing definitions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
string[1..254] if TA_TYPE=SERVICE
|
|
|
|
|
|
[char | short | long | float | double | string]
|
|
TA_FIELDTYPE(r)
(factory-based routing only)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
Specifies the routing type. The default is TYPE=SERVICE to ensure that existing
UBBCONFIG files used in ATMI environments continue to work properly. Use
TYPE=FACTORY if you are implementing factory-based routing for a CORBA interface.
TA_BUFTYPE: “type1[:
subtype1[,
subtype2 . . . ]][;
type2[:
subtype3[,. . .]]]
. . .
”
List of types and subtypes of data buffers for which this routing entry is valid. A maximum of 32 type/subtype combinations are allowed. The types are restricted to the following: FML,
FML32,
XML,
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON. No subtype can be specified for types
FML,
FML32, or
XML; subtypes are required for types
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON (“*” is not allowed). Note that subtype names should not contain semicolon, colon, comma, or asterisk characters. Duplicate type/subtype pairs cannot be specified for the same routing criteria name; more than one routing entry can have the same criteria name as long as the type/subtype pairs are unique. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.
The routing field name. When TA_TYPE=
FACTORY, this is assumed to be a field that is specified in an
NVList parameter to PortableServer::POA::create _reference_with_criteria for an interface that has this factory routing criteria associated with it. See section on factory-based routing for more details.
When TA_TYPE=SERVICE, the
TA_FIELD field is assumed to be an FML or FML32 buffer, XML buffer, view field name (character length 254) that is identified in an FML field table (using the environment variables
FLDTBLDIR and
FIELDTBLS or FLDTBLDIR32 and
FIELDTBLS32), or an FML view table (using the environment variables
VIEWDIR and
VIEWFILES or VIEWDIR32 and
VIEWFILES32), respectively. This information is used to get the associated field value for data-dependent routing while sending a message.
For an XML buffer type,
TA_FIELD contains either: a routing element type (or name) or a routing element attribute name.
“root_element[/
child_element][/
child_element][/. . .][/@
attribute_name]”
TA_FIELDTYPE:
“{
char |
short |
long |
float |
double |
string}
”
The type of the routing field specified in the TA_FIELD attribute. The type can be
char,
short,
long,
float,
double, or
string; only one type is allowed. This attribute is used only for routing XML buffers. The default type of the routing field is
string.
lower and
upper are signed numeric values or character strings in single quotes.
lower must be less than or equal to
upper. To embed a single quote in a character string value, it must be preceded by two backslashes (for example,
'O\\'Brien'). The value
MIN can be used to indicate the minimum value for the data type of the associated field on the machine. The value
MAX can be used to indicate the maximum value for the data type of the associated field on the machine. Thus,
“MIN--5” is all numbers less than or equal to -5, and
“6-MAX” is all numbers greater than or equal to 6.
The meta-character “*” (wildcard) in the position of a range indicates any values not covered by the other ranges previously seen in the entry; only one wildcard range is allowed per entry and it should be last (ranges following it will be ignored).
A GET operation will retrieve configuration information for the selected
T_ROUTING object(s). The following state indicates the meaning of a
TA_STATE returned in response to a
GET request. States not listed will not be returned.
|
|
T_ROUTING object is defined. Note that this is the only valid state for this class. Routing criteria are never ACTive; rather, they are associated through the configuration with service names and are acted upon at run-time to provide data-dependent routing. This state is INActive equivalent for the purpose of permissions checking.
|
A SET operation will update configuration information for the selected
T_ROUTING object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_ROUTING object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
|
|
|
Modify an existing T_ROUTING object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_ROUTING object for application. State change allowed only when in the VALid state. Successful return leaves the object in the INValid state.
|
Routing criteria type. Valid values are “FACTORY” or “
SERVICE”. “
FACTORY” specifies that the routing criteria applies to factory-based routing for a CORBA interface. The specification of
TYPE=FACTORY is mandatory for a factory-based routing criteria. “
SERVICE” specifies that the routing criteria applies to data-dependent routing for an ATMI service. Default is “
SERVICE”. Specification of this attribute is optional for data-dependent routing criteria. Note that the type specified affects the validity and possible values for other fields defined for this MIB class. These are noted for each field.
TA_TYPE is required for
SET operations for factory-based routing criteria.
The T_SERVER class represents configuration and run-time attributes of servers within an application. These attribute values identify and characterize configured servers as well as provide run-time tracking of statistics and resources associated with each server object. Information returned will always include fields that are common among all contexts of a server. In addition, for those servers that are not defined to the system as multicontexted (that is, those for which the value of
TA_MAXDISPATCHTHREADS is 1), this class includes information about the server’s context. For those servers that are defined to the system as multicontexted, placeholder values are reported for per-context attributes. Per-context attributes can always be found as part of the
T_SERVERCTXT class. The
T_SERVERCTXT class is defined even for single-contexted servers.
The TA_CLTLMID,
TA_CLTPID,
TA_CLTREPLY,
TA_CMTRET,
TA_CURCONV,
TA_CURREQ,
TA_CURRSERVICE,
TA_LASTGRP,
TA_SVCTIMEOUT,
TA_TIMELEFT, and
TA_TRANLEV attributes are specific to each server dispatch context. All other attributes are common to all server dispatch contexts.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | INA | MIG | CLE | RES | SUS | PAR | DEA} ”
|
|
SET: “{ NEW | INV | ACT | INA | DEA} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{“0”– “32767” | “DEFAULT”}
|
|
T_SERVER Class: LOCAL Attributes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
Name of the server executable file. The server identified by TA_SERVERNAME will run on the machine(s) identified by the
T_GROUP:
TA_LMID attribute for this server's server group. If a relative pathname is given, the search for the executable file is done first in
TA_APPDIR, then in
TA_TUXDIR/bin, then in
/bin and
/usr/bin, and then in
path, where
path is the value of the first
PATH= line appearing in the machine environment file, if one exists. Note that the attribute value returned for an active server will always be a full pathname. The values for
TA_APPDIR and
TA_TUXDIR are taken from the appropriate
T_MACHINE object. See the discussion of the
T_MACHINE:
TA_ENVFILE attribute for a more detailed discussion of how environment variables are handled.
GET:
“{
ACTive |
INActive |
MIGrating |
CLEaning |
REStarting |
SUSpended | EXIting |
PARtitioned |
DEAd}
”
A GET operation will retrieve configuration and run-time information for the selected
T_SERVER object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_SERVER object defined and active. This is not an indication of whether the server is idle or busy. An active server with a non 0-length TA_CURRSERVICE attribute should be interpreted as a busy server, that is, one that is processing a service request.
|
|
|
T_SERVER object defined and inactive.
|
|
|
T_SERVER object defined and currently in a state of migration to the server group’s secondary logical machine. The secondary logical machine is the one listed in T_GROUP: TA_LMID attribute that does not match the T_GROUP: TA_CURLMID attribute. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SERVER object defined and currently being cleaned up by the system after an abnormal death. Note that restartable servers may enter this state if they exceed TA_MAXGEN starts/restarts within their TA_GRACE period. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SERVER object defined and currently being restarted by the system after an abnormal death. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SERVER object defined and currently suspended pending shutdown. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SERVER object defined and active; however, the machine where the server is running is currently partitioned from the T_DOMAIN: TA_MASTER site. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SERVER object defined and currently pending on exit(). This state is ACTive equivilent for the purpose of determining permissions
|
|
|
T_SERVER object defined, identified as active in the bulletin board, but currently not running due to an abnormal death. This state will exist only until the BBL local to the server notices the death and takes action ( REStarting|CLEaning). Note that this state will only be returned if the MIB_LOCAL TA_FLAGS value is specified and the machine where the server was running is reachable. This state is ACTive equivalent for the purpose of determining permissions.
|
SET:
“{
NEW |
INValid |
ACTive |
INActive |
DEAd}
”
A SET operation will update configuration and run-time information for the selected
T_SERVER object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_SERVER object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.
|
|
|
Modify an existing T_SERVER object. This combination is allowed only when in the ACTive or INActive state. Successful return leaves the object state unchanged.
|
|
|
Delete T_SERVER object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
Activate the T_SERVER object. State change allowed only when in the INActive state. (Servers in the MIGrating state must be restarted by setting the T_GROUP: TA_STATE to ACTive.) For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the ACTive state. The TMIB_NOTIFY TA_FLAG value should be used when activating a server if status on the individual server is required.
|
|
|
Deactivate the T_SERVER object. State change allowed only when in the ACTive state. Successful return leaves the object in the INActive state. The TMIB_NOTIFY TA_FLAG value should be used when deactivating a server if status on the individual server is required.
|
|
|
Deactivate the T_SERVER object by sending the server a SIGTERM signal followed by a SIGKILL signal if the server is still running after the appropriate timeout interval (see TA_MIBTIMEOUT in MIB(5)). Note that by default, a SIGTERM signal will cause the server to initiate orderly shutdown and the server will become inactive even if it is restartable. If a server is processing a long running service or has chosen to disable the SIGTERM signal, SIGKILL may be used and will be treated by the system as an abnormal termination. State change allowed only when in the ACTive or SUSpended state. Successful return leaves the object in the INActive, CLEaning or REStarting state.
|
Base server identifier. For servers with a TA_MAX attribute value of 1, this attribute will always be the same as
TA_SRVID. However, for servers with a
TA_MAX value greater than 1, this attribute indicates the base server identifier for the set of servers configured identically.
TA_ENVFILE:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Server specific environment file. See T_MACHINE:
TA_ENVFILE for a complete discussion of how this file is used to modify the environment. Limitation: Run-time modifications to this attribute will not affect a running server.
The period of time, in seconds, over which the T_SERVER:
TA_MAXGEN limit applies. This attribute is meaningful only for restartable servers, that is, if the
T_SERVER:
TA_RESTART attribute is set to "
Y". When a restarting server would exceed the
TA_MAXGEN limit but the
TA_GRACE period has expired, the system resets the current generation (
T_SERVER:
TA_GENERATION) to 1 and resets the initial boot time (
T_SERVER:
TA_TIMESTART) to the current time. A value of 0 for this attribute indicates that a server should always be restarted.
Number of generations allowed for a restartable server (T_SERVER:
TA_RESTART == "Y") over the specified grace period (
T_SERVER:
TA_GRACE). The initial activation of the server counts as one generation and each restart also counts as one. Processing after the maximum generations is exceeded is discussed above with respect to
TA_GRACE.
Maximum number of occurrences of the server to be booted. Initially, tmboot() boots
T_SERVER:
TA_MIN objects of the server, and additional objects may be started individually (by starting a particular server ID) or through automatic spawning (conversational servers only). Run-time modifications to this attribute will affect all running servers in the set of identically configured servers (see
TA_BASESRVID above) as well as the configuration definition of the server.
Minimum number of occurrences of the server to be booted by. If a T_SERVER:
TA_RQADDR is specified and
TA_MIN is greater than 1, the servers will form an MSSQ set. The server identifiers for the servers will be
T_SERVER:
TA_SRVID up to
TA_SRVID +
T_SERVER:
TA_MAX - 1. All occurrences of the server will have the same sequence number, as well as any other server parameters.
The separate dispatcher thread that is used when TA_MAXDISPATCHTHREADS > 1 is not counted as part of the
TA_MINDISPATCHTHREADS value. It is required that
TA_MINDISPATCHTHREADS <=
TA_MAXDISPATCHTHREADS. If
TA_MINDISPATCHTHREADS is not specified, the default is 0.
If TA_MAXDISPATCHTHREADS > 1, a separate dispatcher thread is used and does not count against this limit. It is required that
TA_MINDISPATCHTHREADS <=
TA_MAXDISPATCHTHREADS. If
TA_MAXDISPATCHTHREADS is not specified, the default is 1.
TA_RCMD:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Restartable (“Y”) or non-restartable (
“N”) server. If server migration is specified for this server group (
T_DOMAIN:
TA_OPTIONS/MIGRATE attribute and
T_GROUP:
TA_LMID attribute with alternate site),
TA_RESTART must be set to
“Y”.
Specifies when this server should be booted (tmboot(1)) or shutdown (
tmshutdown(1)) relative to other servers.
T_SERVER objects added without a
TA_SEQUENCE attribute specified or with an invalid value will have one generated for them that is 10,000 or more and is higher than any other automatically selected default. Servers are booted by
tmboot() in increasing order of sequence number and shutdown by
tmshutdown() in decreasing order. Run-time modifications to this attribute affect only
tmboot() and
tmshutdown() and will affect the order in which running servers may be shutdown by a subsequent invocation of
tmshutdown().
Generation of the server. When a server is initially booted via tmboot(1) or activated through the
TM_MIB(5), its generation is set to 1. Each time the server dies abnormally and is restarted, its generation is incremented. Note that when
T_SERVER:
TA_MAXGEN is exceeded and
T_SERVER:
TA_GRACE has expired, the server will be restarted with the generation reset to 1.
TA_SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. A principal name at a particular configuration level can be overridden at a lower level. If
TA_SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
TA_DOMAINID string for this domain.
Note that TA_SEC_PRINCIPAL_NAME is one of a trio of attributes, the other two being
TA_SEC_PRINCIPAL_LOCATION and
TA_SEC_PRINCIPAL_PASSVAR. The latter two attributes pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
TA_SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two attributes to a
NULL (zero length) string.
TA_SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
TA_SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVER class. When specified at any of these levels, this attribute must be paired with the
TA_SEC_PRINCIPAL_NAME attribute; otherwise, its value is ignored. (
TA_SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
See the description of the ATMI function call tpscmt() for details on this characteristic. The value in this field has meaning only for single-context servers; in multicontext servers a
NULL string is returned as a placeholder.
Number of requests initiated by this server via tpcall() or
tpacall() that are still active. For multicontext servers, this field represents the total for all server contexts. Values for individual server contexts can be found in the
T_SERVERCTXT class.
Server group number (T_GROUP:
TA_GRPNO) of the last service request made or conversation initiated from this server outward.
The T_SERVERCTXT class represents configuration and run-time attributes of individual server dispatch contexts within an application. This class is defined for both single-context and multi-context servers. For single-context servers, the values in this class are repeated as part of the
T_SERVER class. The attributes in the
T_SERVERCTXT class are read-only.
Setting of the TP_COMMIT_CONTROL characteristic for this server. See the description of the Oracle Tuxedo ATMI function
tpscmt(3c) for details on this characteristic.
Server group number (T_GROUP:
TA_GRPNO) of the last service request made or conversation initiated from this server outward.
The T_SERVICE class represents configuration attributes of services within an application. These attribute values identify and characterize configured services. A
T_SERVICE object provides activation time configuration attributes for services not specifically configured as part of the
T_SVCGRP class. Run-time information about services active in the application is provided solely through the
T_SVCGRP class. Run-time updates to the
T_SERVICE class are usually not reflected in active
T_SVCGRP objects (
TA_ROUTINGNAME is the exception).
Both the T_SERVICE class and the
T_SVCGRP class define activation time attribute settings for service names within the application. When a new service is activated (advertised), either due to initial activation of a server or due to a call to
tpadvertise(), the following hierarchy exists for determining the attribute values to be used at service startup time.
|
1.
|
If a matching configured T_SVCGRP object exists (matching service name and server group), the attributes defined in that object are used to initially configure the advertised service.
|
|
2.
|
Otherwise, if a matching configured T_SERVICE object exists (matching service name), the attributes defined in that object are used to initially configure the advertised service.
|
|
3.
|
Otherwise, if any configured T_SVCGRP objects are found with matching TA_SERVICENAME attribute values, the first one found is used to initially configure the advertised service.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
GET:
“{
ACTive |
INActive}
”
A GET operation will retrieve configuration information for the selected
T_SERVICE object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_SERVICE object is defined and at least one T_SVCGRP object with a matching TA_SERVICENAME value is active.
|
|
|
T_SERVICE object is defined and no T_SVCGRP object with a matching TA_SERVICENAME value is active.
|
A SET operation will update configuration information for the selected
T_SERVICE object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_SERVICE object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state. Limitation: Unconfigured services may still be active by virtue of a server advertising them. In this case, the creation of a new T_SERVICE object is not allowed.
|
|
|
Modify an existing T_SERVICE object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_SERVICE object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
Automatically begin a transaction (“Y”) when a service request message is received for this service if the request is not already in transaction mode. Limitation: Run-time updates to this attribute are not reflected in active
T_SVCGRP objects.
This T_SERVICE object imposes the indicated load on the system. Service loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request. Service loads have meaning only if the
T_DOMAIN:
TA_LDBAL attribute value is set to
“Y”.
This T_SERVICE object has the indicated dequeuing priority. If multiple service requests are waiting on a queue for servicing, the higher priority requests will be serviced first.
TA_BUFTYPE:
“type1[
:subtype1[,
subtype2 . . . ]][
;type2[
:subtype3[, . . . ]]] . . .
”
List of types and subtypes of data buffers accepted by this service. Up to 32 type/subtype combinations are allowed. Types of data buffers provided with the Oracle Tuxedo system are FML and
FML32 (for FML buffers),
XML (for XML buffers),
VIEW,
VIEW32,
X_C_TYPE, or
X_COMMON (for FML views),
STRING (for
NULL terminated character arrays), and
CARRAY or
X_OCTET (for a character array that is neither encoded nor decoded during transmission). Of these types, only
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON have subtypes. A
VIEW subtype gives the name of the particular
VIEW expected by the service. Application types and subtypes can also be added (see
tuxtypes(5)). For a buffer type that has subtypes, “*” can be specified for the subtype to indicate that the service accepts all subtypes for the associated buffer type.
This T_SERVICE object has the indicated routing criteria name. Active updates to this attribute will be reflected in all associated
T_SVCGRP objects.
If set to “Y”, every instance of this service requires a digital signature on its input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
SIGNATURE_REQUIRED to
“Y” at a particular level means that signatures are required for all processes running at that level or below.
If set to “Y”, every instance of this service requires an encrypted input message buffer. If not specified, the default is
“N”. This attribute applies only to applications running Oracle Tuxedo 7.1 or later software.
TA_ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
T_DOMAIN class,
T_MACHINE class,
T_GROUP class, and
T_SERVICE class. Setting
TA_ENCRYPTION_REQUIRED to
Y at a particular level means that encryption is required for all processes running at that level or below.
The XML2FML32 value initiates XML to FML32 conversion. The
XML2FML value initiates XML to FML conversion. The
NOCONVERT value indicates no conversion takes place.
The TA_AFFINITYROLE parameter allows you to configure the ATMI services session role on the server-side affinity. The specific roles are:
BEGIN,
END and
NONE. The default value is
NONE.
Services using NONE are dispatched accordingly depending on the session type and if they are involved in a previous session.
The TA_AFFINITYSCOPE parameter defines three affinity scopes:
MACHINE,
GROUP and
SERVER. The default is
SERVER.
The TA_AFFINITYSTRICT parameter defines two strictness levels:
MANDATORY and
PRECEDENT. If
TA_AFFINITYSTRICT is not set, the default value is
MANDATORY.
The T_SVCGRP class represents configuration and run-time attributes of services/groups within an application. These attribute values identify and characterize configured services/groups, and provide run-time tracking of statistics and resources associated with each object.
Both the T_SERVICE class and the
T_SVCGRP class define activation time attribute settings for service names within the application. When a new service is activated (advertised), either due to initial activation of a server or due to a call to
tpadvertise(), the following hierarchy exists for determining the attribute values to be used at service startup time.
|
1.
|
If a matching configured T_SVCGRP object exists (matching service name and server group), the attributes defined in that object are used to initially configure the advertised service.
|
|
2.
|
Otherwise, if a matching configured T_SERVICE object exists (matching service name), the attributes defined in that object are used to initially configure the advertised service.
|
|
3.
|
Otherwise, if any configured T_SVCGRP objects are found with matching TA_SERVICENAME attribute values, the first one found is used to initially configure the advertised service.
|
Once a T_SVCGRP object is active, it is represented solely by the
T_SVCGRP class. A particular service name/group name combination may have more than one associated
T_SVCGRP class at run time if there are multiple servers within the group offering the service.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | INA | SUS | PAR} ”
SET: “{ NEW | INV | ACT | INA | SUS} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ APP | CALLABLE | SYSTEM} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
T_SVCGRP Class: LOCAL Attributes
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations 1
|
GET:
“{
ACTive |
INActive |
SUSpended |
PARtitioned}
”
A GET operation will retrieve configuration and run-time information for the selected
T_SVCGRP object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
|
|
T_SVCGRP object is active within the server identified by the returned values for the TA_SRVGRP and TA_SRVID attributes. Attribute values returned indicate the current run-time instance of the service and may not be reflected in the configuration instance if temporary updates have been performed.
|
|
|
T_SVCGRP object is defined and inactive.
|
|
|
T_SVCGRP object defined, active, and currently suspended. This service is not available for access by the application in this state. This state is ACTive equivalent for the purpose of determining permissions.
|
|
|
T_SVCGRP object defined, active, and currently partitioned from the master site of the application. This service is not available for access by the application in this state. This state is ACTive equivalent for the purpose of determining permissions.
|
SET:
“{
NEW |
INValid |
ACTive |
INActive |
SUSpended}
”
A SET operation will update configuration and run-time information for the selected
T_SVCGRP object. Note that run-time modifications to a service object may affect more than one active server. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Create T_SVCGRP object for application. State change allowed only when in the INValid state. Successful return leaves the object in the INActive state.
|
|
|
Modify an existing T_SVCGRP object. This combination is not allowed in the INValid state. Successful return leaves the object state unchanged.
|
|
|
Delete T_SVCGRP object for application. State change allowed only when in the INActive state. Successful return leaves the object in the INValid state.
|
|
|
Activate (advertise) the T_SVCGRP object. State change allowed only when in the INActive, SUSpended or INValid states. Either TA_SRVID or TA_RQADDR must be specified with this state change. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the ACTive state.
|
|
|
Deactivate the T_SVCGRP object. State change allowed only when in the SUSpended state. Successful return leaves the object in either the INActive (configured entries) or INValid (unconfigured entries) state.
|
|
|
Suspend the T_SVCGRP object. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state.
|
This T_SVCGRP object imposes the indicated load on the system. Service loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request.
This T_SVCGRP object has the indicated dequeuing priority. If multiple service requests are waiting on a queue for servicing, the higher priority requests will be serviced first.
Type of service. APP indicates an application defined service name.
CALLABLE indicates a system provided callable service.
SYSTEM indicates a system provided and system callable service.
SYSTEM services are not available to application clients and servers for direct access. Note that when used as a
GET key field, a delimited list ('|' delimiter) may be used to retrieve multiple types of service group entries on one request. By default, only
APP services are retrieved.
The TA_AFFINITYROLE parameter allows you to configure the ATMI services session role on the server-side affinity. The specific roles are:
BEGIN,
END and
NONE. The default value is
NONE.
Services using NONE are dispatched accordingly depending on the session type and if they are involved in a previous session.
The TA_AFFINITYSCOPE parameter defines three affinity scopes:
MACHINE,
GROUP and
SERVER. The default is
SERVER.
The TA_AFFINITYSTRICT parameter defines two strictness levels:
MANDATORY and
PRECEDENT. If
TA_AFFINITYSTRICT is not set, the default value is
MANDATORY.
The T_TLISTEN class represents run-time attributes of the Oracle Tuxedo system
listener processes for a distributed application.
GET:
“{
INActive |
ACTive}
”
A GET operation will retrieve run-time information for the selected
T_TLISTEN object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
SET operations are not permitted on this class. This attribute is settable only via the corresponding
T_SERVICE class object.
The T_TLOG class represents configuration and run-time attributes of transaction logs. This class allows the user to manipulate logs within an application, that is, create, destroy, migrate, and so on.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
GET:
“{
ACTive |
INActive |
WARmstart}
”
A GET operation will retrieve log configuration and run-time information for the selected
T_TLOG object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
A SET operation will update log configuration and run-time information for the selected
T_TLOG object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Modify T_TLOG object. Allowed only when in the ACTive state. Successful return leaves the object state unchanged. The only object modifications permitted on this class are additions to the transaction log. In this case, TA_TLOGINDEX and TA_TLOGCOUNT indicate the objects of TA_TLOGDATA to be added.
|
|
|
Initiate warmstart for the T_TLOG object. State change allowed only when in the ACTive state. Successful return leaves the object in the WARmstart state.
|
Number of transaction log data records (TA_TLOGDATA) counted, retrieved, or to be added. This attribute is ignored for
SET operations with a state change indicated. For valid
SET operations with no state change, this attribute indicates the number of log records to be added to an active transaction log. A
GET operation with neither
TA_GRPNO nor
TA_TLOGDATA specified returns a count of in-use log records. A
GET operation with only
TA_GRPNO set will return a count of in use log records with a coordinator group matching the indicated group. A
GET operation with only
TA_TLOGDATA set ("") will return a count of in use log records and populate arrays of
TA_TLOGDATA and
TA_GRPNO attribute values corresponding to the in use log records. A
GET operation with both
TA_GRPNO and
TA_TLOGDATA set ("") will return a count of in use log records with a coordinator group matching the indicated group and populate arrays of
TA_TLOGDATA and
TA_GRPNO attribute values corresponding to the in use log records.
The T_TRANSACTION class represents run-time attributes of active transactions within the application.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET: “{ ACT | ABY | ABD | COM | REA | DEC | SUS} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
GET: “{
ACTive |
ABortonlY |
ABorteD |
COMcalled |
REAdy |
DECided |
SUSpended}
”
A GET operation will retrieve run-time information for the selected
T_TRANSACTION object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request. Note that distinct objects pertaining to the same global transaction (equivalent transaction identifiers) may indicate differing states. In general, the state indicated on the coordinator's site (
TA_COORDLMID) indicates the true state of the transaction. The exception is when a non-coordinator site notices a condition that transitions the transaction state to
ABortonlY. This transition will eventually be propagated to the coordinator site and result in the rollback of the transaction, but this change may not be immediately reflected on the coordinator site. All states are
ACTive equivalent for the purpose of determining permissions.
|
|
Indicates that the transaction group contains servers that have called xa_end ( TMSUSPEND) during the course of transactional work and that commit processing is beginning. This state will exist until either all servers that called xa_end ( TMSUSPEND) have caused a call to xa_end ( TMSUCESS), at which point the group state will become READy, or until one of the target servers does a rollback of the transaction at which point the group state will become either PostABorT or ABorteD.
|
|
|
Indicates that a server called xa_end ( TPFAIL) and that the TMS has not yet called xa_rollback(). (that is, that other servers that had called xa_end ( TMSUSPEND) are being notified by the TMS in order to clean up their associated CORBA objects.
|
|
|
|
A SET operation will update run-time information for the selected
T_TRANSACTION object. The following states indicate the meaning of a
TA_STATE set in a
SET request. States not listed may not be set.
|
|
Modify an existing T_TRANSACTION object. This combination is allowed only when in the REAdy state and only for the purpose of updating an individual group's state (see TA_GSTATE below). Successful return leaves the object state unchanged.
|
|
|
Abort the T_TRANSACTION object for the application. State change allowed only when in the ACTive, ABortonlY, or COMcalled states. Successful return leaves the object in the ABorteD state.
|
GET: “{
ACTive |
ABorteD |
ReaDOnly |
REAdy |
HCOmmit |
HABort |
DONe}
”
A GET operation will retrieve run-time information for the selected
T_TRANSACTION object(s) pertaining to the indicated group. The following states indicate the meaning of a
TA_GSTATE returned in response to a
GET request. States not listed will not be returned. Note that distinct objects pertaining to the same global transaction (equivalent transaction identifiers) may indicate differing states for individual groups. In general, the state indicated on the group's site indicates the true state of the group's participation in the transaction. The exception is when the coordinator site determines that the transaction should abort and sets each participant group state to
ABorteD. This transition will be propagated to the group's site and result in the rollback of the group's work in the transaction but may not be reflected immediately.
SET: “{
HCOmmit |
HABort}
”
A SET operation will update run-time information for the first group in the originating request within the selected
T_TRANSACTION object. The following states indicate the meaning of a
TA_GSTATE set in a
SET request. States not listed may not be set. State transitions are allowed only when performed within the object representing the group's site (
TA_LMID).
The T_ULOG class represents run-time attributes of
userlog() files within an application.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (x)—regular expression GET key field
|
A GET operation will retrieve run-time information for the selected
T_ULOG object(s). The following states indicate the meaning of a
TA_STATE returned in response to a
GET request.
SET operations are not permitted on this class.
Transaction identifier as returned from tpsuspend(). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.
Transaction identifier as returned from tx_info(). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.
Retrievals for this class must be directed, that is, the TA_LMID attribute must be specified. Retrievals of log records written by Workstation clients are available only if the log file used by the client is shared with one of the machines defined in the
T_MACHINE class for the application. Otherwise, these log records are unavailable through this class.
The field table tpadm must be available in the environment to have access to attribute field identifiers. This can be done at the shell level as follows:
/* Allocate and initialize the buffer */
ibuf = (FBFR32 *)tpal loc("FML32", NULL, 4000);
obuf = (FBFR32 *)tpalloc("FML32", NULL, 4000);
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes to be set in T_DOMAIN class object */
Fchg32(ibuf, TA_OPTIONS, 0, "LAN,MIGRATE", 0);
Fchg32(ibuf, TA_IPCKEY, 0, (char *)&ipckey, 0);
Fchg32(ibuf, TA_MASTER, 0, "LMID1", 0);
Fchg32(ibuf, TA_MODEL, 0, "MP", 0);
/* Set TM_MIB(5) attributes for TA_MASTER T_MACHINE class object */
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
Fchg32(ibuf, TA_PMID, 0, pmid[0], 0);
Fchg32(ibuf, TA_TUXCONFIG, 0, tuxconfig[0], 0);
Fchg32(ibuf, TA_TUXDIR, 0, tuxdir[0], 0);
Fchg32(ibuf, TA_APPDIR, 0, appdir[0], 0);
Fchg32(ibuf, TA_ENVFILE, 0, envfile[0], 0);
Fchg32(ibuf, TA_ULOGPFX, 0, ulogpfx[0], 0);
Fchg32(ibuf, TA_BRIDGE, 0, "/dev/tcp", 0);
Fchg32(ibuf, TA_NADDR, 0, naddr[0], 0);
Fchg32(ibuf, TA_NLSADDR, 0, nlsaddr[0], 0);
/* Perform the action via tpadmcall() */
if (tpadmcall(ibuf, obuf, 0) 0) {
fprintf(stderr, "tpadmcall failed: %s\n", tpstrerror(tperrno));
/* Additional error case processing */
}
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes to be set in T_MACHINE class object */
Fchg32(ibuf, TA_LMID, 0, "LMID2", 0);
Fchg32(ibuf, TA_PMID, 0, pmid[1], 0);
Fchg32(ibuf, TA_TUXCONFIG, 0, tuxconfig[1], 0);
Fchg32(ibuf, TA_TUXDIR, 0, tuxdir[1], 0);
Fchg32(ibuf, TA_APPDIR, 0, appdir[1], 0);
Fchg32(ibuf, TA_ENVFILE, 0, envfile[1], 0);
Fchg32(ibuf, TA_ULOGPFX, 0, ulogpfx[1], 0);
Fchg32(ibuf, TA_BRIDGE, 0, "/dev/tcp", 0);
Fchg32(ibuf, TA_NADDR, 0, naddr[1], 0);
Fchg32(ibuf, TA_NLSADDR, 0, nlsaddr[1], 0);
tpadmcall(...) /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
/* Set TM_MIB(5) T_DOMAIN attributes changing *
Fchg32(ibuf, TA_MASTER, 0, "LMID1,LMID2", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_GROUP", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining first group */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_GRPNO, 0, (char *)&grpno[0], 0);
Fchg32(ibuf, TA_LMID, 0, "LMID1,LMID2", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Set TM_MIB(5) attributes defining second group */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP2", 0);
Fchg32(ibuf, TA_GRPNO, 0, (char *)&grpno[1], 0);
Fchg32(ibuf, TA_LMID, 0, "LMID2,LMID1", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVER", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining first server */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&srvid[0], 0);
Fchg32(ibuf, TA_SERVERNAME, 0, "ECHO", 0)
tpadmcall(...); /* See earlier example for detailed error processing */
/* Set TM_MIB(5) attributes defining second server */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP2", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&srvid[1], 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_ROUTING", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining routing criteria */
Fchg32(ibuf, TA_ROUTINGNAME, 0, "ECHOROUTE", 0);
Fchg32(ibuf, TA_BUFTYPE, 0, "FML", 0);
Fchg32(ibuf, TA_FIELD, 0, "LONG_DATA", 0);
Fchg32(ibuf, TA_RANGES, 0, "MIN-100:GRP1,100-MAX:GRP2", 26);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVICE", 0);
Fchg32(ibuf, TA_STATE, 0, "NEW", 0);
/* Set TM_MIB(5) attributes defining service entry */
Fchg32(ibuf, TA_SERVICENAME, 0, "ECHO", 0);
Fchg32(ibuf, TA_ROUTINGNAME, 0, "ECHOROUTE", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "ACT", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_STATE, 0, "RAC", 0);
/* Set TM_MIB(5) attributes identifying machine */
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
/* Invoke the /AdminAPI and interpret results */
if (tpcall(".TMIB", (char *)ibuf, 0, (char **)&obuf, &olen, 0) < 0) {
fprintf(stderr, "tpcall failed: %s\n", tpstrerror(tperrno));
if (tperrno == TPESVCFAIL) {
Fget32(obuf,TA_ERROR,0,(char *)&ta_error,NULL);
ta_status = Ffind32(obuf, TA_STATUS, 0, NULL);
fprintf(stderr, "Failure: %ld, %s\n",
ta_error, ta_status);
/* Additional error case processing */
}
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "GET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_SERVER", 0);
flags = MIB_LOCAL;
Fchg32(ibuf, TA_FLAGS, 0, (char *)&flags, 0);
/* Set TM_MIB(5) attributes identifying machine */
Fchg32(ibuf, TA_SRVGRP, 0, "GRP1", 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)&srvid[0], 0);
tpcall(...); /* See earlier example for detailed error processing */
/* Clear the request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Shutdown Remote Machine First */
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_MACHINE", 0);
Fchg32(ibuf, TA_LMID, 0, "LMID2", 0);
Fchg32(ibuf, TA_STATE, 0, "INA", 0);
tpcall(....); /* See earlier example for detailed error processing */
/* And now application servers on master machine *
flags = TMIB_APPONLY;
Fchg32(ibuf, TA_FLAGS, 0, (char *)&flags, 0);
Fchg32(ibuf, TA_LMID, 0, "LMID1", 0);
tpcall(...); /* See earlier example for detailed error processing */
/* Terminate active application access */
tpterm();
/* Finally, shutdown the master admin processes */
Finit32(ibuf, Fsizeof32(ibuf));
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_DOMAIN", 0);
Fchg32(ibuf, TA_STATE, 0, "INA", 0);
tpadmcall(...); /* See earlier example for detailed error processing */
tpacall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
MIB(5),
WS_MIB(5)
TMFFNAME SRVGRP=“identifier” SRVID=“number”
[CLOPT=“[-A] [servopts options]
[-- [-F ] [-N | -N –M [-f filename]]]”]
TMFFNAME is a server provided by Oracle Tuxedo that runs the FactoryFinder and supporting NameManager services which maintain a mapping of application-supplied names to object references.
The FactoryFinder service is a CORBA-derived service that provides client applications with the ability to find application factories that correspond to application-specified search criteria. Consult the
Oracle Tuxedo CORBA Programming Reference for a complete description on the FactoryFinder API and
Creating CORBA Server Applications for a description of registering and unregistering factories. The FactoryFinder service is the “default” service if no services are specified in the
CLOPT.
The location of the factory_finder.ini file is specified with the
-f command-line option for the master NameManager. If the
-f option is specified and the
factory_finder.ini file is not found, the initialization of the master NameManager fails. If the
-f option is not specified, only locally registered factory objects are accessible to the local application, and none of the local factory objects are accessible to applications in remote domains.
|
Note:
|
It is possible to boot one or more TMFFNAME processes running the same service. To provide increased reliability, at least two NameManager services must be configured, preferably on different machines.
|
The TMFFNAME servers run on Oracle Tuxedo version 4.0 software and later.
If a TMSYSEVT server is not configured in the application’s
UBBCONFIG file and is not running when a NameManager service is being started, the server terminates itself during boot and writes an error message to the user log.
If running an MP configuration, all name managers (TMFFNAME -N) should configured to boot before any slave event service servers(
TMSYSEVT -S). The master
TMSYSEVT must still be booted before any name managers. If slave
TMSYSEVT booted before name managers, a slave name manager could miss update events sent by the master name manager, this can result in some clients seeing NoFactory exceptions when trying to find a factory, or the factory finder returning a factory object which is no longer registered (resulting in
NO_IMPLEMENT or other exceptions when invoked on), or unexpected load balancing behavior.
TMIFRSVR SRVGRP=“identifier” SRVID=“number” RESTART=Y GRACE=0 CLOPT=“[servopts options] -- [-f repository_file_name]”
The TMIFRSVR server is a server provided by Oracle for accessing the Interface Repository. The API is a subset of the CORBA-defined Interface Repository API. For a description of the Interface Repository API, see
Oracle Tuxedo CORBA Programming Reference.
[-f repository_file_name]
TMMETADATA - Tuxedo service metadata repository server
CLOPT="[
-A] [
servopts options] --
-f repository_file [
-r] [-o
filename]
TMMETADATA is a Tuxedo system server that processes requests to retrieve and/or update Tuxedo service metadata repository information.
TMMETADATA provides and supports just one service,
.TMMETAREPOS, which uses
FML32 input and output buffers similar to those used by the Tuxedo MIB. The
TMMETADATA FML32 buffer format is described in
MIB(5).
The CLOPT option is a string of command link options that is passed to
TMMETADATA when it is booted. The following run-time parameters are recognized by
TMMETADATA:
If this option is specified, TMMETADATA only allows retrieve information requests from the metadata repository and disallows any metadata repository update requests. The
TMMETADATA default permissions setting is
read/write.
Because TMMETADATA provides only one service,
.TMMETAREPOS, multiple
TMMETADATA servers running on a particular Tuxedo domain must all be configured for the same permission access. That is, they either should all be read only or they should all be read and write.
Each TMMETADATA server must be configured to access the same metadata repository file or an exact copy of the file to provide consistent request results. Therefore, it is strongly recommended that a stable version of the metadata repository is made available for multiple
TMMETADATA server access.
TMMETADATA must run on a Tuxedo 9.0 release or later.
TMQFORWARD SRVGRP="
identifier"
SRVID="
number"
REPLYQ=N CLOPT=" [
-A] [
servopts options]
-- -q queuename[,queuename...]
[
-t trantime ] [
-i idletime] [
-b timeout] [
-e] [
-d] [
-n] [
-f delay] "
-q queuename[,queuename...]
Used to cause the server to forward the message to the service instead of using tpcall. The message is sent such that a reply is not expected from the service. The
TMQFORWARD server does not block waiting for the reply from the service and can continue processing the next message from the queue. To throttle the system such that
TMQFORWARD does not flood the system with requests, the
delay numeric value can be used to indicate a delay, in seconds, between processing requests; use zero for no delay.
If the -d option is specified, the message is deleted from the queue if the service fails and a reply message is received from the server, and the reply message (and associated
tpurcode) are enqueued to the failure queue, if one is associated with the message and the queue exists. If the message is to be deleted at the same time as the retry limit for the queue is reached, the original request message is put into the error queue.
|
•
|
The SRVGRP must have TMSNAME set to TMS_QM.
|
|
•
|
OPENINFO must be set to indicate the associated device and queue name.
|
|
•
|
The SERVER entry must not be part of an MSSQ set.
|
|
•
|
The -q option must be specified in the command-line options.
|
As delivered, TMQFORWARD handles the standard buffer types provided with the Oracle Tuxedo system. If additional application buffer types are needed, a customized version of
TMQFORWARD needs to be built using
buildserver(1) with a customized type switch. See the description in
Using the ATMI /Q Component.
The buildserver options are as follows:
Specifies that buildserver should work in verbose mode. In particular, it writes the
cc command to its standard output.
Specifies one or more user files to be included in the compilation and/or link edit phases of buildserver. Source files are compiled using the either the
cc command or the compilation command specified through the CC environment variable. These files must be specified after including the
TMQFORWARD.o object file. If more than one file is specified, filenames must be separated by white space (space or tab) and the entire list must be enclosed in quotation marks. This option can be specified multiple times.
The -s option must not be specified to advertise services.
TMQFORWARD is supported as an Oracle Tuxedo system-supplied server on all supported server platforms.
TMQFORWARD may be run in an interoperating application, but it must run on an Oracle Tuxedo release 4.2 or later node.
TMQUEUE
SRVGRP="identifier"
SRVID="number" CLOPT=" [-A][servopts options] -- [-t timeout]"
A TMQUEUE server is booted as part of an application to facilitate application access to its associated queue space; a queue space is a collection of queues.
Any configuration condition that prevents the TMQUEUE from enqueuing or dequeuing messages will cause the
TMQUEUE to fail at boot time. The
SRVGRP must have
TMSNAME set to
TMS_QM, and must have
OPENINFO set to indicate the associated device and queue space name.
The tpenqueue() and
tpdequeue() functions take a queue space name as their first argument. This name must be the name of a service advertised by
TMQUEUE. By default,
TMQUEUE only offers the service “
TMQUEUE”. While this may be sufficient for applications with only a single queue space, applications with multiple queue spaces may need to have different queue space names. Additionally, applications may wish to provide more descriptive service names that match the queue space names. Advertising additional service names can be done using the standard server command line option,
-s, as shown below in
EXAMPLES. An alternative is to hard-code the service when generating a custom
TMQUEUE program, as discussed in the following section.
As delivered, TMQUEUE handles the standard buffer types provided with Oracle Tuxedo system. If additional application buffer types are needed, a customized version of
TMQUEUE needs to be built using
buildserver(1). See the description in
Using the ATMI /Q Component.
buildserver -v -o TMQUEUE -s qspacename:TMQUEUE -r TUXEDO/QM \
-f ${TUXDIR}/lib/TMQUEUE.o -f apptypsw.o
The buildserver options are as follows:
Specifies that buildserver should work in verbose mode. In particular, it writes the
cc command to its standard output.
-s qspacename,qspacename :
TMQUEUE
Specifies one or more user files to be included in the compilation and/or link edit phases of buildserver. Source files are compiled using the either the
cc command or the compilation command specified through the CC environment variable. These files must be specified after including the
TMQUEUE.o object file. If more than one file is specified, filenames must be separated by white space (space or tab) and the entire list must be enclosed in quotation marks. This option can be specified multiple times.
TMQUEUE is supported as an Oracle Tuxedo system-supplied server on all supported server platforms.
TMQUEUE may be run in an interoperating application, but it must run on an Oracle Tuxedo release 4.2 or later node.
TMSYSEVT SRVGRP="identifier" SRVID="number"
[CLOPT="[-A] [servopts options]
[-- [-S] [-p poll-seconds] [-f control-file]]"]
TMSYSEVT is an Oracle Tuxedo system provided server that processes event reports related to system failure or potential failure conditions. The event reports are filtered, and may trigger one or more notification actions.
When the EVENT_MIB(5) configuration is updated, the primary
TMSYSEVT server writes to its control file. Secondary servers poll the primary server for changes and update their local control file if necessary. The polling interval is controlled by the
-p option, and is 30 seconds by default.
TMSYSEVT must run on an Oracle Tuxedo release 6.0 or later machine.
To migrate the primary TMSYSEVT server to another machine, the system administrator must provide a current copy of
control-file. Each secondary
TMSYSEVT server automatically maintains a recent copy.
TMSYSEVT needs access to the system’s FML32 field table definitions for system events.
FLDTBLDIR32 should include
$TUXDIR/udataobj, and
FIELDTBLS32 should include
evt_mib. These environment variables may be set in the machine's or server's environment file.
Run-time tracing is based on the notion of a trace point, which marks an interesting condition or transition during the execution of an application. Examples of trace points are the entry to an ATMI function such as
tpcall, the arrival of an Oracle Tuxedo message, or the start of a transaction.
When a trace point is reached, the following things happen. First, a filter is applied to determine if the trace point is of interest. If so, a
trace record is emitted to a
receiver, which is a file or (in the future) a buffer. Finally, an
action is triggered, such as aborting the process. Both the emission to a receiver and the trigger are optional, and neither takes place if the trace point does not pass the filter.
The filter, receiver, and trigger are specified in the trace specification, whose syntax is described below. The trace specification is initialized from the
TMTRACE environment variable. The trace specification of a running process may be changed either as a trigger action or by using the
changetrace command of
tmadmin(1).
Trace points are classified into trace categories, enumerated below. Each trace point belongs to a single category. The filter describes the trace categories of interest, and minimal processing occurs for trace points that do not pass the filter.
Run-time tracing also provides the capability to dye the messages sent by a client to a server, and transitively by that server to other servers. If a process chooses to dye its messages, the dye is automatically passed by the originating process to all processes that directly or indirectly receive messages from the originating process. When a process receives a dyed message, it automatically turns on the
atmi trace category and starts emitting trace records to the user log, if this was not being done already.
Dyeing can be explicitly turned on or off by the dye and
undye triggers in the trace specification. Dyeing is also implicitly turned on when a dyed message is received, and implicitly turned off by
tpreturn() and
tpforward(). When it is implicitly turned off, the tracing specification in effect when dyeing was turned on is restored.
Trace points for Implicit calls to the ATMI and TX interface. These trace points indicate all internal calls made while processing application requests and for administration. Setting this level implies the
atmi level, that is, every call to an ATMI or TX interface is traced (both explicit and implicit).
The trace specification is a string with the syntax filter-spec: receiver-spec [
: trigger-spec] where
filter-spec describes the trace categories to be examined or ignored,
receiver-spec is the receiver of trace records, and the optional
trigger-spec describes the action to be performed.
The NULL string is also a legal trace specification. It is the default for all Oracle Tuxedo processes if no other specification is supplied.
The strings on and
off are also accepted:
on is an alias for
atmi:ulog:dye, and
off is equivalent to
: :undye.
[ { + |
- } ] [
category ]
...
where category is one of the categories listed above. The symbol
* can be used in place of
category to denote all categories. The prefix
+ or
- specifies that the following category is to be added or subtracted from the set of categories currently in effect. If no category follows a
+ or
-, the categories currently in effect are not modified.
[/ regular-expression /]
receiver
Legal receiver values are:
[/ regular-expression /]
action
Execute the command using
system(3) (this is not supported for Windows clients); occurrences of %A are expanded to the value of trace record.
where cc is the first two characters of the trace category and
data contains additional information about the trace point.
The tmadmin changetrace command cannot be used to affect the tracing level for Workstation clients.
in the environment of the client. This specification will cause all tpacall invocations in the client to be logged and message dyeing to be turned on. Any application server process that performs a service on behalf of the client will automatically log all ATMI trace points. The client's identifier, which is included in the
tpacall() trace record, can be correlated with the value of the
TPSVCINFO parameter passed to any service routine invoked on the client's behalf.
Note that changetrace affects only currently-existing processes; it does not change the trace configuration of servers in group
GROUP1 that have not yet been booted. (To set the default trace configuration of a server, set
TMTRACE in its
ENVFILE.)
TMUSREVT SRVGRP="identifier" SRVID="number"
[CLOPT="[-A] [servopts options]
[-- [-S] [-p poll-seconds] [-f control-file]]"]
TMUSREVT is an Oracle Tuxedo system provided server that processes event report message buffers from
tppost(3c), and acts as an EventBroker to filter and distribute them.
When the EVENT_MIB(5) configuration is updated, the primary
TMUSREVT server writes to its control file. Secondary servers poll the primary server for changes and update their local control file if necessary. The polling interval is controlled by the
-p option, and is 30 seconds by default.
TMUSREVT must run on an Oracle Tuxedo release 6.0 or later machine.
To migrate the primary TMUSREVT server to another machine, the system administrator must provide a current copy of
control-file. Each secondary
TMUSREVT server automatically maintains a recent copy.
If tppost() will be called in transaction mode, all
TMUSREVT server groups must have transactional capability (a TMS process).
The TMUSREVT server's environment variables must be set so that FML field tables and viewfiles needed for message filtering and formatting are available. They could be set in the machine's or server's environment file.
tperrno—Oracle Tuxedo system error codes
The name tperrno expands to a modifiable
lvalue that has type
int, the value of which is set to a positive error number by several Oracle Tuxedo system library routines.
tperrno need not be the identifier of an object; it might expand to a modifiable
lvalue resulting from a function call. It is unspecified whether
tperrno is a macro or an identifier declared with external linkage. If a
tperrno macro definition is suppressed to access an actual object, or if a program defines an identifier with the name
tperrno, the behavior is undefined.
svcname is already advertised for the server but with a function other than
func.
Cannot send to svc because it does not exist or is not the correct type of service.
When the TPACK is set and the target is a client from a prior release of the Oracle Tuxedo system that does not support the acknowledgment protocol.
See the ERRORS section of the individual Oracle Tuxedo library routines for a more detailed description of the meaning of the error codes returned by each routine.
tpurcode—Oracle Tuxedo system global variable for an application-specified return code
tpurcode is a global variable defined in
atmi.h. Its value is the same long integer used as the value of the
rcode argument of
tpreturn().
tpurcode may be used by the application to return additional information to the process that calls an application service. For details, see
tpreturn().
tuxenv—List of environment variables in the Oracle Tuxedo system.
Used to switch the IP version; n|N is the default IPv4 value,
y|Y sets the IPv6 value. It can be set in the *MACHINES, *GROUPS, *SERVERS, sections of the UBBCONFIG, or it can be before booting Tuxedo. It can also be set for for /WS, CORBA and Jolt clients.
TPMBENC has no default value. For an application server or client using MBSTRING typed buffers,
TPMBENC must be defined.
|
Note:
|
TPMBENC is used in a similar way for FLD_MBSTRING fields in an FML32 typed buffer.
|
|
Note:
|
TPMBACONV is used in a similar way for FLD_MBSTRING fields in an FML32 typed buffer.
|
Applies only if URLENTITYCACHING=Y (yes) or is not set; for details, see the description of
URLENTITYCACHING in this list.
Used to enable /Q to continue to work even though TMQFORWARD is terminated abnormally without holding locks. When this variable is set to
yes/YES, if
TMQFORWARD is shutdown abnormally, (for example, hung due to application server hanging), when shutdown request is sent to
TMQFORWARD, and
TMQFORWARD does not hold any /Q locks, the /Q can work normally and
TMQFORWARD can be restarted later. Otherwise, if
TMQFORWARD terminated abnormally, /Q will be marked as insane and must be restarted.
|
Note:
|
On a Windows system, the ALTCC and ALTCFLAGS environment variables are not applicable and setting them will produce unexpected results. You must compile your application first using a COBOL compiler and then pass the resulting object file to the buildclient(1) or buildserver(1) command.
|
If environment ALOGPFX is not specified, the default
$APPDIR/access is used. Thedate "mmddyy" (month, day, year) is appended to the log filename prefix. The access log filename length should less then 255 characters.
After turning ALOGRTNSIZE on or off, you must reboot TUXEDO.MHSCACHE
If tuxipc boots as a service, go to
Start -> Control Panel -> System -> Advanced -> Environment Variables and set system variable
TM_CPAU =YES via the GUI, and reboot the
ORACLE ProcMGR service.
This environment variable is for old-style security check. This should be set in the environment of
GWTDOMAIN. This variable will not affect any other Tuxedo processes even if set for them. It is used to make interdomain transactional requests between Tuxedo 6.5 and other Tuxedo releases work when the Tuxedo domain running on Tuxedo 6.5 cannot upgrade to patch level 446.
If TM_GWT_OLDSECCHECK=Y, the old-style security check is used by
GWTDOMAIN. This is necessary to interoperate with Tuxedo 6.5 patches before patchlev 446. However, this implies weaker security. If
TM_GWT_OLDSECCHECK=Y, the
GWTDOMAIN process writes an informational ULOG message indicating that fact, when it receives the first incoming data/connection from the network.
If TM_GWT_OLDSECCHECK=N or if
TM_GWT_OLDSECCHECK is
not set, the latest security check is used. This implies that all the interoperating Tuxedo 6.5 domains should be at least at patchlev 446.
|
Note:
|
User should set an arbitrary string to turn TUX_BLOCKLICIW on and unset to turn off.
|
cc(1),
environ(5) in a UNIX system reference manual
tuxtypes—Buffer type switch; descriptions of buffer types provided by the Oracle Tuxedo system
struct tmtype_sw_t tm_typesw[] = {
{
"CARRAY", /* type */
"*", /* subtype */
0 /* dfltsize */
NULL, /* initbuf */
NULL, /* reinitbuf */
NULL, /* uninitbuf */
NULL, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
NULL, /* encdec */
NULL, /* route */
NULL, /* filter */
NULL, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"STRING", /* type */
"*", /* subtype */
512, /* dfltsize */
NULL, /* initbuf */
NULL, /* reinitbuf */
NULL, /* uninitbuf */
_strpresend, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
_strencdec, /* encdec */
NULL, /* route */
_sfilter, /* filter */
_sformat, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"FML", /* type */
"*", /* subtype */
1024, /* dfltsize */
_finit, /* initbuf */
_freinit, /* reinitbuf */
_funinit, /* uninitbuf */
_fpresend, /* presend */
_fpostsend, /* postsend */
_fpostrecv, /* postrecv */
_fencdec, /* encdec */
_froute, /* route */
_ffilter, /* filter */
_fformat, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"VIEW", /* type */
"*", /* subtype */
1024, /* dfltsize */
_vinit, /* initbuf */
_vreinit, /* reinitbuf */
NULL, /* uninitbuf */
_vpresend, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
_vencdec, /* encdec */
_vroute, /* route */
_vfilter, /* filter */
_vformat, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
/* XATMI - identical to CARRAY */
"X_OCTET", /* type */
"*", /* subtype */
0 /* dfltsize */
},
{ /* XATMI - identical to VIEW */
{'X','_','C','_','T','Y','P','E'}, /* type */
"*", /* subtype */
1024, /* dfltsize */
_vinit, /* initbuf */
_vreinit, /* reinitbuf */
NULL, /* uninitbuf */
_vpresend, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
_vencdec, /* encdec */
_vroute, /* route */
_vfilter, /* filter */
_vformat, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
/* XATMI - identical to VIEW */
{'X','_','C','O','M','M','O','N'}, /* type */
"*", /* subtype */
1024, /* dfltsize */
_vinit, /* initbuf */
_vreinit, /* reinitbuf */
NULL, /* uninitbuf */
_vpresend, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
_vencdec, /* encdec */
_vroute, /* route */
_vfilter, /* filter */
_vformat, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"FML32", /* type */
"*", /* subtype */
1024, /* dfltsize */
_finit32, /* initbuf */
_freinit32, /* reinitbuf */
_funinit32, /* uninitbuf */
_fpresend32, /* presend */
_fpostsend32, /* postsend */
_fpostrecv32, /* postrecv */
_fencdec32, /* encdec */
_froute32, /* route */
_ffilter32, /* filter */
_fformat32, /* format */
_fpresend232 /* presend2 */
_fmbconv32 /* multibyte code-set encoding conversion */
},
{
"VIEW32", /* type */
"*", /* subtype */
1024, /* dfltsize */
_vinit32, /* initbuf */
_vreinit32, /* reinitbuf */
NULL, /* uninitbuf */
_vpresend32, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
_vencdec32, /* encdec */
_vroute32, /* route */
_vfilter32, /* filter */
_vformat32, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"XML", /* type */
"*", /* subtype */
0, /* dfltsize */
NULL, /* initbuf */
NULL, /* reinitbuf */
NULL, /* uninitbuf */
NULL, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
NULL, /* encdec */
_xroute, /* route */
NULL, /* filter */
NULL, /* format */
NULL, /* presend2 */
NULL /* multibyte code-set encoding conversion */
},
{
"MBSTRING", /* type */
"*", /* subtype */
0, /* dfltsize */
_mbsinit, /* initbuf */
NULL, /* reinitbuf */
NULL, /* uninitbuf */
_mbspresend, /* presend */
NULL, /* postsend */
NULL, /* postrecv */
NULL, /* encdec */
NULL, /* route */
NULL, /* filter */
NULL, /* format */
NULL, /* presend2 */
_mbsconv /* multibyte code-set encoding conversion */
},
{
""
}
};
A copy of the default array is delivered in $TUXDIR/lib/tmtypesw.c, and may be used as a starting point. The recommended procedure for installing a new buffer type switch is to compile
tmtypesw.c and store it as the only element in a library named
libbuft.
See buffer(3c) for a description of the elements and routines in the buffer type switch. Also found there is a description of built in routines provided by the Oracle Tuxedo system (for example,
_finit()) that applications can use when changing the system-provided buffer types.
typesw—Buffer type switch structure; parameters and routines needed for each buffer type
UBBCONFIG—Text version of an Oracle Tuxedo configuration file.
When an Oracle Tuxedo application is booted, the tmboot command refers to a binary configuration file called
TUXCONFIG to get the information necessary for starting application servers and initializing the bulletin boards in an orderly sequence. This binary file cannot be created directly; it must be created from a text file called
UBBCONFIG. To configure an application, an administrator creates a
UBBCONFIG file (with a text editor) and loads the file into a binary version (
TUXCONFIG) by running the
tmloadcf(1) command. During the life of the application, the
TUXCONFIG file is used by various Oracle Tuxedo administrative tools.
tmadmin(1) uses the configuration file (or a copy of it) in its monitoring activity.
tmshutdown(1) references the configuration file for information needed to shut the application down.
An Oracle Tuxedo UBBCONFIG file may be given any name as long as the content of the file conforms to the format described on this reference page. In addition, the
TUXCONFIG file may be given any name; the actual name is the device or system filename specified in the
TUXCONFIG environment variable.
A UBBCONFIG file is made up of nine possible specification sections. Lines beginning with an asterisk (
*) indicate the beginning of a specification section. Each such line contains the name of the section immediately following the
*. Allowable section names are:
The RESOURCES and
MACHINES sections must be the first two sections and must be included in that order. The
GROUPS section must precede the
RMS,
SERVERS,
SERVICES, and
ROUTING sections. T
he NETGROUPS section must precede the NETWORK section.
Parameters (except in the RESOURCES section) are generally specified by:
KEYWORD = value; white space (space or tab character) is allowed on either side of the equal sign (
=). This format sets
KEYWORD to
value. Valid keywords are described within each section.
Lines beginning with the reserved word DEFAULT contain parameter specifications that apply to any lines that follow them in the section in which they appear. Default specifications can be used in all sections other than the
RESOURCES section. They can appear more than once in the same section. The format for these lines is:
The values set on this line remain in effect until reset by another DEFAULT line, or until the end of the section is reached. These values can also be overridden on non-
DEFAULT lines by placing the optional parameter setting on the line. If on a non-
DEFAULT line, the parameter setting is valid for that line only; lines that follow revert to the default setting. If
DEFAULT appears on a line by itself, all previously set defaults are cleared and their values revert to the system defaults.
If a value is numeric, standard C notation is used to denote the base, that is, 0x prefix for base 16 (hexadecimal), 0 prefix for base 8 (octal), and no prefix for base 10 (decimal). The range of acceptable values for a numeric parameter is given under the description of that parameter.
If a value is an identifier (a string value already known to the Oracle Tuxedo system such as
APP_PW for the
SECURITY parameter), standard C rules are typically used. A standard C
identifier starts with an alphabetic character or underscore and contains only alphanumeric characters or underscores. The maximum allowable length of an identifier is 30 (not including the terminating
NULL).
|
•
|
The CLOPT parameter, which can be 1024 characters in length
|
|
•
|
The BUFTYPE, OPENINFO, and CLOSEINFO parameters, which can be 256 characters in length
|
|
•
|
The TUXCONFIG, TUXDIR, APPDIR, TLOGDEVICE, ULOGPFX, ENVFILE, TMSNAME, RCMD, NADDR, NLSADDR, FADDR, and AOUT (in SERVERS section) parameters, which can be 256 characters in length as of Oracle Tuxedo release 8.1; string values for these parameters are limited to 78 characters in length for Oracle Tuxedo 8.0 or earlier.
|
|
•
|
The SEC_PRINCIPAL_NAME, SEC_PRINCIPAL_LOCATION, and SEC_PRINCIPAL_PASSVAR parameters, which can be 51, 1023, and 31characters in length respectively (not including the terminating NULL)
|
|
•
|
The RANGES parameter, which can be 2048 characters in length (except in Domains, where it can be 4096 characters in length)
|
In the RANGES parameter of the
ROUTING section, certain special characters can be escaped inside a string using a backslash.
where O+ is one, two, or three octal characters. “
\0” translates to an embedded
NULL character. “
\xH+” or “
\XH+” translates to a character whose hexadecimal value is
H+ where
H+ is one or more hexadecimal characters. “
\y” (where ‘y’ is any character other than one of the previously mentioned characters) translates to ‘y’; this produces a warning.
“#” (pound sign) introduces a comment. A newline ends a comment.
AUTOTRAN can be specified at two levels in the configuration hierarchy:
RESOURCES section and
SERVICES section. When specify it in
RESOURCES section, it applies to all the application services supplied by this Oracle Tuxedo application whether they are described in
SERVICES section or not. Once
AUTOTRAN is specified in both
RESOURCES and
SERVICES section for a service, then for that service only,
SERVICES level
AUTOTRAN overrides the
RESOURCES level value.
TRANTIME can be specified at two levels in the configuration hierarchy:
RESOURCES section and
SERVICES section. When specify it in
RESOURCES section, it applies to all the services supplied by this Oracle Tuxedo application whether they are described in
SERVICES section or not. Once
TRANTIME is specified in both
RESOURCES and
SERVICES section for a service, then for that service only,
SERVICES level
TRANTIME overrides the
RESOURCES level value.
MASTER string_value1[,
string_value2]
Specifies the machine on which the master copy of the TUXCONFIG file is found. Also, if the application is being run in
MP mode,
MASTER names the machine on which the DBBL should be run.
string_value2 names an alternate
LMID location used during process relocation and booting. If the primary location is not available, the DBBL is booted at the alternate location and the alternate
TUXCONFIG file found there is used. Both
LMID values must name machines found in the
MACHINES section and must be less than or equal to 30 characters in length. This parameter is required (even in
SHM mode).
Specifies the domain identification string. If not specified, the value "" is used. If the value of DOMAINID is a character string, it may contain a maximum of 30 characters (including the trailing
NULL). If the value of
DOMAINID is a string of hexadecimal digits, it may contain a maximum of 30 octets. If
DOMAINID is specified, its value is included, as a parameter (
-C dom=
domainid), in any command output that reports on the processes associated with a particular domain, such as the output of the
ps command. This comment is useful for an administrator managing multiple domains, who may have some difficulty, without this comment, in interpreting a single output stream that refers to several domains.
System administration processes, such as the BBL, restartsrv,
cleanupsrv,
tmshutdown(), and
tmadmin(), need not be accounted for in this value, but the DBBL, all bridge processes, all system-supplied and application server processes, and all potential client processes at a particular site need to be counted. (Examples of system-supplied servers are
AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS—see
TMSNAME parameter in
GROUPS section,
TMS_QM,
GWTDOMAIN, and
WSL.) If the application is booting workstation listeners (WSLs) at a particular site, both the WSLs and the number of potential workstation handlers (WSHs) that may be booted need to be counted.
Note that for Oracle Tuxedo pre-release 7.1 (6.5 or earlier), both the MAXACCESSERS and
MAXSERVERS parameters for an application play a part in the user license checking scheme. Specifically, a machine is not allowed to boot if the number of
MAXACCESSERS for that machine + the number of
MAXACCESSERS for the machine (or machines) already running in the application is greater than the number of
MAXSERVERS + user licenses for the application. Thus, the total number of
MAXACCESSERS for an application must be less than or equal to the number of
MAXSERVERS + user licenses for the application.
All instances of system-supplied and application servers available to an application need to be accounted for in the bulletin board server table, which is a global table, meaning that the same server table resides on each machine in the application. Examples of system-supplied servers are AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS (see
TMSNAME parameter in
GROUPS section),
TMS_QM,
GWTDOMAIN, and
WSL.
Oracle Tuxedo system needs the bulletin board string pool size (MAXQUEUES * 257 * 2 + 8224) at a minimum, where
MAXQUEUES is the configured or default value of parameter
MAXQUEUES in the same
*RESOURCE section. If this parameter is not configured or the specified value is smaller than the minimum required size, Oracle Tuxedo system automatically changes the value to the minimum required size.
Regardless of the value specified for MAXSPDATA, the Oracle Tuxedo system will
not allocate an amount of string pool space outside of a system-calculated range based on (1) the strings actually specified in the
TUXCONFIG file and (2) the amount of space that would be required if all 256-byte capable strings were specified. The
tmloadcf(1) command will report a warning if the user-specified value is outside of this range and then set the value to the closest acceptable value.
Note that of the TUXCONFIG parameters whose maximum allowable length has been increased to 256 bytes, only the
GROUPS section
TMSNAME parameter and the
SERVERS section
AOUT and
RCMD parameters are actually stored in the bulletin board. The others are read in at process startup time and stored in process memory.
If the MAXTRANTIME timeout value is less than the
TRANTIME timeout value specified for an
AUTOTRAN service or the timeout value passed in a
tpbegin(3c) call to start a transaction, the timeout for a transaction is reduced to the
MAXTRANTIME value.
MAXTRANTIME has no effect on a transaction started on a machine running Oracle Tuxedo 8.0 or earlier software, except that when a machine running Oracle Tuxedo 8.1 or later software is infected by the transaction, the transaction timeout value is capped—reduced if necessary—to the
MAXTRANTIME value configured for that machine.
Even if the TRANTIME value specified in the
SERVICES section of the
UBBCONFIG file is greater than the
MAXTRANTIME value, the
tmloadcf(1) command loads the configuration without error. Any Oracle Tuxedo 8.1 or later machine infected with the
AUTOTRAN transaction will automatically reduce the transaction timeout to the
MAXTRANTIME value configured for that machine.
Specifies the initial setting of the TP_COMMIT_CONTROL characteristic for all client and server processes in an Oracle Tuxedo system application. If
value is
LOGGED, the
TP_COMMIT_CONTROL characteristic is initialized to
TP_CMT_LOGGED; otherwise, it is initialized to
TP_CMT_COMPLETE. If
CMTRET is not specified, the default is
COMPLETE. See the description of the Oracle Tuxedo System ATMI function,
tpscmt, for details on the setting of this characteristic.
If you set LDBAL to
Y, server load balancing is performed automatically. Each interface request is routed to the server with the smallest total load. The routing of a request to a server causes the server’s total to be increased by the
LOAD factor of the CORBA interface requested.
Limitation: Setting SYSTEM_ACCESS to
PROTECTED may not be effective for multithreaded servers because it is possible that while one thread is executing Oracle Tuxedo code, which means it is attached to the bulletin board, another thread might be executing user code. The Oracle Tuxedo system cannot prevent such situations.
OPTIONS {[
LAN |
SSL |
MIGRATE |
NO_XA |
NO_AA]
,*}
|
Note:
|
If the UBBCONFIG *RESOURCES Section and tlisten SSL settings are not in sync, the application will not boot.
|
If MIGRATE is specified,
LAN should also be specified (except for the case where the configuration runs on a single multiprocessor computer).
The identifier NO_XA indicates that XA transactions are not allowed. The identifier
NO_AA indicates that the auditing and authorization functions will not be called. This parameter is optional, and the default is no options.
Specifies the signal to be used if SIGNAL-based notification is used. The legal values for this parameter are
SIGUSR1 and
SIGUSR2.
SIGUSR2 is the default for this parameter.
USIGNAL may be specified even if
SIGNAL-based notification is not selected with the
NOTIFY parameter, because callers of
tpinit() may choose signal-based notification.
SECURITY {
NONE |
APP_PW |
USER_AUTH |
ACL |
MANDATORY_ACL}
Specifies the type of application security to be enforced. If not specified, this parameter defaults to NONE. The value
APP_PW indicates that application password security is to be enforced (clients must provide the application password during initialization). Setting
APP_PW causes
tmloadcf to prompt for an application password. The value
USER_AUTH is similar to
APP_PW but, in addition, indicates that per-user authentication will be done during client initialization. The value
ACL is similar to
USER_AUTH but, in addition, indicates that access control checks will be done on service names, queue names, and event names. If an associated ACL is not found for a name, it is assumed that permission is granted. The value
MANDATORY_ACL is similar to
ACL but permission is denied if an associated ACL is not found for the name.
Note that the system-supplied authentication server, AUTHSVR, advertises the authentication service as
AUTHSVC when
SECURITY is set to
USER_AUTH, and as
..AUTHSVC when
SECURITY is set to
ACL or
MANDATORY_ACL.
AUTHSVC and
..AUTHSVC point to the same authentication service.
Note also that string values AUTHSVC and
..AUTHSVC are
identifiers, meaning that there is no need to surround
AUTHSVC or
..AUTHSVC with double quotes.
Sets a multiplier of the basic SCANUNIT between sanity checks of the system. The value
SCANUNIT must be greater than 0. If this parameter is not specified, the default is set so that (
SCANUNIT *
SANITYSCAN) is approximately 120 seconds. Sanity checks include checking servers as well as the bulletin board data structure itself. Each BBL checks that all servers on its machine are viable; that is, the server hasn't terminated abnormally and is not looping. Processes deemed not viable are either cleaned up, or restarted depending on the options with which they were started. Following that, the BBL sends a message (without reply) to the DBBL to indicate it is okay.
Sets a multiplier of the basic SCANUNIT for the maximum amount of wall time a DBBL should wait for replies from all its BBLs before timing out. Every time the DBBL forwards a request to its BBLs, it waits for all of them to reply with a positive acknowledgment before replying to the requester. This option can be used for noticing dead or insane BBLs in a timely manner. The value of
DBBLWAIT must be greater than 0. If this parameter is not specified, the default is set so that (
SCANUNIT *
DBBLWAIT) is the greater of
SCANUNIT or 20 seconds.
Sets a multiplier of the basic SCANUNIT between status checks by the DBBL of all BBLs. The DBBL checks to ensure that all BBLs have reported in within the
BBLQUERY cycle. If a BBL has not been heard from, the DBBL sends a message to that BBL asking for status. If no reply is received, the BBL is partitioned. The value of
BBLQUERY must be greater than 0. If this parameter is not specified, the default is set so that (
SCANUNIT *
BBLQUERY) is approximately 300 seconds.
Sets a multiplier of the basic SCANUNIT after which a blocking call (for example, receiving a reply) times out. The value of
BLOCKTIME must be greater than 0. If this parameter is not specified, the default is set so that (
SCANUNIT * BLOCKTIME) is approximately 60 seconds.
NOTIFY {
DIPIN |
SIGNAL |
THREAD |
IGNORE}
The value DIPIN specifies that dip-in-based notification detection should be used. This means that the system will only detect notification messages on behalf of a client process while within ATMI calls. The point of detection within any particular ATMI call is not defined by the system and dip-in detection will not interrupt blocking system calls.
DIPIN is the default notification detection method.
The value SIGNAL specifies that signal-based notification detection should be used. This means that the system sends a signal to the target client process after the notification message has been made available. The system installs a signal catching routine on behalf of clients selecting this method of notification.
|
Note:
|
The SIGNAL notification method is not available for MS-DOS clients, and is not available for multithreaded or multicontexted clients.
|
The value THREAD specifies that
THREAD notification detection should be used. This means that the system dedicates a separate thread for the receipt of unsolicited messages and dispatches the unsolicited message handler in that thread. Only one unsolicited message handler executes at one time per Oracle Tuxedo application association. This value is allowed only on platforms that offer support for multi-threading. COBOL clients cannot use
THREAD notification. Clients that are written in COBOL or that run on a platform on which threads are not supported will have their notification method changed to
DIPIN if they accept the
UBBCONFIG default notification method and the
UBBCONFIG default notification method is
THREAD. In contrast, if such a client specifies thread notification explicitly in the parameters to
tpinit() or
TPINITIALIZE(), the call to this function will return an error.
The value IGNORE specifies that by default notification messages are to be ignored by application clients. This would be appropriate in applications where only clients that request notification at
tpinit() time should receive unsolicited messages.
SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. A principal name at a particular configuration level can be overridden at a lower level. If
SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
DOMAINID string specified in the
RESOURCES section for this application.
Note that SEC_PRINCIPAL_NAME is one of a trio of parameters, the other two being
SEC_PRINCIPAL_LOCATION and
SEC_PRINCIPAL_PASSVAR. The latter two parameters pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two parameters to a
NULL (zero length) string.
SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
SIGNATURE_REQUIRED to
Y at a particular level means that signatures are required for all processes running at that level or below.
ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
ENCRYPTION_REQUIRED to
Y at a particular level means that encryption is required for all processes running at that level or below.
The MACHINES section specifies the logical names for physical machines for the configuration. It also specifies parameters specific to a given machine. The
MACHINES section must contain an entry for each physical processor used by the application. Entries have the form:
ADDRESS required_parameters [
optional_parameters]
where ADDRESS is the physical name of a processor, for example, the value produced by the UNIX system
uname -n command. On a Windows system, the value can be set using the Computer Name value in the Network Control Panel and must be specified in upper case. The length of the entire ADDRESS must be 30 characters or less. If the name is not an identifier, it must be enclosed in double quotes.
If the LAN option is not specified, only one machine name can appear in this section. One of the required
KEYWORDs is
LMID, which is the logical machine
string_value assigned to the physical machine. An
LMID string_value must be unique within the
MACHINES section of the configuration file.
Specifies that string_value is to be used in other sections as the symbolic name for
ADDRESS. This name cannot contain a comma, and must be 30 characters or less. This parameter is required. There must be an
LMID line for every machine used in a configuration.
TUXCONFIG = string_value[2..256] (up to 64 bytes for Oracle Tuxedo 8.0 or earlier)
This is the absolute pathname of the file or device where the binary TUXCONFIG file is found on this machine. The administrator need only maintain one
TUXCONFIG file, namely the one that is pointed to by the
TUXCONFIG environment variable on the
MASTER machine. Copies on other machines of this master
TUXCONFIG file are synchronized with the
MASTER machine automatically when the system is booted. This parameter must be specified for each machine. If
TUXOFFSET is specified, the Oracle Tuxedo filesystem starts at that number of blocks from the beginning of the
TUXCONFIG device (see
TUXOFFSET below). See
ENVFILE in the
MACHINES section for a discussion of how this value is used in the environment.
TUXDIR = string_value[2..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
APPDIR = string_value[2..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Setting BRTHREADS to
Y makes sense only if a machine has multiple CPUs. However, having multiple CPUs is not a prerequisite for setting
BRTHREADS to
Y.
Configurations with BRTHREADS set to
Y on the local machine and
BRTHREADS set (or defaulted) to
N on the remote machine are allowed, but the throughput between the machines will not be greater than that for the single-threaded Bridge process.
|
Note:
|
If BRTHREADS=Y and the Bridge environment contains TMNOTHREADS=Y, the Bridge starts up in threaded mode and logs a warning message to the effect that the Bridge is ignoring the TMNOTHREADS setting. The TMNOTHREADS environment variable was added to the Oracle Tuxedo product in release 8.0.
|
System administration processes, such as the BBL, restartsrv,
cleanupsrv,
tmshutdown(), and
tmadmin(), need not be accounted for in this value, but the DBBL, all bridge processes, all system-supplied and application server processes, and all potential client processes at this site need to be counted. (Examples of system-supplied servers are
AUTHSVR,
TMQUEUE,
TMQFORWARD,
TMUSREVT,
TMSYSEVT,
TMS—see
TMSNAME parameter in
GROUPS section,
TMS_QM,
GWTDOMAIN, and
WSL.) If the application is booting workstation listeners (WSLs) at this site, both the WSLs and the number of potential workstation handlers (WSHs) that may be booted need to be counted.
Note that for Oracle Tuxedo pre-release 7.1 (6.5 or earlier), both the MAXACCESSERS and
MAXSERVERS (see
MAXSERVERS in
RESOURCES section) parameters for an application play a part in the user license checking scheme. Specifically, a machine is not allowed to boot if the number of
MAXACCESSERS for that machine + the number of
MAXACCESSERS for the machine (or machines) already running in the application is greater than the number of
MAXSERVERS + user licenses for the application. Thus, the total number of
MAXACCESSERS for an application must be less than or equal to the number of
MAXSERVERS + user licenses for the application.
The MAXWSCLIENTS parameter is only used when the Oracle Tuxedo system Workstation feature is used. The appropriate setting of this parameter helps to conserve interprocess communication (IPC) resources since Workstation client access to the system is multiplexed through an Oracle Tuxedo system-supplied surrogate, the workstation handler (WSH).
Specifies the number of entries in the cache used for ACL entries when SECURITY is set to
ACL or
MANDATORY_ACL. The appropriate setting of this parameter helps to conserve on shared memory resources and yet reduce the number of disk access to do ACL checking. This value must be greater than or equal to 10 and less than or equal to 32,000. The default is 100.
Used for grouping machines into classes. TYPE can be set to any string value that is 15 characters or less. If two machines have the same
TYPE value, data encoding/decoding is bypassed when sending data between the machines.
TYPE can be given any string value. It is used simply for comparison. The
TYPE parameter should be used when the application involves a heterogeneous network of machines or when different compilers are used on the machines in the network. If not specified, the default is the
NULL string, which matches any other entry that does not have a value specified.
CMPLIMIT = string_value1[
,string_value2]
TLOGDEVICE = string_value[0..256] (up to 64 bytes for Oracle Tuxedo 8.0 or earlier)
ULOGPFX = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the absolute pathname prefix of the path for the userlog(3c) message file on this machine. The value of
ULOGPFX for a given machine is used to create the
userlog(3c) message file for all servers, clients, and administrative processes executed on that machine. If this parameter is not specified,
$APPDIR/ULOG is used. “
mmddyy” (month, day, year) is appended to the prefix to get the actual log filename.
ENVFILE = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
When booting servers, local servers inherit the environment of tmboot(1) and remote servers (not on the
MASTER) inherit the environment of
tlisten(1).
TUXCONFIG,
TUXDIR, and
APPDIR are also put into the environment when a server is booted based on the information in the associated
MACHINES entry. An attempt to reset these three variables to another value will not be allowed and will result in a warning.
tmboot and
tlisten process the machine
ENVFILE before starting the server, allowing for the environment to indicate necessary pathnames for finding executable and dynamically loaded files. Once the server is running, as part of server initialization (before the application gets control in
tpsvrinit()), a server will read and export variables from both the machine and server
ENVFILE files. If a variable is set in both the machine and server
ENVFILE, the value in the server
ENVFILE will override the value in the machine
ENVFILE.
PATH and
LD_LIBRARY_PATH are treated specially. Before a server is activated, the machine
ENVFILE is scanned to find the first occurrence of a
PATH or
LD_LIBRARY_PATH variable; embedded environment variables within either
PATH variable are not expanded.
PATH and
LD_LIBRARY_PATH are used to find pathnames for executable and dynamically loaded files.
PATH will always be prefixed with:
Limitation: On Windows box, by convention, a network PATH contains no drive letters. With that in mind, if
PATH set is started by only one backslash character (for example, "
\pathToSet"), one more backslash would be automatically generated afterwards at startup to match UNC (Windows Network) Path syntax.
SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. A principal name at a particular configuration level can be overridden at a lower level. If
SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
DOMAINID string specified in the
RESOURCES section for this application.
Note that SEC_PRINCIPAL_NAME is one of a trio of parameters, the other two being
SEC_PRINCIPAL_LOCATION and
SEC_PRINCIPAL_PASSVAR. The latter two parameters pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two parameters to a
NULL (zero length) string.
SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
SIGNATURE_REQUIRED to
Y at a particular level means that signatures are required for all processes running at that level or below.
ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
ENCRYPTION_REQUIRED to
Y at a particular level means that encryption is required for all processes running at that level or below.
GROUPNAME required_parameters [o
ptional_parameters]
where GROUPNAME specifies the logical name (
string_value) of the group. The group name must be unique within all group names in the
GROUPS section and
LMID values in the
MACHINES section and cannot contain an asterisk (*), comma, or colon. It must be 30 characters or less.
LMID = string_value1 [
,string_value2]
TMSNAME = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the name of the transaction manager server a.out associated with this group. This parameter must be specified for any group entry whose servers will participate in distributed transactions (transactions across multiple resource managers—and possibly machines—that are started with
tpbegin(), and ended with
tpcommit()/
tpabort()). It specifies the file (
string_value) to be executed by
tmboot(1) when booting the server group. The value
TMS is reserved to indicate use of the
NULL XA interface. If a non-empty value other than
TMS is specified, a
TLOGDEVICE must be specified for the machine(s) associated with the
LMID value(s) for this entry. A unique server identifier is selected automatically for each TM server, and the servers will be restartable an unlimited number of times.
ENVFILE = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
The ENVFILE is read after the
MACHINES section
ENVFILE (if one exists) and before the
SERVERS section
ENVFILE (if one is specified).
SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. A principal name at a particular configuration level can be overridden at a lower level. If
SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
DOMAINID string specified in the
RESOURCES section for this application.
Note that SEC_PRINCIPAL_NAME is one of a trio of parameters, the other two being
SEC_PRINCIPAL_LOCATION and
SEC_PRINCIPAL_PASSVAR. The latter two parameters pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two parameters to a
NULL (zero length) string.
SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
SIGNATURE_REQUIRED to
Y at a particular level means that signatures are required for all processes running at that level or below.
ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
ENCRYPTION_REQUIRED to
Y at a particular level means that encryption is required for all processes running at that level or below.
This value is ignored if the TMSNAME parameter for this group is
not set or is set to
TMS. If the
TMSNAME parameter is set to a value other than
TMS but the
OPENINFO string is set to the
NULL string (
"") or is not specified, a resource manager exists for the group but does not require any information for executing an
open operation.
The format of the OPENINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (
:).
where TUXEDO/QM is the published name of the Oracle Tuxedo /Q XA interface,
qmconfig is replaced with the name of the
QMCONFIG (see
qmadmin(1)) on which the queue space resides, and
qspace is replaced with the name of the queue space. For Windows, the separator after
qmconfig must be a semicolon (
;).
For other vendors’ databases, the format of the OPENINFO string is specific to the particular vendor providing the underlying resource manager. As an example, the following
OPENINFO string demonstrates the type of information needed when opening the Oracle resource manager.
Oracle_XA is the published name of the Oracle XA interface. The series of five asterisks (*) in the
OPENINFO string pertains to the encrypting of a password, which is described in the paragraphs that follow.
Passwords passed to a resource manager in the OPENINFO string can be stored in either clear text or encrypted form. To encrypt a password, first enter a series of five or more continuous asterisks in the
OPENINFO string at the place where you want the password to go. Then load the
UBBCONFIG file by running
tmloadcf(1). When
tmloadcf() encounters the string of asterisks, it prompts you to create a password. For example:
tmloadcf -y /usr5/apps/
bankapp/myubbconfig
Password for OPENINFO (SRVGRP=BANKB3):
password
tmloadcf(1) stores the password in the
TUXCONFIG file in encrypted form. If you then regenerate the
UBBCONFIG file from the
TUXCONFIG file using
tmunloadcf(), the password is printed in the regenerated
UBBCONFIG file in encrypted form with
@@ as delimiters. For example:
When tmloadcf() encounters an encrypted password in a
UBBCONFIG file generated by
tmunloadcf(), it does not prompt the user to create a password.
This value is ignored if the TMSNAME parameter for this group is
not set or is set to
TMS. If the
TMSNAME parameter is set to a value other than
TMS but the
CLOSEINFO string is set to the
NULL string (
"") or is not specified, a resource manager exists for the group but does not require any information for executing a
close operation.
The format of the CLOSEINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (
:).
Specifies whether this server group can support multiple RMs or not. The default is N. Only when defined
MRM=Y, then an entry in
*RMS section can specify one RM for this server group. If define
MRM=Y for a server group which group number is SRVGRP, then besides this server group, an series of implicit server groups which group numbers from SRVGRP+1 to SRVGRP+31 inclusive will be occupied. That means the users can't define any other server groups which group number is between SRVGRP+1 SRVGRP+31 inclusive.
Listing 8 provides a multiple RMS configuration example. This example specifies three RMs for the server group GROUP1. So the application server of GROUP1 can establish three connections to MRM1 and MRM2 and a default connection which is specified in GROUP section.
This value is ignored if the TMSNAME parameter for this group is not set or is set to
TMS. If the
TMSNAME parameter is set to a value other than
TMS but the
OPENINFO string is set to the
NULL string (
"") or is not specified, a resource manager exists for the group but does not require any information for executing an open operation. The format of the
OPENINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (:). For Oracle Tuxedo /Q databases, the format is:
where TUXEDO/QM is the published name of the Oracle Tuxedo /Q XA interface, qmconfig is replaced with the name of the
QMCONFIG (see
qmadmin(1)) on which the queue space resides, and qspace is replaced with the name of the queue space. For Windows, the separator after qmconfig must be a semicolon (;). For other vendors' databases, the format of the
OPENINFO string is specific to the particular vendor providing the underlying resource manager. As an example, the following
MOPENINFO string demonstrates the type of information needed when opening the Oracle resource manager.
The series of five asterisks (*) in the OPENINFO string pertains to the encrypting of a password. Passwords passed to a resource manager in the
OPENINFO string can be stored in either clear text or encrypted form. To encrypt a password, first enter a series of five or more continuous asterisks in the
OPENINFO string at the place where you want the password to go. Then load the UBBCONFIG file by running
tmloadcf(1). When
tmloadcf() encounters the string of asterisks, it prompts you to create a password. For example:
tmloadcf -y /usr5/apps/bankapp/myubbconfig.
password tmloadcf(1) stores the password in the TUXCONFIG file in encrypted form. If you then regenerate the UBBCONFIG file from the TUXCONFIG file using
tmunloadcf(), the password is printed in the regenerated UBBCONFIG file in encrypted form with @@ as delimiters. For example:
OPENINFO="Oracle_XA: Oracle_XA+Acc=P/Scott/@@A0986F7733D4@@+SesTm=30+LogDit=/tmp" When
tmloadcf() encounters an encrypted password in a UBBCONFIG file generated by
tmunloadcf(), it does not prompt the user to create a password.
This value is ignored if the TMSNAME parameter for this group is not set or is set to
TMS. If the
TMSNAME parameter is set to a value other than
TMS but the
CLOSEINFO string is set to the NULL string ("") or is not specified, a resource manager exists for the group but does not require any information for executing a close operation. The format of the
CLOSEINFO string is dependent on the requirements of the vendor providing the underlying resource manager. The information required by the vendor must be prefixed with the published name of the vendor's transaction (XA) interface followed immediately by a colon (:).
If AUTO=Y is specified, the connection to the RM is established via
tpopen() when the servers are booted up. When a client calls the service (which is monitored by TMS), the corresponding RM
xa_start is invoked automatically. If
AUTO=N is specified, you must invoke
tprmopen and
tmrmstart explicitly in their application servers. The default is
Y. If the
TMSNAME parameter is set to
NULL, this item is ignored. The number of the RMS entries which belong to the same server group with
AUTO=Y must be between
0 and
15 inclusive.
The NETGROUPS section describes the network groups available to the application in the
LAN environment. Any pair of machines may be in any number of network groups. Two communicating nodes use the priority mechanism in order to determine how to communicate between elements of its group.
Every LMID must be a member of the default network group,
DEFAULTNET. Machines running Oracle Tuxedo releases earlier than release 6.4 (in which
NETGROUPS became available) can belong only to the
DEFAULTNET network group. The network group number (
NETGRPNO) for
DEFAULTNET is 0 (zero), and may not be changed. The default priority of
DEFAULTNET, however, may be modified.
NETGROUP required_parameters [
optional_parameters]
where NETGROUP is the network group name. If
NETGROUP is equal to
DEFAULTNET then the entry describes the default network group.
The NETWORK section describes the network configuration for a LAN environment. For each processor on which a bridge server is located, an entry must be placed in the
NETWORK section giving the network address of the bridge process. An error is generated if this section exists and
LAN is not specified for the
OPTIONS parameter of the
RESOURCES section.
LMID required_parameters [
optional_parameters]
where LMID is the logical machine where the bridge process is placed.
LMID must have direct access to the network device to be used (as given in the
BRIDGE parameter).
NADDR = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the complete network listening address for the Bridge process on this LMID. The listening address for a bridge is the means by which it is contacted by other bridge processes participating in the application. If
string_value has the form
“0xhex-digits” or
“\\xhex-digits”, it must contain an even number of valid hex digits. These forms, which are translated internally into a character array containing TCP/IP addresses, may also be in either of the following two forms as shown in
Table 71.
hostname is resolved to a TCP/IP host address at the time the address is bound using the locally configured name resolution facilities accessed via an operating system command. The “
#.#.#.#” is the dotted decimal format where each
# represents a decimal number in the range 0 to 255.
Port_number is a decimal number in the range 0 to 65535, the hexadecimal representations of the string specified.
NLSADDR = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the network address used by the tlisten(1) process servicing the network for this
LMID. The network address used for
NLSADDR is of the same format as that specified for the
NADDR parameter above. If the address has the form
“0xhex-digits” or
“\\xhex-digits”, it must contain an even number of valid hex digits. TCP/IP addresses may be in the "//
#.#.#.#:port" format.
tmloadcf(1) prints an error if
NLSADDR is missing on any entry but the
MASTER LMID, for which it prints a warning. However, if
NLSADDR is missing on the
MASTER LMID,
tmadmin(1) will not be able to run in administrator mode on remote machines; it will be limited to read-only operations. This also means that the backup site will be unable to reboot the master site after failure.
FADDR = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the network address used by the local machine when connecting to other machines. This parameter, along with the FRANGE parameter, determines the range of TCP/IP ports to which a process attempts to bind before making an outbound connection. This address must be a TCP/IP address. The port portion of the TCP/IP address represents the base address from which a range of TCP/IP ports can be bound by the process. The
FRANGE parameter specifies the size of the range. For example, if this address is
//mymachine.bea.com:30000 and
FRANGE is 200, all native processes attempting to make outbound connections from this LMID will bind a port on
mymachine.bea.com between 30000 and 30200. If not set, this parameter defaults to the empty string, which implies the operating system chooses a local port randomly.
string_value is the network group associated with this network entry. If unspecified, the default,
DEFAULTNET, is assumed. The
NETGROUP parameter, if not set to
DEFAULTNET, must have previously appeared as a group name in the
NETGROUPS section of the file. All network entries with a
NETGROUP DEFAULTNET are represented in the
T_MACHINE class of the
TM_MIB, while
NETWORK entries associated with any other
NETGROUP are represented in the
T_NETMAP class of the
TM_MIB to interoperate with previous releases.
AOUT required_parameters [
optional_parameters]
where AOUT specifies the file (
string_value) to be executed by
tmboot(1).
tmboot executes
AOUT on the machine specified for the server group to which the server belongs.
tmboot searches for the
AOUT file on its target machine. Thus,
AOUT must exist in a filesystem on that machine. (Of course, the path to
AOUT can include RFS connections to filesystems on other machines.) If a relative pathname for a server is given, the search for
AOUT is done first in
APPDIR, then in
TUXDIR/bin, then in
/bin, and then in
path, where
path is the value of the last
PATH= line appearing in the machine environment file, if one exists. The values for
APPDIR and
TUXDIR are taken from the appropriate machine entry in the
TUXCONFIG file. See
ENVFILE in the
MACHINES section for a more detailed discussion.
Specifies the group name for the group in which the server is to run. string_value must be the logical name associated with a server group in the
GROUPS section. It must be 30 characters or less. This association with an entry in the
GROUPS section means that
AOUT is executed on the machine with the
LMID specified for the server group. It also specifies the
GRPNO for the server group and parameters to pass when the associated resource manager is opened. All server entries must have a server group parameter specified.
Specifies servopts(5) options to be passed to
AOUT when booted. If none is specified, the default is
-A.
string_value can be up to 1024 bytes in length.
Specifies when this server should be booted or shutdown relative to other servers. If the SEQUENCE parameter is not specified, servers are booted in the order found in the
SERVERS section (and shut down in the reverse order). If a mixture of servers with and without sequence numbers is given, all servers with sequence numbers are booted first from low to high sequence number, then all servers without sequence numbers are booted in the order they appear in the configuration file. Sequence numbers must be in the range between 1 and 9999.
Specifies the minimum number of occurrences of the server to boot by tmboot. If an
RQADDR is specified and
MIN is greater than 1, the servers will form an MSSQ set. The server identifiers for the servers will be
SRVID up to
SRVID + MAX - 1. All occurrences of the server will have the same sequence number, as well as any other server parameters.
The value range for MIN is 0 to 1000. If not specified, the default is 1. Servers with a
MIN=0 value will not be booted when
tmboot -y is executed. This gives users in a multi-server environment the flexibility to boot servers as needed, and therefore reduce boot time.
ENVFILE = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Specifies the symbolic name of the request queue for AOUT. It must be 30 characters or less. If not specified, a unique key (
GRPNO.SRVID) is chosen for a queue that
AOUT accesses. Specifying the same
RQADDR and same executable name for more than one server is the way multiple server, single queue (MSSQ) sets are achieved. If two servers are given an
RQADDR with the same queue name, they must be in the same server group.
Specifies the numeric permissions on the request queue. number is specified in the usual UNIX fashion (for example, 0600). If
RQPERM is not specified, and a
PERM is specified in the
RESOURCES section, that value is used. Otherwise, a value 0666 is used. The value can be between 0001 and 0777, inclusive.
|
Note:
|
The value of REPLYQ for conversational servers is always forced to Y, regardless of the value assigned to it in the UBBCONFIG file.
|
RCMD = string_value[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
If AOUT is restartable, this parameter specifies the command that should be executed when
AOUT abnormally terminates. The string, up to the first space or tab, must be the name of an executable UNIX file, either a full pathname or relative to
APPDIR (do not attempt to set a shell variable at the beginning of the command). The command name may be optionally followed by command line arguments. Two additional arguments are appended to the command line: the
GRPNO and
SRVID associated with the restarting server. string_value is executed in parallel with restarting the server.
If AOUT is restartable, this parameter specifies that it can be restarted at most
number - 1 times within the period specified by
GRACE. The value must be greater than 0 and less than 256. If not specified, the default is 1 (which means that the server can be started once, but not restarted).
If AOUT is restartable, this parameter specifies that it can have up to
MAXGEN lives within the specified number of seconds. The value must be greater than or equal to 0 and less than 2147483648. If 0, the
AOUT can be restarted an unlimited number of times. If
GRACE is not specified, the default is 86,400 seconds (24 hours).
Specifies whether or not AOUT is restartable. The default is
N. If server migration is specified,
RESTART must be set to
Y. Note that a server terminated with a
SIGTERM signal cannot be restarted; it must be rebooted.
Limitation: Setting SYSTEM_ACCESS to
PROTECTED may not be effective for multithreaded servers because it is possible that while one thread is executing Oracle Tuxedo code, which means it is attached to the bulletin board, another thread might be executing user code. The Oracle Tuxedo system cannot prevent such situations.
If MAXDISPATCHTHREADS > 1, a separate dispatcher thread is used and does not count against this limit. It is required that
MINDISPATCHTHREADS <=
MAXDISPATCHTHREADS. If this parameter is not specified, the default is 1.
SEC_PRINCIPAL_NAME can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. A principal name at a particular configuration level can be overridden at a lower level. If
SEC_PRINCIPAL_NAME is not specified at any of these levels, the principal name for the application defaults to the
DOMAINID string specified in the
RESOURCES section for this application.
Note that SEC_PRINCIPAL_NAME is one of a trio of parameters, the other two being
SEC_PRINCIPAL_LOCATION and
SEC_PRINCIPAL_PASSVAR. The latter two parameters pertain to opening decryption keys during application booting for the system processes running in an Oracle Tuxedo 7.1 or later application. When only
SEC_PRINCIPAL_NAME is specified at a particular level, the system sets each of the other two parameters to a
NULL (zero length) string.
SEC_PRINCIPAL_LOCATION can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_PASSVAR is optional; if not specified, the system sets it to a
NULL—zero length—string.)
SEC_PRINCIPAL_PASSVAR can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVERS section. When specified at any of these levels, this parameter must be paired with the
SEC_PRINCIPAL_NAME parameter; otherwise, its value is ignored. (
SEC_PRINCIPAL_LOCATION is optional; if not specified, the system sets it to a
NULL—zero length—string.)
Use the CONCURR_STRATEGY parameter to specify the threading model to be used by a multithreaded CORBA server application. The
CONCURR_STRATEGY parameter accepts either of the following values:
When you specify CONCURR_STRATEGY = PER_REQUEST to employ the
thread-per-request model, each invocation on the CORBA server application is assigned to an arbitrary thread from the threads pool.
When you specify CONCURR_STRATEGY = PER_OBJECT to employ the
thread-per-object model, each active object is associated with a single thread at any one time. Each request for an object establishes an association between a dispatch thread and the object.
SVCNM [
optional_parameters]
where SVCNM is the (
string_value) name of the service.
SVCNM must be 127 characters or fewer in length.
Specifies that SVCNM imposes a load on the system of
number.
number can be between 1 and 32,767 inclusive. If not specified, the default is 50. A higher number indicates a greater load.
Specifies that SVCNM has a dequeuing priority of the specified number. The value must be greater than 0 and less than or equal to 100, with 100 being the highest priority. The default is 50.
BUFTYPE = “type1[
:subtype1[
,subtype2 . . . ]][
;type2[
:subtype3[
, . . . ]]] . . .
”
A list of types and subtypes of data buffers accepted by this service. This parameter can be up to 256 characters in length and a maximum of 32 type/subtype combinations are allowed. The Oracle Tuxedo system provides the following types of data buffers: FML and
FML32 (for FML buffers),
XML (for XML buffers),
VIEW,
VIEW32,
X_C_TYPE, or
X_COMMON (for FML views),
STRING (for
NULL terminated character arrays) and
CARRAY or
X_OCTET (for a character array that is neither encoded nor decoded during transmission). Of these types, only
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON have subtypes. A view subtype gives the name of the particular view expected by the service. Application types and subtypes can also be added (see
tuxtypes(5)). For a
TYPE that has subtypes, “*” can be specified for the subtype to indicate that the service accepts all subtypes for the associated type.
Specifies the name of the routing criteria used for this service when doing data-dependent routing. The string_value, which is a
ROUTING_CRITERIA_NAME defined in the
ROUTING section, is the name of the routing criteria used for data-dependent routing for this service. If this parameter is not specified, data-dependent routing is not done for this service.
string_value must be 127 characters or less in length. If multiple entries exist for the same service name but with different
SRVGRP parameters, the
ROUTING parameter must be the same for all of these entries.
numeric_value can be between 0 and 32,767 inclusive. If not specified, the default is 0 which indicates that the system-wide
BLOCKTIME value specified in the
UBBCONFIG RESOURCES section is used for the service.
SIGNATURE_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
SIGNATURE_REQUIRED to
Y at a particular level means that signatures are required for all processes running at that level or below.
ENCRYPTION_REQUIRED can be specified at any of the following four levels in the configuration hierarchy:
RESOURCES section,
MACHINES section,
GROUPS section, and
SERVICES section. Setting
ENCRYPTION_REQUIRED to
Y at a particular level means that encryption is required for all processes running at that level or below.
The SESSIONROLE parameter allows you to configure the ATMI services session role on the server-side affinity. The specific roles are:
BEGIN,
END and
NONE. The default value is
NONE.
An affinity session starts if a service using BEGIN is called using
tpcall() or
tpacall(). Affinity clients are not aware of the session until the reply message is received from the affinity server. All following requests are dispatched without affinity impact until the response message is received.
Note: Nested sessions are not supported (that is, an existing session is active and services using
BEGIN in or out of the current affinity scope are invoked). A new session will not start.
BEGIN cannot be used with conversation servers. While using
tmboot, if services using
BEGIN are found in the conversation server, an error message is sent to ULOG and the affinity role is ignored.
If a service using BEGIN fails on an affinity server, the session will not start. If load balancing is enabled, it takes effect in the specific affinity scope.
Note: Requests from Web service clients through SALT or WTC will not initiate a session
Services using NONE are dispatched accordingly depending on the session type and if they are involved in a previous session.
The AFFINITYSCOPE parameter defines three affinity scopes:
MACHINE,
GROUP and
SERVER. The default is
SERVER.
The AFFINITYSTRICT parameter defines two strictness levels:
MANDATORY and
PRECEDENT. If
AFFINITYSTRICT is not set, the default value is
MANDATORY.
AUTOTRAN can be specified at two levels in the configuration hierarchy:
RESOURCES section and
SERVICES section. When specify it in
RESOURCES section, it applies to all the services supplied by this Oracle Tuxedo application whether they are described in
SERVICES section or not. Once
AUTOTRAN is specified in both
RESOURCES and
SERVICES section for a service, then for that service only,
SERVICES level
AUTOTRAN overrides the
RESOURCES level value.
TRANTIME can be specified at two levels in the configuration hierarchy:
RESOURCES section and
SERVICES section. When specify it in
RESOURCES section, it applies to all the services supplied by this Oracle Tuxedo application whether they are described in
SERVICES section or not. Once
TRANTIME is specified in both
RESOURCES and
SERVICES sections for a service, then for that service only,
SERVICES level
TRANTIME overrides the
RESOURCES level value.
Before setting the AUTOTRAN value, the system administrator must know the value of the transactional policy assigned to the interface by the programmer. Without knowing the policy, the administrator’s expectations of run-time
AUTOTRAN functionality may be wrong.
If AUTOTRAN is set to
Y, the
TRANTIME parameter must also be set.
Specifies the dequeuing priority number for all methods of the CORBA interface. The value must be greater than 0 and less than or equal to 100. 100 is the highest priority. The default is 50.
where ROUTING_CRITERIA_NAME is the (
string_value) name assigned to the
ROUTING parameter for a particular service entry in the
SERVICES section.
ROUTING_CRITERIA_NAME must be 127 characters or less in length.
FIELD=“
root_element[/
child_element][/
child_element][/. . .][/@
attribute_name]”
The value of FIELD specifies the name of the routing element or an element attribute. This element is assumed to be an element type (or name) or an element attribute name of an XML document or datagram. This information is used to identify the element content or element attribute value for data-dependent routing while sending a document or datagram. The element name and attribute name combined may contain no more than 30 characters. Because indexing is not supported, the Oracle Tuxedo system recognizes only the first occurrence of a given element type when processing an XML buffer for data-dependent routing.
Indicates the type of routing field specified in the FIELD parameter. This parameter is used only for routing XML buffers. The value
type can be set to one of the following:
CHAR,
SHORT,
LONG,
FLOAT,
DOUBLE, or
STRING. The default type of the routing field is
STRING.
BUFTYPE = “type1[
:subtype1[
,subtype2 . . . ]][
;type2[
:subtype3[
, . . . ]]] . . .
”
A list of types and subtypes of data buffers for which this routing entry is valid. This parameter can be up to 256 characters in length and a maximum of 32 type/subtype combinations are allowed. The types must be one of the following: FML,
FML32,
XML,
VIEW,
VIEW32,
X_C_TYPE, or
X_COMMON. No subtype can be specified for types
FML,
FML32, or
XML. Subtypes are required for type
VIEW,
VIEW32,
X_C_TYPE, and
X_COMMON (“*” is not allowed). Note that subtype names should not contain semicolon, colon, comma, or asterisk characters. Duplicate type/subtype pairs cannot be specified for the same routing criteria name; more than one routing entry can have the same criteria name as long as the type/subtype pairs are unique. This parameter is required. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.
which sends buffers with field B_FLD values 0-2 to server group
DBG1, values 3-5 to server group
DBG2, and values 6-9 to
DBG3; no other values are allowed.
Here, CODE is a child element of the root element
ORDER.
Here, ORDERNO is the attribute of the XML child element
HEADER of the root element
ORDER.
The TUXCONFIG and
TUXOFFSET environment variables are used to find the
TUXCONFIG configuration file on the
MASTER machine.
# The following configuration file defines a 2-site
# configuration with two machine types. Data-dependent
# routing is used.
*RESOURCES
IPCKEY 80952 # key for well known address
DOMAINID My_Domain_Name
UID 4196 # user id for ipc structures
GID 601 # group id for ipc structures
PERM 0660 # permissions for ipc access
MAXSERVERS 20 # at most 20 simultaneous servers
MAXSERVICES 40 # offering at most 40 services
MAXGTT 20 # at most 20 simultaneous global transactions
MASTER SITE1
SCANUNIT 10
SANITYSCAN 12
BBLQUERY 180
BLOCKTIME 30
NOTIFY DIPIN
OPTIONS LAN,MIGRATE
SECURITY USER_AUTH
AUTHSVC AUTHSVC
MP # a multiprocessor based bulletin board
LDBAL Y # perform load balancing
#
*MACHINES
mach1 LMID=SITE1 TUXDIR="/usr4/tuxbin"
MAXACCESSERS=25
APPDIR="/usr2/apps/bank"
ENVFILE="/usr2/apps/bank/ENVFILE"
TLOGDEVICE="/usr2/apps/bank/TLOG" TLOGNAME=TLOG
TUXCONFIG="/usr2/apps/bank/tuxconfig" TYPE="3B2"
ULOGPFX="/usr2/apps/bank/ULOG"
SPINCOUNT=5
mach386 LMID=SITE2 TUXDIR="/usr5/tuxbin"
MAXACCESSERS=100
MAXWSCLIENTS=50
APPDIR="/usr4/apps/bank"
ENVFILE="/usr4/apps/bank/ENVFILE"
TLOGDEVICE="/usr4/apps/bank/TLOG" TLOGNAME=TLOG
TUXCONFIG="/usr4/apps/bank/tuxconfig" TYPE="386"
ULOGPFX="/usr4/apps/bank/ULOG"
#
*GROUPS
DEFAULT: TMSNAME=TMS_SQL TMSCOUNT=2
# For Windows, :bankdb: becomes ;bankdb;
BANKB1 LMID=SITE1 GRPNO=1
OPENINFO="TUXEDO/SQL:/usr2/apps/bank/bankdl1:bankdb:readwrite"
# For Windows, :bankdb: becomes ;bankdb;
BANKB2 LMID=SITE2 GRPNO=2
OPENINFO="TUXEDO/SQL:/usr4/apps/bank/bankdl2:bankdb:readwrite"
DEFAULT:
AUTHGRP LMID=SITE1 GRPNO=3
#
*NETWORK
SITE1 NADDR="mach1.80952" BRIDGE="/dev/starlan"
NLSADDR="mach1.serve"
#
SITE2 NADDR="mach386.80952" BRIDGE="/dev/starlan"
NLSADDR="mach386.serve"
*SERVERS
#
DEFAULT: RESTART=Y MAXGEN=5 REPLYQ=Y CLOPT="-A"
TLR SRVGRP=BANKB1 SRVID=1 RQADDR=tlr1
CLOPT="-A -- -T 100"
TLR SRVGRP=BANKB1 SRVID=2 RQADDR=tlr1
CLOPT="-A -- -T 200"
TLR SRVGRP=BANKB2 SRVID=3 RQADDR=tlr2
CLOPT="-A -- -T 600"
TLR SRVGRP=BANKB2 SRVID=4 RQADDR=tlr2
CLOPT="-A -- -T 700"
XFER SRVGRP=BANKB1 SRVID=5
XFER SRVGRP=BANKB2 SRVID=6
ACCT SRVGRP=BANKB1 SRVID=7
ACCT SRVGRP=BANKB2 SRVID=8
BAL SRVGRP=BANKB1 SRVID=9
BAL SRVGRP=BANKB2 SRVID=10
BTADD SRVGRP=BANKB1 SRVID=11
BTADD SRVGRP=BANKB2 SRVID=12
AUTHSVR SRVGRP=AUTHGRP SRVID=20 #
*SERVICES
DEFAULT: LOAD=50 AUTOTRAN=N
WITHDRAWAL PRIO=50 ROUTING=ACCOUNT_ID
DEPOSIT PRIO=50 ROUTING=ACCOUNT_ID
TRANSFER PRIO=50 ROUTING=ACCOUNT_ID
INQUIRY PRIO=50 ROUTING=ACCOUNT_ID
CLOSE_ACCT PRIO=40 ROUTING=ACCOUNT_ID
OPEN_ACCT PRIO=40 ROUTING=BRANCH_ID
BR_ADD PRIO=20 ROUTING=BRANCH_ID
TLR_ADD PRIO=20 ROUTING=BRANCH_ID
ABAL PRIO=30 ROUTING=b_id
TBAL PRIO=30 ROUTING=b_id
ABAL_BID PRIO=30 ROUTING=b_id
TBAL_BID PRIO=30 ROUTING=b_id SVCTIMEOUT=300
#
#
*ROUTING
ACCOUNT_ID FIELD=ACCOUNT_ID BUFTYPE="FML"
RANGES="MIN - 9999:*,10000-59999:BANKB1,60000-109999:BANKB2,*:*"
BRANCH_ID FIELD=BRANCH_ID BUFTYPE="FML"
RANGES="MIN - 0:*,1-5:BANKB1,6-10:BANKB2,*:*"
b_id FIELD=b_id BUFTYPE="VIEW:aud"
RANGES="MIN - 0:*,1-5:BANKB1,6-10:BANKB2,*:*"
//155.2.193.18:bankapp-naddr//155.2.193.18:2334
//
backus.company.com:bankapp-naddr
//b
ackus.company.com:2334
0x0002091E9B02C112
The last of these representations is hexadecimal format. The 0002 is the first part of a TCP/IP address. The
091E is the port number
2334 translated into a hexadecimal number. After that each element of the IP address
155.2.193.1 is translated into a hexadecimal number. Thus the
155 becomes
9B,
2 becomes
02 and so on.
viewfile—Source file for view descriptions
The binary .V files are used two ways in the Oracle Tuxedo system:
|
•
|
For programs that use Fvftos() and Fvstof(), the .V file is interpreted at run-time to effect the mapping between FML buffers and C structures
|
The .h file must be included in all programs using the view so that structure members can be referenced by their logical names.
|
•
|
A line beginning with the keyword “VIEW”, followed by the name of the view description; the name can have a maximum of 33 characters and must be a valid C identifier (that is, it must start with an underscore or an alphabetic character and contain only alphanumeric or underscore characters); when used with tpalloc(3c), the name can only have a maximum of 16 characters.
|
The first line of each view description must begin with the keyword “VIEW” followed by the name of the view description. A member description (or mapping entry) is a line with information about a member in the C structure. A line with the keyword “
END” must be the last line in a view description. Lines beginning with a
# are treated as comments and ignored.
The type of the member, and is specified as one of the following: int, short, long, char, float, double, string, carray, mbstring, or dec_t; if type is ‘-’, the type of the member is defaulted to the type of fbname if the view is mapped to FML buffers.
|
Note:
|
mbstring member type is supported by VIEW32 typed buffer only.
|
The user-specified NULL value or ‘-’ to indicate the default
NULL value for that field; see below for a discussion of
NULL values.
This option specifies that an additional structure member, called the associated count member (ACM), be generated, in addition to the structure member described in the member description (even for views that are not FML-based). When transferring data from a fielded buffer to a structure, each ACM in the structure is set to the number of occurrences transferred to the associated structure member. A value of 0 in an ACM indicates that no fields were transferred to the associated structure member; a positive value indicates the number of fields actually transferred to the structure member array; a negative value indicates that there were more fields in the buffer than could be transferred to the structure member array (the absolute value of the ACM equals the number of fields not transferred to the structure). During a transfer of data from a structure member array to a fielded buffer, the ACM is used to indicate the number of array elements that should be transferred. For example, if a member's ACM is set to N, the first N non-NULL fields are transferred to the fielded buffer. If N is greater than the dimension of the array, it then defaults to the dimension of the array. In either event, after the transfer takes place, the ACM is set to the actual number of array members transferred to the fielded buffer. The type of an ACM is declared to be short (32-bit long integer for VIEW32), and its name is generated as "C_
cname", where
cname is the
cname entry for which the ACM is declared. For example, an ACM for a member named
parts would be declared as follows:
This option is used only for member descriptions of type carray or string to indicate the number of bytes transferred for these possibly variable length fields. If a string or carray field is always used as a fixed length data item, this option provides no benefit. The L option generates an associated length member (
ALM) for a structure member of type carray or string (even for views that are not FML-based). When transferring data from a fielded buffer to a structure, the
ALM is set to the length of the corresponding transferred fields. If a field's length in the fielded buffer exceeds the space allocated in the mapped structure member, only the allocated number of bytes is transferred. The corresponding
ALM is set to the size of the fielded buffer item. Therefore, if the
ALM is greater than the dimension of the structure member array, the fielded buffer information was truncated on transfer. When transferring data from a structure member to a field in a fielded buffer, the
ALM is used to indicate the number of bytes to transfer to the fielded buffer, if it is a carray type field. For strings, the
ALM is ignored on transfer, but is set afterwards to the number of bytes transferred. Note that since carray fields may be of zero length, an
ALM of 0 indicates that a zero length field should be transferred to the fielded buffer, unless the value in the associated structure member is the
NULL value. An
ALM is defined to be an unsigned short (32-bit unsigned long integer for
VIEW32), and has a generated name of "
L_cname", where
cname is the name of the structure for which the
ALM is declared. If the number of occurrences of the member for which the
ALM is declared is 1 (or defaults to 1), the
ALM is declared as:
and is referred to as an ALM Array. In this case, each element in the ALM array refers to a corresponding occurrence of the structure member (or field). It is possible for the generated
ALM name to conflict with structure members whose names begin with a "
L_" prefix. Such conflicts will be reported by the view compiler, and are considered fatal errors by the compiler. For example, if a structure member has the name "
L_parts", it would conflict with the name of an
ALM generated for the member "parts". Note also that the view compiler will generate structured record definitions for
ACM and
ALM (see the C option, above) members when you specify the
-r command-line option.
|
Note:
|
For MBSTRING field in VIEW32 buffer, the viewc32(1) command automatically adds the L option and the corresponding ALM is declared. The size of the MBSTRING data prepared by Fmbpack32() must be set in the ALM by the application and it is used for Fmbunpack32().
|
This option can be used to affect what value is interpreted as a NULL value for string and carray type structure members (this option is ignored for views that are not FML-based). If this option is not used, a structure member is
NULL if its value is equal to the user-specified
NULL value (without considering any trailing
NULL characters). If this option is set, however, a member is
NULL if its value is equal to the user-specified
NULL value with the last character propagated to full length (without considering any trailing
NULL character). Note that a member whose value is
NULL will not be transferred to the destination buffer when data is transferred from the C structure to the fielded buffer. For example, a structure member TEST is of type carray[25] and a user-specified
NULL value "abcde" is established for it. If the P option is not set, TEST is considered
NULL if the first five characters are a, b, c, d, and e, respectively. If the P option is set, TEST is
NULL if the first four characters are a, b, c, and d, respectively, and the rest of the carray must contain the character 'e' (21 e’s).
NULL values are used in views to indicate empty C structure members. Default
NULL values are provided, and you may also define your own.
The default NULL value for all numeric types is 0 (0.0 for dec_t); for char types, it is "\"; and for string, carray, and mbstring types, it is "".
Escape convention constants can also be used to specify a NULL value. The view compiler recognizes the following escape constants:
ddd (where
d is an octal digit), 0, n, t, v, b, r, f, , ', and ".
String, carray, mbstring and char NULL values may be enclosed in double or single quotes. Unescaped quotes within a user-defined
NULL value are not accepted by the view compiler.
For VIEW32, the environment variable
VIEWFILES32 and
VIEWDIR32 are used.
WS_MIB—Management Information Base for Workstation
WS_MIB(5) should be used in combination with the generic MIB reference page
MIB(5) to format administrative requests and interpret administrative replies. Requests formatted as described in
MIB(5) using classes and attributes described in this reference page may be used to request an administrative service using any one of a number of existing ATMI interfaces in an active application. For additional information pertaining to all
WS_MIB(5) class definitions, see
WS_MIB(5) Additional Information on page 571.
WS_MIB(5) consists of the following classes.
MIB(5) defines the generic
TA_FLAGS attribute which is a long valued field containing both generic and component MIB specific flag values. At this time, there are no
WS_MIB(5) specific flag values defined.
The field tables for the attributes described in this reference page are found in the file udataobj/tpadm relative to the root directory of the Oracle Tuxedo system software installed on the system. The directory
${TUXDIR}/udataobj should be included by the application in the colon-separated list specified by the
FLDTBLDIR environment variable and the field table name
tpadm should be included in the comma-separated list specified by the
FIELDTBLS environment variable.
The T_WSH class represents run-time attributes of WSH client processes. These attribute values characterize Workstation statistics specific to a particular WSH client process. This class is linked to the
T_WSL class by the common key fields,
TA_SRVGRP and
TA_SRVID. It is also linked to the
T_CLIENT class (see
TM_MIB(5)) by the common key field
TA_WSHCLIENTID.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See T_CLIENT Class in TM_MIB(5)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (*)— GET/SET key, one or more required for SET operations
|
State for the WSH client within the application. Any state defined for the T_CLIENT class in
TM_MIB(5) may be returned or set as indicated on that reference page. State changes to the SUSpended state are transitive to all clients associated with this WSH as is the resetting of a SUSpended WSH to ACTive. Additionally, SUSpended WSH clients will not be assigned any additional incoming clients by the WSL. Note that the state of a WSH client may not be set to
DEAD when accessing the
T_CLIENT class; however, the state transition to
DEAD is allowed via the
T_WSH class and will result in all connections being handled by the targeted WSH to be dropped abortively.
TA_NADDR:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
A value of Y indicates that the WSH is currently performing work on behalf of one of its associated Workstation clients. A value of
N indicates that the WSH is currently waiting for work to perform on behalf of one of its associated Workstation clients.
This class represents a specialization of the T_CLIENT class and as such represents certain attributes that are duplicated in the corresponding
T_CLIENT objects. Attributes not listed that are included in the
T_CLIENT class must be accessed via that class and are not available through the
T_WSH class.
The T_WSL class represents configuration and run-time attributes of WSL server processes configured to manage Workstation groups. These attribute values identify and characterize Workstation specific configuration attributes for WSL
T_SERVER objects within the application. This class is linked to the
T_WSH class by the common key fields,
TA_SRVGRP and
TA_SRVID.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See T_SERVER Class in TM_MIB(5)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ 0 | 40 | 56 | 128 | 256} ” 2
|
|
|
|
|
|
“{ 0 | 40 | 56 | 128 | 256} ” 2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
“{ client | handler | both | none} ”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
T_WSL Class: Local Attributes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(k)—GET key field (r)—required field for object creation ( SET TA_STATE NEW) (*)— GET/SET key, one or more required for SET operations
|
TA_NADDR:
string[1..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
hostname is resolved to a TCP/IP host address at the time the address is bound using the locally configured name resolution facilities accessed via
gethostbyname(3c). The string
#.#.#.# is the dotted decimal format in which each
# represents a decimal number in the range 0 to 255.
Port_number is a decimal number in the range 0 to 65535.
TA_ENVFILE:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
WSL server specific environment file. See T_MACHINE:TA_ENVFILE for a complete discussion of how this file is used to modify the environment. Limitation: Run-time modifications to this attribute will not affect a running WSL server.
The period of time, in seconds, over which the T_WSL:TA_MAXGEN limit applies. This attribute is meaningful only for restartable WSL servers, that is, if the
T_WSL:TA_RESTART attribute is set to "
Y". When a restarting server would exceed the
TA_MAXGEN limit but the
TA_GRACE period has expired, the system resets the current generation (
T_SERVER:TA_GENERATION) to 1 and resets the initial boot time (
T_SERVER:TA_TIMESTART) to the current time. A value of 0 for this attribute indicates that the WSL server should always be restarted.
Number of generations allowed for a restartable WSL server (T_WSL:TA_RESTART == "Y") over the specified grace period (
T_WSL:TA_GRACE). The initial activation of the WSL server counts as one generation and each restart also counts as one. Processing after the maximum generations is exceeded is discussed above with respect to
TA_GRACE.
The value of TA_NETTIMEOUT is the minimum number of seconds that a Workstation client is allowed to wait to receive a response from the WSL/WSH. A value of 0 indicates no network timeout.
TA_RCMD:
string[0..256] (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Restartable (“Y”) or non-restartable (
“N”) WSL server. If server migration is specified for this server group (
T_RESOURCE:TA_OPTIONS/MIGRATE T_GROUP:TA_LMID w/ alternate site), this attribute must be set to
“Y”.
Specifies when this server should be booted (tmboot(1)) or shut down (
tmshutdown(1)) relative to other servers.
T_WSL objects added without a
TA_SEQUENCE attribute specified or with an invalid value will have one generated for them that is 10,000 or more and is higher than any other automatically selected default. Servers are booted by
tmboot() in increasing order of sequence number and shutdown by
tmshutdown() in decreasing order. Run-time modifications to this attribute affect only
tmboot() and
tmshutdown() and will affect the order in which running servers may be shutdown by a subsequent invocation of
tmshutdown().
A value of “NEW” indicates that new incoming clients may not connect through this WSL object. A value of
“ALL” indicates that Workstation clients already connected to the application through this WSL have been suspended (see
TM_MIB(5)) in addition to disallowing new incoming connections. A value of
“NONE” indicates that no suspension characteristics are in effect.
Setting a value of Y will cause all active WSHs in the Workstation group to refresh their
VIEW buffer type cache.
This class represents a specialization of the T_SERVER class and as such represents certain attributes that are duplicated in the corresponding
T_SERVER objects. Attributes not listed that are included in the
T_SERVER class must be accessed via that class and are not available through the
T_WSL class.
The field table tpadm must be available in the environment to have access to attribute field identifiers. This can be done at the shell level as follows:
The following code fragment sets the state of the Workstation group to SUSpended. This disables the Workstation group from accepting new connections from Workstation clients and suspends all Workstation clients that are currently part of the group. This code fragment and those that follow assume that the local variables
ta_srvgrp and
ta_srvid are already set to identify the Workstation group with which we are working.
/* Allocate input and output buffers */ ibuf = tpalloc("FML32", NULL, 1000);
obuf = tpalloc("FML32", NULL, 1000);
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_WSL", 0);
/* Set WS_MIB(5) attributes */
Fchg32(ibuf, TA_SRVGRP, 0, ta_srvgrp, 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)ta_srvid, 0);
Fchg32(ibuf, TA_SUSPENDED, 0, "ALL", 0);
/* Make the request */
if (tpcall(".TMIB", (char *)ibuf, 0, (char **)obuf, olen, 0) 0) {
fprintf(stderr, "tpcall failed: %s\en", tpstrerror(tperrno));
if (tperrno == TPESVCFAIL) {
Fget32(obuf, TA_ERROR, 0,(char *)ta_error, NULL);
ta_status = Ffind32(obuf, TA_STATUS, 0, NULL);
fprintf(stderr, "Failure: %ld, %s\en",
ta_error, ta_status);
}
/* Additional error case processing */
}
/* Copy the logical machine identifier for later use */
strcpy(ta_lmid, Ffind32(obuf, TA_LMID, 0, NULL));
/* Set MIB(5) attributes defining request type */ Fchg32(ibuf, TA_CLASS, 0, "T_WSH", 0);
Fchg32(ibuf, TA_OPERATION, 0, "GET", 0);
longval = TA_WSHCLIENTID;
Fchg32(ibuf, TA_FILTER, 0, (char *)longval, 0);
/* Set WS_MIB(5) attributes */
Fchg32(ibuf, TA_LMID, 0, ta_lmid, 0);
/* Allocate a separate output buffer to save the TA_WSHCLIENTID values */
wshcltids = tpalloc("FML32", NULL, 1000);
/* Make the request */
tpcall(".TMIB", (char *)ibuf, 0, (char **)wshcltids, olen, 0);
/* See how many we got */
Fget32(wshcltids, TA_OCCURS, 0,(char *)wshcltcnt, NULL);
Use the retrieved TA_WSHCLIENTID values to get a list of associated
TA_CLIENTID values for Workstation clients in this Workstation group.
/* Initialize request buffer */ Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "GET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_CLIENT", 0);
longval = TA_CLIENTID;
Fchg32(ibuf, TA_FILTER, 0, (char *)longval, 0);
longval = TA_WSHCLIENTID;
Fchg32(ibuf, TA_FILTER, 1, (char *)longval, 0);
/* Set WS_MIB(5) attributes */
Fchg32(ibuf, TA_LMID, 0, ta_lmid, 0);
Fchg32(ibuf, TA_WSC, 0, "Y", 0);
if (wshcltcnt == 1) {
/* Since only 1, use it as key field. */
Fchg32(ibuf, TA_WSHCLIENTID, 0,
Ffind32(wshcltids, TA_WSHCLIENTID, 0, NULL));
}
/* Allocate output buffer to save TA_CLIENTID/TA_WSHCLIENTID values */
cltids = tpalloc("FML32", NULL, 1000);
/* Make the request */
tpcall(".TMIB", (char *)ibuf, 0, (char **)cltids, olen, 0);
/* See how many we got */
Fget32(cltids, TA_OCCURS, 0,(char *)cltcnt, NULL);
/* Eliminate unassociated clients if necessary */
if (wshcltcnt > 1) {
for (i=(cltcnt-1); i >= 0 ;i--) {
p = Ffind32(cltids, TA_WSHCLIENTID, i, NULL);
for (j=0; j wshcltcnt ;j++) {
q = Ffind32(wshcltids, TA_WSHCLIENTID, j, NULL);
if (strcmp(p, q) == 0) {
break; /* This client is in our group */
}
}
if (j >= wshcltcnt) {
/* Client not found, delete it from list */
Fdel32(cltids, TA_CLIENTID, i);
Fdel32(cltids, TA_WSHCLIENTID, i);
cltcnt--;
}
}
}
Use the retrieved TA_CLIENTID values to notify Workstation clients in this Workstation group that they should log off.
notstr = tpalloc("STRING", NULL, 100);
(void)strcpy(notstr, "Please logoff now!");
/* Now loop through affected clients and suspend/notify them */
for (i=0; i cltcnt ;i++) {
p = Ffind32(cltids, TA_CLIENTID, i, NULL);
/* Notify the client to logoff */
tpconvert(p, (char *)ci, TPCONVCLTID);
tpnotify(ci, notptr, 0, 0);
}
Use the retrieved TA_CLIENTID values to deactivate any remaining Workstation clients in this Workstation group. Note that those that are already gone will return an error on the SET that we will ignore.
/* Initialize request buffer */
Finit32(ibuf, Fsizeof32(ibuf));
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_CLIENT", 0);
Fchg32(ibuf, TA_STATE, 0, "DEAd", 0);
/* Now loop through affected clients and deactivate them */
for (i=0; i cltcnt ;i++) {
p = Ffind32(cltids, TA_CLIENTID, i, NULL);
Fchg32(ibuf, TA_CLIENTID, 0, p);
/* Make the request */
tpcall(".TMIB", (char *)ibuf, 0, (char **)obuf, olen, 0);
}
Now deactivate the T_WSL object. This will automatically deactivate any associated active
T_WSH objects.
/* Set MIB(5) attributes defining request type */
Fchg32(ibuf, TA_OPERATION, 0, "SET", 0);
Fchg32(ibuf, TA_CLASS, 0, "T_WSL", 0);
Fchg32(ibuf, TA_STATE, 0, "INActive", 0);
/* Set WS_MIB(5) attributes */
Fchg32(ibuf, TA_SRVGRP, 0, ta_srvgrp, 0);
Fchg32(ibuf, TA_SRVID, 0, (char *)ta_srvid, 0);
/* Make the request */
tpcall(".TMIB", (char *)ibuf, 0, (char **)obuf, olen, 0);
}
tpacall(3c),
tpalloc(3c),
tpcall(3c),
tpdequeue(3c),
tpenqueue(3c),
tpgetrply(3c),
tprealloc(3c),
Introduction to FML Functions,
Fadd, Fadd32(3fml),
Fchg, Fchg32(3fml),
Ffind, Ffind32(3fml),
MIB(5),
TM_MIB(5)
WSL—Workstation Listener server
WSL SRVGRP="identifier"
SRVID="
number"
CLOPT="[-A] [servopts
options] -- -n
netaddr [-d
device]
[-w
WSHname] [-t
timeout-factor] [-T
Client-timeout]
[-m
minh] [-M
maxh] [-x
mpx-factor]
[-p
minwshport] [-P
maxwshport] [-I
init-timeout]
[-c
compression-threshold] [-k
compression-threshold]
[-K {client|handler|both|none}]
[
-z bits] [
-Z bits] [
-H external-netaddr][-N network-timeout]
[
-U inbound-message-size-limit-in-bytes
]
[-a] [-v{detect|warn|none}] [-R renegotiation_interval]
[-S secure_port]”
The string #.#.#.# is the dotted decimal format in which each
# represents a decimal number in the range 0 to 255. The value of
port_number is a decimal number in the range 0 to 65535.
This option is being replaced by the -I option and is being supported for upward compatibility in Oracle Tuxedo release 6.0 but may be removed in future releases. The number, when multiplied by
SCANUNIT, results in the amount of time in seconds that should be allowed for a Workstation client to complete initialization processing through the WSH before being timed out by the WSL. The default for this parameter is 3 in a non-security application and 6 in a security application. The legal range is between 1 and 255.
Client-timeout is the amount of time (in minutes) a client is allowed to stay idle. If a client does not make any requests within this time period, the WSH disconnects the client. The option can be used for client platforms that are unstable (such as a personal computer that might be turned off without calling
tpterm()). Note that the option also affects clients that get unsolicited message notifications and do not follow up on them. If
-T is specified without an argument, there is no timeout.
[-p minwshport]
[
-P maxwshport]
This option is replacing the -t option and is the recommended method for setting client initialization timeout intervals. The time, in seconds that should be allowed for a Workstation client to complete initialization processing through the WSH before being timed out by the WSL. The default for this parameter is 60. The legal range is between 1 and 32,767.
[-c compression-threshold]
[-k compression-threshold]
[-K {
client |
handler |
both |
none}]
The -K option turns on the network keep-alive feature for the
client, the
handler, or
both. You can turn off this option for both the client and handler by specifying
none.
[-z [
0 |
40 |
56 |
128|256]]
[-Z [
0 |
40 |
56 |
128|
256]]
[-U inbound-message-size-limit-in-bytes]
A detect value of causes the Oracle Tuxedo to verify that the host specified in the object reference used to make the connection matches the domain name specified in the peer server’s digital certificate. If the comparison fails, the Oracle Tuxedo refuses the authenticate the peer and drops the connection. The
detect value is the default value.
A warn value causes the Oracle Tuxedo to verify that the host specified in the object reference used to make the connection matches the domain name specified in the peer’s digital certificate. If the comparison fails, the Oracle Tuxedo logs a message to the user log but continues to process the connection.
A none value of causes the Oracle Tuxedo to not perform the peer validation and to continue to process the connection.
The -v parameter is only available if licenses for SSL or LLE (link level encryption) are installed.
[-R renegotiation-interval]
WSL is supported as an Oracle Tuxedo system-supplied server on all supported server platforms.
WSL may be run in an interoperating application, but it must run on an Oracle Tuxedo release 4.2 or later node.
