X25AM Management Programming Manual

SPI Programming Considerations for the X25AM
Subsystem
X25AM Management Programming Manual—528037-001
4-3
Error Handling
The X25AM subsystem also supports the use of the token ZSPI-TKN-RESPONSE-
TYPE, which allows an application to specify, in a command operating on multiple
objects, which kinds of response records should be returned--one for every object, or
only those for objects on which errors or warnings occurred. If no value is specified for
this token, the X25AM subsystem returns a response record for every object.
Note that for commands such as the INFO command whose purpose is to return
information, using ZSPI-TKN-RESPONSE-TYPE to request the return of only those
response records for objects on which errors or warnings occurred can result in no
information being returned.
The responses to the INFO, RESETSTATS, STATISTICS, and STATUS commands
each contain an extensible structured token that returns the requested information.
The object-name token ZCOM-TKN-OBJNAME can appear more than once in a
response record returned by the LISTOBJECTS command. This is the only case where
a token might appear multiple times in a response record.
Error Handling
General programming considerations for handling errors that occur when using the
management-programming interfaces are discussed in the SPI Common Extensions
Manual.
In the programmatic control-and-inquiry interface to the X25AM subsystem, there are
two values for the return token that indicate that the response record does not contain
an error list. One is the value ZSPI-ERR-OK, which means that no error or warning
occurred. The other is an error number defined by the X25AM subsystem that signifies
the "empty" response record. This value, ZX25-ERR-EMPTY-RESPONSE, is returned,
for example, when an application requests through ZSPI-TKN-RESPONSE-TYPE that
only response records for objects on which errors or warnings occurred be returned,
and the command finishes processing without encountering any errors or warnings.
X25AM does not pass through errors from other subsystems or interfaces.
Error-handling considerations for specific commands are described in Section 6,
Commands and Responses. The error numbers returned by the X25AM subsystem are
described in Appendix A, Error Numbers and Error Lists.
Security
Security for the X25AM subsystem is handled by SCP, as described in the SPI
Common Extensions Manual.
Some of the X25AM commands are sensitive commands, meaning that they can be
issued only by certain users. When an application that is not allowed to issue sensitive
commands attempts to issue one, SCP returns an error. For more information on
sensitive commands, see Section 6, Commands and Responses.