Management
This chapter describes the WebService gateway utilities, and commands for restarting the gateway or viewing its status information.
1. Commands
Commands are divided into commands for displaying the status information and commands for dynamic configuration.
1.1. wsgwinfo
The WSGW status information can be viewed using the basic information and additional commands provided by wsgwinfo in tmadmin.
When wsgwinfo is entered in tmadmin, all WebService gateway information is displayed. The information includes the WebService gateway startup time (load_time), the number of current clients (current_client), and the maximum time spent in processing a request (max_attach_time).
-
Usage
The following is an example of using the command.
wsgwinfo [-i svrid[svrid]]
If no option is used, then the gateway information of all web services are displayed.
-
Example
If the [-i] option is used, only the WebService gateway information of the svrid is displayed.
wsgwinfo –i 0 1 2
1.2. wsgwreload
The service configuration or the WebService gateway configuration may need to be changed while Tmax is running. The wsgwreload command of tmadmin can be used to apply changes at runtime. When the command is executed, the WebService gateway does not respond to any additional requests. It processes requests that are already being processed, and then applies the configuration changes before processing any subsequent requests.
The sgwreload command reloads configuration for all WebService gateways. The wsgwreload command can be used with the [i] option, which specifies a server ID list, to reload configuration for only the specified WebService gateway(s).
wsgwreload –i 0 1 2
2. Utilities
The following describes the web service related utilities provided by Tmax.
| Utility | Description |
|---|---|
Converts the service information file (text) to a service information binary file. |
|
Converts the service information binary file to a service information file (text). |
|
Creates the WSDL document that describes web service functionality. |
2.1. tmmbfgen
his command converts the service information file (text) to a service information binary file. Since the user created service information file cannot be used in the WebService gateway and xwsdlgen, a new file must be created using tmmbfgen.
The file created by tmmbfgen is called the service information binary file. The tmmbfgen command performs validation check by checking the syntax and parameter types before the file is referenced by the WebService gateway. In addition, the text file can be managed by dividing it into multiple parts.
-
Usage
tmmbfgen [-r text_file,] [-i text_file] [-d svc] -o binary_file -r
Item Description [-i text_file]
Service information file (text).
[-d svc]
Service name list to delete.
-o binary_file
Service information binary file (default: sample) to create (update).
-
Example
-
The following is an example of creating a new service information binary file. Create a sample file and add the service information from sample1.txt and sample2.txt.
tmmbfgen -r sample1.txt,sample2.txt -o sample
-
The following is an example of adding information to the existing service information binary file.
Add the service information defined in sample3.txt to the existing sample file. If the service already exists, the new information overwrites the existing information.
tmmbfgen -i sample3.txt -o sample
-
The following is an example of deleting a specific service from the service information binary.
Delete SVC1 and SVC2 services from the sample file.
tmmbfgen -d SVC1,SVC2 -o sample
-
2.2. untmmbfgen
This command converts the service information binary file to a service information file (text).
-
Usage
untmmbfgen -i binary_meta_file -o text_file
Item Description -i binary_meta_file
Service information binary file.
-o text_file
System information file (text) to create.
-
Example
The following is an example of using untmmbfgen to convert the service information binary file back to a readable file.
untmmbfgen -i sample -o unsample.txt
2.3. xwsdlgen
This command creates the WSDL document that describes the web service functionality. 1.1 and 2.0 exist in the current WSDL document. The command uses the WebService gateway environment configuration and the service information binary file options to create the WSDL file.
-
Usage
xwsdlgen [options] -g wsgw_config_file -m binary_meta_file -o wsdl_file
-
Options
Item Description w version
Options are:
-
0 : WSDL1.1 (default)
-
1 : WSDL2.0
b binding_style
Options are:
-
0 : rpc (default)
-
1 : document
-
-
Configuration Items
Item Description - g wsgw_config_file
WebService gateway environment configuration file.
- m binary_meta_file
Service information binary file.
- o wsdl_file
WSDL file to create.
-