miscsrv.script

Software Testing Automation Framework (STAF)的开发代码

.***************************************************************************
.* Software Testing Automation Framework (STAF)
.* (C) Copyright IBM Corp. 2001, 2004
.*
.* This software is licensed under the Common Public License (CPL) V1.0.
.****************************************************************************

.*************************-START-OF-PROLOG-****************************
.*
.*  File Name          : MiscSrv SCRIPT
.*  Descriptive Name   : Software Test Automation Framework Misc Service
.*
.*  Detail:
.*
.*     This file describes the STAF Misc Service.
.*
.**************************-END-OF-PROLOG-*****************************
:i1.misc service
:ih1.services
:i2.misc service
:h2 id=miscsrv.Misc Service
:h3.Description
:p.The MISC service is one of the internal STAF services.  It provides a
home for miscellaneous commands.
:ul compact.
:li.VERSION - Displays the STAF version that is currently running
:li.WHOAMI - Displays information about who a system thinks you are
:li.WHOAREYOU  - Displays information about a system
:li.LIST - Displays a list of interfaces (aka connection providers) that
are enabled or lists the current operational settings for STAF or lists
the cached endpoints used by automatic interface cycling.
:li.QUERY - Displays information about a specify interface (aka
connection provider)
:li.SET - Set STAF operational characteristics 
:li.PURGE - Purges one or more (or all) of the endpoints from the
cache used for automatic interface cycling.
:li.&help.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.VERSION
:i3.misc service
:h3.VERSION
:p.VERSION will display the STAF version number that is currently running.
:h4.Syntax
:xmp.
VERSION
:exmp.
:h4.Security
:p.&seclvl. 1.
:h4.Return Codes
:p.All return codes from VERSION are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer will contain the version number.
:h4.Examples
:p.
:ul compact.
:li.:hp2.Goal::ehp2. Display the version of STAF running.
:p.:hp2.Syntax::ehp2.
:p.:xph.VERSION:exph.
:p.:hp2.Results::ehp2.
:xmp.
3.0.0
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.WHOAMI
:i3.misc service
:h3.WHOAMI
:p.WHOAMI will display information about who a system thinks you are.
This can be useful in debugging trust issues and other problems.
:h4.Syntax
:xmp.
WHOAMI
:exmp.
:h4.Security
:p.&seclvl. 1.
:h4.Return Codes
:p.All return codes from WHOAMI are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer for a :xph.WHOAMI:exph. request
will contain a marshalled :xph.<Map&colon.STAF/Service/Misc/Whoami>:exph.
representing information about who a system thinks you are.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/Whoami
:tnote text='Description'.This map class represents information about
who a system thinks you are.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.instanceName
:c.Instance Name
:c.&stringObj.
:c.
:row.
:c.instanceUUID
:c.Instance UUID
:c.&stringObj.
:c.
:row.
:c.requestNumber
:c.Request Number
:c.&stringObj.
:c.
:row.
:c.interface
:c.Interface
:c.&stringObj.
:c.
:row.
:c.logicalID
:c.Logical ID
:c.&stringObj.
:c.
:row.
:c.physicalID
:c.Physical ID
:c.&stringObj.
:c.
:row.
:c.endpoint
:c.Endpoint
:c.&stringObj.
:c.
:row.
:c.machine
:c.Macine
:c.&stringObj.
:c.
:row.
:c.machineNickname
:c.Machine Nickname
:c.&stringObj.
:c.
:row.
:c.isLocalRequest
:c.Local Request
:c.&stringObj.
:c.:xph.'Yes' | 'No':exph.
:row.
:c.handle
:c.Handle
:c.&stringObj.
:c.
:row.
:c.handleName
:c.Handle Name
:c.&stringObj.
:c.
:row.
:c.user
:c.User
:c.&stringObj.
:c.
:row.
:c.trustLevel
:c.Trust Level
:c.&stringObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The "Instance Name" value contains the STAF instance name that identifies
the instance of STAF to which the request is communicating (in case
multiple instances of STAF are running.  The default STAF instance
name is "STAF".
:li.The "Instance UUID" value contains the STAF Universally Unique ID
that uniquely identifies a STAF instance.
:li.The format for the "Endpoint" value is <Interface>://<Logical ID>[@<Port>].
:li.The format for the "User" value is <Authenticator>://<User ID>.
:eol.
:etnote.
:etable.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Display information about who the remote system thinks you are,
:p.:hp2.Syntax::ehp2.
:p.:xph.WHOAMI:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Instance Name   : STAF
Instance UUID   : 648C8241CC0B00000929359375636173
Request Number  : 1812
Interface       : tcp
Logical ID      : server1.austin.ibm.com
Physical ID     : 9.41.53.147
Endpoint        : tcp://server1.austin.ibm.com@6500
Machine         : server1.austin.ibm.com
Machine Nickname: Server1
Local Request   : No
Handle          : 33
Handle Name     : myHandle
User            : authSample://User1
Trust Level     : 5
:exmp.
:p.
:li.:hp2.Goal::ehp2. Display information about who you think you are (e.g. run locally).
:p.:hp2.Syntax::ehp2.
:p.:xph.WHOAMI:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Instance Name   : STAF
Instance UUID   : 711E9E411B0A00000929359245636173
Request Number  : 92
Interface       : local
Logical ID      : local
Physical ID     : local
Endpoint        : local://local
Machine         : server1.austin.ibm.com
Machine Nickname: Server1
Local Request   : Yes
Handle          : 29
Handle Name     : STAF/Client
User            : none://anonymous
Trust Level     : 5
:exmp.
:eul.

.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.WHOAREYOU
:i3.misc service
:h3.WHOAREYOU
:p.WHOAREYOU will display information a system, usch as the STAF instance
name, instance UUID, machine name (the value of the STAF/Config/Machine 
system variable for the machine), machine nickname, (the value of
the STAF/Config/MachineNickname variable for the machine) and if it's the
same system as the machine who submitted the request.
:h4.Syntax
:xmp.
WHOAREYOU
:exmp.
:h4.Security
:p.&seclvl. 1.
:h4.Return Codes
:p.All return codes from WHOAREYOU are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer for a :xph.WHOAREYOU:exph. request
will contain a marshalled :xph.<Map&colon.STAF/Service/Misc/WhoAreYou>:exph.
representing information about a system.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/WhoAreYou
:tnote text='Description'.This map class represents information about
a system.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.instanceName
:c.Instance Name
:c.&stringObj.
:c.
:row.
:c.instanceUUID
:c.Instance UUID
:c.&stringObj.
:c.
:row.
:c.machine
:c.Macine
:c.&stringObj.
:c.
:row.
:c.machineNickname
:c.Machine Nickname
:c.&stringObj.
:c.
:row.
:c.isLocalRequest
:c.Local Request
:c.&stringObj.
:c.:xph.'Yes' | 'No':exph.
:tnote text='Notes'.
:ol compact.
:li.The "Instance Name" value contains the STAF instance name that identifies
the instance of STAF to which the request is communicating (in case
multiple instances of STAF are running.  The default STAF instance
name is "STAF".
:li.The "Instance UUID" value contains the STAF Universally Unique ID
that uniquely identifies a STAF instance.
:eol.
:etnote.
:etable.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Display information about a remote system,
:p.:hp2.Syntax::ehp2.
:p.:xph.WHOAREYOU:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Instance Name   : STAF
Instance UUID   : 648C8241CC0B00000929359375636173
Machine         : server1.austin.ibm.com
Machine Nickname: Server1
Local Request   : No
:exmp.
:p.
:li.:hp2.Goal::ehp2. Display information about yourself (e.g. run locally).
:p.:hp2.Syntax::ehp2.
:p.:xph.WHOAREYOU:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Instance Name   : STAF
Instance UUID   : 711E9E411B0A00000929359245636173
Machine         : client2.austin.ibm.com
Machine Nickname: client2.austin.ibm.com
Local Request   : Yes
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.LIST
:i3.misc service
:h3.LIST
:p.LIST allows you to obtain information about the interfaces (aka connection
providers) that are enabled for a system, or you can list the current
operational settings for STAF, or you can show the cached endpoints
used by automatic interface cycling.

:h4.Syntax
:xmp.
LIST INTERFACES | SETTINGS | ENDPOINTCACHE
:exmp.
:p.:xph.INTERFACES:exph. specifies that you want information for interfaces.
:p.:xph.SETTINGS:exph. specifies that you want to list the current operational
settings for STAF.
:p.:xph.ENDPOINTCACHE:exph. specifies that you want to show the cached
endpoints used by automatic interface cycling.

:h4.Security
:p.&seclvl. 2.
:h4.Return Codes
:p.All return codes from LIST are documented in :hdref refid=retcode..

:h4.Results
:p.
:ul.
:li.On successful return from a :xph.LIST INTERFACES:exph. request, the
result buffer will contain a marshalled
:xph.<List> of <Map&colon.STAF/Service/Misc/Interface>:exph.
representing the enabled interfaces (aka connection providers).
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Misc/Interface
:tnote text='Description'.This map class represents an interface.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.name
:c.Interface Name
:c.&stringObj.
:c.
:row.
:c.library
:c.Library
:c.&stringObj.
:c.
:row.
:c.optionMap
:c.Options
:c.:xph.<Map>:exph. of &stringObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The option names are the keys in the option map.
:li.Valid option names for TCP interfaces are:  :xph.Port:exph.,
:xph.Protocol:exph., and :xph.ConnectTimeout:exph.
:li.Valid option names for the local interface are:  :xph.IPCName:exph.
:eol.
:etnote.
:etable.
:p.