srvsrv.script

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

:c.Executable
:c.&stringObj. | &noneObj.
:c.
:row.
:c.options
:c.Options
:c.List of &stringObj.
:c.
:row.
:c.parameters
:c.Parameters
:c.&stringObj. | &noneObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The value for "Name" is the name of the service, service
loader, or authenticator.
:li.The value for "Library" will depend on the type of service:
  :ul compact.
  :li.Internal service:  :xph.<Internal>:exph.
  :li.Delegated service:  :xph.<Delegated>:exph.
  :li.External service:  The name of the shared library which implements the
  service or acts as a proxy for the service.  External Java services
  and authenticators will have a library name of :xph.JSTAF:exph..
  :eul.
:li.For external Java services, the value for "Executable" will be the 
name of the Java jar file which implements a service, serviceloader, or authenticator.
For non-proxy services libraries (e.g. internal services, delegated services,
C++ services), the value for "Executable" will be &noneObj..
:li.The value for "Options" is a list of the options specified when
registering the service.
:li.The value for "Parameters" is a string containing the parameters
specified when registering the service or &noneObj. if no parameters
were specified.
:eol.
:etnote.
:etable.
:p.
:li.The result buffer for a :xph.QUERY REQUEST:exph. request will contain
a marshalled :xph.<Map&colon.STAF/Service/Service/QueryRequest>:exph.
representing the specified request.
The map is defined as follows:
:table cols='* * * 2*'.
:tcap.Definition of map class STAF/Service/Service/QueryRequest
:tnote text='Description'.This map class represents a request that has been submitted.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.requestNumber
:c.Request#
:c.&stringObj.
:c.
:row.
:c.state
:c.Request Status
:c.&stringObj.
:c.:xph.'Pending' | 'Complete':exph.
:row.
:c.sourceMachine
:c.Source Machine
:c.&stringObj.
:c.
:row.
:c.sourceHandleName
:c.Source Handle Name
:c.&stringObj.
:c.
:row.
:c.sourceHandle
:c.Source Handle
:c.&stringObj.
:c.
:row.
:c.startTimestamp
:c.Start Date-Time
:c.&stringObj.
:c.&timestampFormat.
:row.
:c.targetMachine
:c.Target Machine
:c.&stringObj.
:c.
:row.
:c.service
:c.Service
:c.&stringObj.
:c.
:row.
:c.request
:c.Request
:c.&stringObj.
:c.
:row.
:c.rc
:c.Return Code
:c.&stringObj. | &noneObj.
:c.
:row.
:c.result
:c.Result
:c.&stringObj. | &noneObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The value for "Request#" is the request number.
:li.The value for "Request Status" is the state of the request.  This will be either
:xph.Pending:exph. or :xph.Complete:exph..
:li.The values for "Source Machine", "Source Handle Name", and "Source Handle" are the
machine endpoint, handle name, and handle number of the process that originated
the request.
:li.The value for "Start Date-Time" is the timestamp when the request started.
:li.The value for "Target Machine" is the machine to which the request was sent, i.e. the
target machine.
:li.The value for "Service" is the service to which the request was sent.
:li.The value for "Request" is the request which was sent.
:li.The value for "Return Code" is the return code from the request.  This will be
&noneObj. if the request status is :xph.Pending:exph..
:li.The value for "Result" is the result buffer from the request.  This will be
&noneObj. if the request status is :xph.Pending:exph..
:eol.
:etnote.
:etable.
:eul.

:h4.Examples
:p.
:ul compact.
:li.:hp2.Goal::ehp2. Query the information for the LOG service (a C++ service).
:p.:hp2.Syntax::ehp2.  :xph.QUERY SERVICE LOG:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Name      : LOG
  Library   : STAFLog
  Executable: <None>
  Options   : []
  Parameters: DEFAULTMAXQUERYRECORDS 50
}
:exmp.
:p.
:li.:hp2.Goal::ehp2. Query the information for the STAX service (a Java service).
:p.:hp2.Syntax::ehp2.  :xph.QUERY SERVICE STAX:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Name      : STAX
  Library   : JSTAF
  Executable: C:\STAF\services\stax\STAX.jar
  Options   : [
    JVMName=STAX
    J2=-Xmx512m
  ]
  Parameters: EXTENSIONXMLFILE C:/STAF/services/stax/extensions.xml
}
:exmp.
:p.
:li.:hp2.Goal::ehp2. Query the information for the authenticator service
named AuthSample.
:p.:hp2.Syntax::ehp2.  :xph.QUERY AUTHENTICATOR AuthSample:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Name      : AUTHSAMPLE
  Library   : JSTAF
  Executable: C:\STAF\authenticators\AuthSample.jar
  Options   : [
    JVMName=Auth
  ]
  Parameters: USERPROPERTIESFILE C:/STAF/authenticators/authsample.properties
}
:exmp.
:p.
:li.:hp2.Goal::ehp2. Query the information for the service loader service
names STAFServiceLoader1.
:p.:hp2.Syntax::ehp2.  :xph.QUERY SERVICELOADER STAFServiceLoader1:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
{
  Name      : STAFSERVICELOADER1
  Library   : STAFDSLS
  Executable: <None>
  Options   : []
  Parameters: <None>
}
:exmp.
:p.
:li.:hp2.Goal::ehp2. Query the information for request number 34.
:p.:hp2.Syntax::ehp2.  :xph.QUERY REQUEST 34:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Request Number    : 34
Request Status    : Pending
Source Machine    : local://local
Source Handle Name: STAF/SERVICE/EM
Source Handle     : 10
Start Date-Time   : 20050321-19:02:28
Target Machine    : server1.company.com
Service           : QUEUE
Request           : GET WAIT
Return Code       : <None>
Result            : <None>
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.ADD
:i3.service service
:h3.ADD
:p.ADD will add (register and initialize) the specified external service and make it
available on the machine.
:h4.Syntax
:xmp.
ADD SERVICE <Service Name> LIBRARY <Library Name> &lbrk.EXECUTE <Executable>&rbrk.
    &lbrk.OPTION <Name&lbrk.=Value&rbrk.>&rbrk.... &lbrk.PARMS <Parameters>&rbrk.
:exmp.
:p.:xph.SERVICE:exph. specifies the name by which this service will be known on this machine. 
:p.:xph.LIBRARY:exph. specifies the name of the shared library / DLL which implements the
service or acts as a proxy for the service. See the information for each
external service to determine the appropriate value for this option. 
:p.:xph.EXECUTE:exph. is used by service proxy libraries / DLLs to specify what the proxy
library should execute. For example, this might be the name of the Java jar file
which actually implements the service. This option has no significance for non-proxy service
libraries. See section :hdref refid=jvmcfg. for information
regarding the JSTAF service proxy library.
Otherwise, see the documentation provided by the service proxy library.
:p.:xph.OPTION:exph. specifies a configuration option that will be passed on to the service
library / DLL. This is typically used by service proxy libraries to further control the
interface to the actual service implementation. You may specify multiple OPTIONs for a given
service. See section :hdref refid=jvmcfg. for acceptable options for
the JSTAF service proxy library.
Otherwise, see the documentation provided with the service (proxy) library. 
:p.:xph.PARMS:exph. specifies optional parameters that will be passed to the service during
initialization. 
:h4.Security
:p.&seclvl. 5.
:h4.Return Codes
:p.All return codes from ADD are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer will contain nothing. 
:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Add the Monitor service, an external C++ service.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.ADD SERVICE Monitor LIBRARY STAFMon:exph.
:p.
:li.:hp2.Goal::ehp2. Add the STAX service, an external Java service, specifying a parameter.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.ADD SERVICE STAX LIBRARY JSTAF EXECUTE C:\STAF\services\STAX.jar PARMS "NUMTHREADS 8":exph.
:eul.
.*
.*---------------------------------------------------------------------
.*
.*:ih1.service commands
.*:ih2.REPLACE
.*:i3.service service
.*:h3.REPLACE
.*:h4.Syntax
.*:p.REPLACE will replace the specified external service with a new service and make it
.*available on the machine.  If the RENAME option is specified, the service being replaced
.*will be renamed and will continue to be available.  If the RENAME option is not specified,
.*the service being replaced is removed, providing an atomic remove/add request.
.*:xmp.
.*REPLACE SERVICE <Service Name> LIBRARY <Library Name> &lbrk.EXECUTE <Executable>&rbrk.
.*        &lbrk.OPTION <Name&lbrk.=Value&rbrk.>&rbrk.... &lbrk.PARMS <Parameters>&rbrk.
.*        &lbrk.RENAME <Service Name>&rbrk.
.*:exmp.
.*:p.:xph.SERVICE:exph. specifies the name of the service to be replaced. 
.*:p.:xph.LIBRARY:exph. specifies the name of the shared library / DLL which implements the
.*new service or acts as a proxy for the service. See the information for each
.*external service to determine the appropriate value for this option. 
.*:p.:xph.EXECUTE:exph. is used by service proxy libraries / DLLs to specify what the proxy
.*library should execute. For example, this might be the name of the Java class
.*which actually implements the service. This option has no significance for non-proxy service
.*libraries. See section :hdref refid=jvmcfg. for information
.*regarding the JSTAF service proxy library.
.*Otherwise, see the documentation provided by the service proxy library.
.*:p.:xph.OPTION:exph. specifies a configuration option that will be passed on to the service
.*library / DLL. This is typically used by service proxy libraries to further control the
.*interface to the actual service implementation. You may specify multiple OPTIONs for a given
.*service. See section :hdref refid=jvmcfg. for acceptable options for
.*the JSTAF service proxy library.
.*Otherwise, see the documentation provided with the service (proxy) library. 
.*:p.:xph.PARMS:exph. specifies optional parameters that will be passed to the service during
.*initialization. 
.*:p.:xph.RENAME:exph. specifies a new name for the service being replaced.
.*:h4.Security
.*:p.&seclvl. 5.
.*:h4.Return Codes
.*:p.All return codes from REPLACE are documented in :hdref refid=retcode..
.*:h4.Results
.*:p.On successful return, the result buffer will contain nothing. 
.*:h4.Examples
.*:p.Goal&colon. Replace the Monitor service, an external C++ service.
.*:xmp.
.*REPLACE SERVICE Monitor LIBRARY STAFMon
.*:exmp.
.*:p.Goal&colon. Replace the Event service, an external Java service.
.*:xmp.
.*REPLACE SERVICE Event LIBRARY JSTAF EXECUTE com.ibm.staf.service.event.EventService
.*:exmp.
.*:p.Goal&colon. Replace the Log service, an external C++ service, renaming it to Log2.
.*:xmp.
.*REPLACE SERVICE Log LIBRARY STAFLog RENAME Log2
.*:exmp.
.*
.*---------------------------------------------------------------------
.*
.*:ih1.service commands
.*:ih2.RENAME
.*:i3.service service
.*:h3.RENAME
.*:h4.Syntax
.*:p.RENAME will rename the specified external service to a new name.
.*:xmp.
.*RENAME SERVICE <Service Name> TO <New Service Name>
.*:exmp.
.*:p.:xph.SERVICE:exph. specifies the name of the service to be renamed. 
.*:p.:xph.TO:exph. specifies a new name for the service.
.*:h4.Security
.*:p.&seclvl. 5.
.*:h4.Return Codes
.*:p.All return codes from RENAME are documented in :hdref refid=retcode..
.*:h4.Results
.*:p.On successful return, the result buffer will contain nothing. 
.*:h4.Examples
.*:p.Goal&colon. Rename the Monitor service, an external C++ service.
.*:xmp.
.*RENAME SERVICE Monitor TO Monitor2
.*:exmp.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.REMOVE
:i3.service service
:h3.REMOVE
:p.REMOVE will remove (unregister and terminate) the specified external service,
 making it no longer available on the machine.
:h4.Syntax
:xmp.
REMOVE SERVICE <Service Name>
:exmp.
:p.:xph.SERVICE:exph. specifies the name of the service to remove. 
:h4.Security
:p.&seclvl. 5.
:h4.Return Codes
:p.All return codes from REMOVE are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer will contain nothing. 
:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Remove the Event service.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.REMOVE SERVICE Event:exph.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih2.FREE
:i3.service service
:h3 id=srvreqf.FREE
:p.FREE returns the results of a completed request that was submitted using
the kSTAFReqQueue or kSTAFReqQueueRetain options (see :hdref refid=apiss2. for
more information).  This command also removes the request from the request list.

:h4.Syntax
:xmp.
FREE REQUEST <Request Number> &lbrk.FORCE&rbrk.
:exmp.
:p.:xph.REQUEST:exph. specifies which request should be freed.
:p.:xph.FORCE:exph. must be specified if any process other than the originating
process tries to :xph.FREE:exph. the request's results.

:h4.Security
:p.&seclvl. 5.

:h4.Return Codes
:p.All return codes from FREE are documented in :hdref refid=retcode..

:h4.Results
:p.
If successful, the result buffer for a :xph.FREE:exph. request will contain
a marshalled :xph.<Map&colon.STAF/Service/Service/FreeRequestInfo>:exph.
representing the results of the completed request.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Service/QueryRequest
:tnote text='Description'.This map class represents the results of a completed request.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.rc
:c.Return Code
:c.&stringObj.
:c.
:row.
:c.result
:c.Result
:c.&stringObj.
:c.
:tnote text='Notes'.
:ol compact.
:li.The value for "Return Code" is the return code from the request.
:li.The value for "Result" is the result buffer from the request.
:eol.
:etnote.
:etable.

:h4.Examples
:p.
:ul compact.
:li.:hp2.Goal::ehp2. Free request 16.  Let's assume this was a :xph.VERSION:exph.
request to the :xph.MISC:exph. service.
:p.:hp2.Syntax::ehp2.  :xph.FREE REQUEST 16:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
Return Code: 0
Result     : 3.0.0
:exmp.
:eul.