Invoking an external service through Try It
The Try It tool is provided by WSO2 as a quick and easy way to test your Axis2 or JAX-WS services using its WSDL. You can also test any service that has a publicly-available WSDL of document/literal format as well. Try It provides you with a mechanism to test your WSDL by creating endpoints on the fly. It helps to test a WSDL before actually coding it, without the need of a third-party WSDL validator tool. This functionality is provided by the following feature of the WSO2 feature repository:
Name: WSO2 Carbon - Try It Feature
Identifier: org.wso2.carbon.tryit.feature.group
If the above feature is not included in your product by default, you can install it using the instructions given in section Feature Management.
The Try It tool does not support relative schema imports and WSDL imports at the moment. WSO2 will provide this feature in a future release.
Follow the instructions below to invoke the Try It tool.
- Log on to the product's management console.
- On the Tools menu, click Try It.
- Type or paste the location of the WSDL.
This may be a local file system path or a web URL.
Click Try It.
If your browser has "Pop up-Blocking" enabled, you will receive a message saying a pop up was blocked. Allow pop ups for the current domain and try again. The available operations in the given WSDL appears. For operations that take arguments you will see primitive argument-type fields. The values specified in these fields will be passed to the operations. For no-argument operations you will only see a button with the same name as the operation.- There are two text areas on the Try It page, each for request and response. You can switch the layout using either Horizontal or Vertical buttons.
- Fill in the necessary parameters.
- Click Send to invoke the operation.
The return value immediately appears in the response text area. For more information, see Try It Tool#Customizing Try It options.
Invoking Try It through a Axis web service's dashboard
The Try It page is a full Ajax client and interacts with the service just as any other client would, so it is a good way to verify that a service not only works, but is reachable by its clients. However, note that the Try It page attempts to contact the Web service at the endpoint URL provided. If the domain or URL scheme of the service is different from the endpoint, the browser may impose security restrictions. In this case, the Try It falls back to using a script-injection protocol to tunnel the Web service request. A wire trace of the communication with the browser will not show the actual Web service messages used to communicate with the service.
In addition, since the Try It page is fully asynchronous, it doesn't block while a Web service is being invoked. You can invoke several operations before one of them completes (though it does not have a way to display the results of the same operation invoked multiple times).
The Try It tool can also be invoked from the dashboard of a selected service. Service dashboard is part of the service management functionality provided by the following feature:
Name : WSO2 Carbon - Service Management Feature
Identifier : org.wso2.carbon.service.mgt.feature.group
The above feature is bundled by default in all service-hosting WSO2 middleware products. If the product you are using does not have this feature installed, you can do so by following the instructions given in section Feature Management.
Follow the instructions below to try out the WSDL of a selected service.
- Log on to the product's management console.
- On the Main menu, under Services, click List.
The Deployed Services page appears, which lists out all the currently active services. - Click the Try this service link, respective to the selected service.
The Try this service link is also available when viewing the respective service dashboard.
When you click the Try this service link, you will be directed to the page where the operations available for your service will be displayed. When you give the parameters for the operation, a button corresponding to your service appears. You can check whether your service provides the desired output by using this option. For more information, see the steps from Step 5 to 7 and Try It Tool#Customizing Try It options.
The Try It page of a service can also be invoked by appending the service's endpoint reference with the string "tryit?". For example, http://<your-machine-ip>:<server port>/services/<service name>?tryit
Invoking Try It through a JAX-WS application's dashboard
The Try It tool can also be invoked from the dashboard of a selected JAX-WS application. JAX-WS application dashboard is part of the application management functionality provided by the following feature:
Name : WSO2 Carbon - Service Management Feature
Identifier : org.wso2.carbon.service.mgt.feature.group
The above feature is bundled by default in all service-hosting WSO2 middleware products. If the product you are using does not have this feature installed, you can do so by following the instructions given in section Feature Management.
Follow the instructions below to try out the WSDL of a selected application.
- Log on to the product's management console.
- On the Main menu, under Applications, click List.
The Running Applications page appears, which lists out all the currently active applications. - Click on the respective JAX-WS application.
The application dashboard will appear. - Click the Try this service link.
When you click the Try this service link, you will be directed to the page where the operations available for your service will be displayed. When you give the parameters for the operation, a button corresponding to your service appears. You can check whether your service provides the desired output by using this option. For more information, see the steps from Step 5 to 7 and Try It Tool#Customizing Try It options.
Customizing Try It options
Choosing endpoints
- Click the "Using Enpoint - ...." link.
- Select a new endpoint from the list.
- Specify the address of the new endpoint.
Viewing the service information
Prioritizing Operations
Use the small yellow icon with the plus (+) sign to prioritize operation.
The chosen operation is added to the Priority Operations section.
This will be useful when you have a lot of operations in the Try It page. In such a scenario, you can add the operations you want into this section and switch among them easily.