Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy
	http://www.oracle.com/technology/documentation/index.html   |   Site Map   |   Search   |   PDF Files   |   Contact   |   Glossary
WebLogic Enterprise Doc Home   |   Tuxedo ATMI Topics   |   Previous Topic   |   Next Topic   |   Contents   |   Index

The T_CLASSATT class represents characteristics of administrative attributes on a class/attribute basis.

Table 0-19 T_CLASSATT Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
TA_CLASSNAME( r )( * ) TA_ATTRIBUTE( r )( * )	string long	ru-r--r-- ru-r--r--	string 0 = num	N/A N/A
TA_STATE( k )	string	rw-r--r--	GET:"{VAL}" SET:"{NEW|INV}"	GET: N/A SET: N/A
TA_PERM( r ) TA_FACTPERM TA_MAXPERM	long long long	rw-r--r-- r--r--r-- r--r--r--	0000 = num = 0777 0000 = num = 0777 0000 = num = 0777	N/A N/A N/A
TA_ATTFLAGS TA_DEFAULT TA_VALIDATION	long string string	r--r--r-- r--r--r-- r--r--r--	long string string	N/A N/A N/A
( k ) - GET key field ( r ) - Required field for object creation (SET TA_STATE NEW) ( * ) - GET/SET key, one or more required for SET operations

Attribute Semantics

TA_CLASSNAME : string

Class name. Only class names known to the system are accessible.

TA_ATTRIBUTE: long

Attribute field identifier as defined in the system provided header file, for example, tpadm.h.

TA_STATE :

GET: VALid

A GET operation will retrieve information for the selected T_CLASSATT object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request. States not listed will not be returned.

VALid

T_CLASSATT object is defined. All objects of this class exist in this state. This state is INActive equivalent for the purposes of permissions checking.

SET: {NEW|INValid}

A SET operation will update configuration information for the selected T_CLASSATT object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

NEW	Create T_CLASSATT object for application. State change allowed only when in the INValid state. Successful return leaves the object in the VALid state.
unset	Modify T_CLASSATT object. Allowed only when in the VALid state. Successful return leaves the object state unchanged.
INValid	Delete or reset T_CLASSATT object for application. State change allowed only when in the VALid state. Successful return leaves the object in either the INValid state or the VALid state. Objects of this class that are built-in, that is, explicitly known to the system, will revert to their default permissions on this state change and continue to exist in the VALid state. Objects of this class that belong to add-on components for which the class attributes are not explicitly known will be deleted on this state change and transition to the INValid state.

TA_PERM : 0000 = num = 0777

Access permissions for this class attribute combination. When setting permissions, the actual value set may be automatically reset if the requested setting exceeds the permissions available for the attribute. The maximum permissions available for an attribute are the permissions documented for the administrator repeated in the operator and other permissions positions. For example, the TA_TYPE attribute of the T_MACHINE class is documented with permissions rw-r--r-- and has maximum permissions of rw-rw-rw-.

TA_FACTPERM : 0000 = num = 0777

Permissions for this class attribute combination as set on delivery of the BEA Tuxedo system from the factory. These permissions will apply after a SET operation changing the TA_STATE of an object to INValid.

TA_MAXPERM : 0000 = num = 0777

Maximum permissions for this class attribute combination.

TA_ATTFLAGS : long

Bitwise or of none, some or all of the following flags indicating special characteristics of this attribute.

MIBATT_KEYFIELD

Attribute is a key field for this class.

MIBATT_LOCAL

Attribute represents local information.

MIBATT_REGEXKEY

Attribute is a regular expression key field for this class.

MIBATT_REQUIRED

Attribute is required when creating a NEW object in this class.

MIBATT_SETKEY

Attribute is a SET key for this class.

MIBATT_NEWONLY

Attribute is writable for inactive equivalent objects in this class only when creating a NEW object by changing the TA_STATE from INValid to NEW.

TA_DEFAULT : string

Default for this attribute when creating a NEW object in this class. Note that for classes where NEW objects may not be created through the Admin API, this attribute will always be returned as a 0 length string. Attributes that may not be SET when creating a NEW object are also returned as 0 length strings. Attributes which have long values will have defaults returned as the string representing the long value. Some attributes have special characteristics indicated by the special values indicated below that may be returned here.

# Inherited:Classname[:Attribute]

Attribute default is inherited from the attribute of the same name in the indicated class. If Attribute is specified, then the value is inherited from the indicated attribute rather than the one of the same name.

# Required

Attribute is required when creating a NEW object.

# Special

Attribute has special rules for defining the default. The appropriate component MIB reference page should be consulted for further details.

TA_VALIDATION : string

String representing the validation rule applied to this class/attribute combination when a new value is being SET. This string will take one of the following formats:

CHOICES=string1|string2|...

String attribute value that must match exactly one of the choices shown.

RANGE=min\(emmax

Numeric attribute value that must be between min and max, inclusive.

SIZE=min\(emmax

String or carray attribute value that must have a length between min and max bytes long, inclusive.

READONLY=Y

Read-only attribute with no validation rule for write operations.

SPECIAL=Y

Special validation rule. Consult the appropriate component MIB reference page for more details.

UNKNOWN=Y

Unknown validation rule. Commonly associated with add-on component attribute entries for which the details are not known by the core system.

None identified.

There are two general types of errors that may be returned to the user when interfacing with component MIBs. First, any of the three ATMI verbs (tpcall(3), tpgetrply(3) and tpdequeue(3)) used to retrieve responses to administrative requests may return any error defined on their respective reference pages.

Second, if 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, then failure may be returned in the form of an application level service failure. In these cases, tpcall(3) or tpgetrply(3) returns an error with tperrno set to TPESVCFAIL and returns a reply message containing the original request along with TA_ERROR, TA_STATUS or 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. TA_BADFLD is set as indicated in the description of the individual errors below. All error codes specified below are guaranteed to be negative.

[TAEAPP]

The originating request required application cooperation to be successfully completed and the application did not allow the operation to be completed. For example, server shutdown requires application cooperation.

[TAECONFIG]

The configuration file associated with the component MIB could not be accessed as needed to satisfy the requested operation.

[TAEINVAL]

A specified field is invalid. TA_BADFLD is set to indicate the invalid field identifier.

[TAEOS]

An operating system error occurred while attempting to satisfy the request. TA_STATUS is updated with the translation of the system error code errno.

[TAEPERM]

An attempt was made to SET an attribute for which the user does not have write permissions or the user attempted a GET on a class for which the user does not have read permissions. TA_BADFLD is set to indicate the field identifier that failed permissions checking.

[TAEPREIMAGE]

A SET operation failed due to a mismatch between the specified pre-image and the current object. TA_BADFLD is set to indicate the field identifier that failed the pre-image checking.

[TAEPROTO]

The administrative request was made in an improper context. TA_STATUS is populated with additional information.

[TAEREQUIRED]

A required field value is not present. TA_BADFLD is set to indicate the missing field identifier.

[TAESUPPORT]

The administrative request is not supported in the current version of the system.

[TAESYSTEM]

A BEA Tuxedo system error occurred while attempting to satisfy the request. TA_STATUS is updated with more information on the error condition.

[TAEUNIQ]

A SET operation did not specify class keys identifying a unique object to be updated.

[other]

Other error return codes specific to particular component MIBs are specified in the component MIB reference pages. These error codes are guaranteed to be mutually exclusive both amongst all component MIBs and with generic codes defined here.

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.

[TAOK]

The operation succeeded. No updates were done to the component MIB object(s).

[TAUPDATED]

The operation succeeded. Updates were made to the component MIB object.

[TAPARTIAL]

The operation partially succeeded. Updates were made to the component MIB object.

Access to the FML32 interfaces, and therefore to the component MIBs available for administration of a BEA Tuxedo system application, are available on BEA Tuxedo Release 4.2.2 and later. The header files and field tables defining generic MIB attributes are available on Tuxedo Release 5.0 and later. Interoperability concerns specific to a particular component MIB are discussed in the reference page for that component MIB.

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.

See the "Usage" section earlier for some brief example uses of existing APIs in interfacing with generic MIB processing. More detailed examples are provided with each component MIB reference page that make use of real component MIB classes and attributes.

${TUXDIR}/include/tpadm.h
${TUXDIR}/udataobj/tpadm 

Fintro(3), Fadd32(3), Fchg32(3), Ffind32(3) tpalloc(3), tprealloc(3), tpcall(3), tpacall(3), tpgetrply(3), tpenqueue(3), tpdequeue(3), AUTHSVR(5), TM_MIB(5), TMQFORWARD(5), BEA Tuxedo Administrator's Guide, BEA Tuxedo Programmer's Guide