File Formats, Data Descriptions, MIBs, and System Processes Reference
There are two general types of errors that may be returned to the user when interfacing with ACL_MIB(5)
. First, any of the three ATMI verbs (tpcall()
, tpgetrply()
and tpdequeue()
) used to retrieve responses to administrative requests may return any error defined for them. These errors should be interpreted as described on the appropriate reference pages.
If, however, the request is successfully routed to a system service capable of satisfying the request and that service determines that there is a problem handling the request, failure may be returned in the form of an application level service failure. In these cases, tpcall()
and tpgetrply()
will return an error with tperrno()
set to TPESVCFAIL
and return a reply message containing the original request along with TA_ERROR
, TA_STATUS
and TA_BADFLD
fields further qualifying the error as described below. When a service failure occurs for a request forwarded to the system through the TMQFORWARD(5)
server, the failure reply message will be enqueued to the failure queue identified on the original request (assuming the -d
option was specified for TMQFORWARD
).
When a service failure occurs during processing of an administrative request, the FML32 field TA_STATUS
is set to a textual description of the failure, the FML32 field TA_ERROR
is set to indicate the cause of the failure as indicated below. All error codes specified below are guaranteed to be negative.
The following diagnostic codes are returned in TA_ERROR
to indicate successful completion of an administrative request. These codes are guaranteed to be non-negative.
Other return codes generic to any component MIB are specified in the MIB(5)
reference page. These return codes are guaranteed to be mutually exclusive with any ACL_MIB(5)
specific return codes defined here.
The header files and field tables defined in this reference page are available on BEA Tuxedo release 6.0 and later. Fields defined in these headers and tables will not be changed from release to release. New fields may be added which are not defined on the older release site. Access to the AdminAPI is available from any site with the header files and field tables necessary to build a request. The T_ACLPRINCIPAL
, T_ACLGROUP
, and T_ACLPERM
classes are new with BEA Tuxedo release 6.0.
The existing FML32 and ATMI functions necessary to support administrative interaction with BEA Tuxedo system MIBs, as well as the header file and field table defined in this reference page, are available on all supported native and Workstation platforms.
Following is a sequence of code fragments that adds a user to a group and adds permissions for that group to a service name.
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:
$ FIELDTBLS=tpadm
$ FLDTBLDIR=${TUXDIR}/udataobj
$ export FIELDTBLS FLDTBLDIR
The following header files are included.
#include <atmi.h>
#include <fml32.h>
#include <tpadm.h>
The following code fragment adds a user to the default group "other."
/* 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_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 */
}
${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), MIB(5)
, TM_MIB(5)
Setting Up a BEA Tuxedo Application
Programming a BEA Tuxedo ATMI Application Using C
Programming a BEA Tuxedo ATMI Application Using FML
APPQ_MIB
—Management Information Base for /Q
#include <fml32.h>
#include <tpadm.h>
The /Q MIB defines classes through which application queues can be managed.
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.
APPQ_MIB
(5) consists of the following classes.
Note that this MIB refers to application-defined persistent (reliable disk-based) and non-persistent (in memory) queues (that is, /Q queues), and not server queues (the T_QUEUE
class of the TM_MIB(5)
component).
Each class description section has four subsections:
A table that lists the name, type, permissions, values and default for each attribute in the class. The format of the attribute table is described below.
Each class that is a part of this MIB is documented in four parts. One part is the attribute table. The attribute table is a reference guide to the attributes within a class and how they may used by administrators, operators, and general users to interface with an application.
There are five components to each attribute description in the attribute tables: name, type, permissions, values and default. Each of these components is discussed in MIB(5)
.
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 BEA 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.
This MIB is provided only on BEA Tuxedo system 6.0 sites and later, both native and Workstation.
If a site running a BEA Tuxedo release earlier than release 6.0 is active in the application, administrative access through this MIB is limited as follows.