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.
