Working with Web Services in JaxView

You use the Services tab in the Main JaxView view to add and edit Web service descriptions. There are two ways to add Web services to JaxView:

The following sections describe how to manually add a Web service definition to the Services object tree and the configuration properties for Web service objects in JaxView.

Adding Web Service Definitions to JaxView

You add new Web service definitions to the Services node of the Services object tree. Web service nodes must be added to Group nodes in the Services tree. You must create a group node into which the services can be assigned. You can do this by adding group nodes to the Services node directly. You can also define a group in the Add Web Service form when adding a new Web service.

To add a new Web service definition:

1. Select the Services tab from the Main View navigation menu

2. Click on the Services root node in the left side object tree menu

3. Right-click the mouse to display the action menu for the node and select Add SOAP Service or Add REST Service depending on the type of services you are monitoring. The Add Web Service page for the selected service type is displayed in the right panel

4. Complete the form as indicated to define the address where and how the service can be reached. Expand and complete the WSDL Authentication section if JaxView must use HTTP basic authentication to retrieve the WSDL information.

5. In the Groups sub panel, enter the name of a group node that should be created to contain the Web service definition node in the New Group Name box. To use an existing group node, use the Select Group drop down list to select the group name.

6. To assign JaxView monitors to this service, use the Monitors to Assign sub panel to select which monitor definitions you want to add to this service.

7. Click the Add button near the bottom of the form. JaxView will attempt to communicate with the Web service producer or the designated message relay agent. If it is successful, the new service definition is added to the Services object tree.

The following sections describe the service configuration properties you use to add Web service definitions to JaxView.

Note: Additional properties for a Web service definition become available after the service definition has been added to the object tree. See the section Editing Web Service Definitions for more information.

Service Definition Properties

The following describes the configuration properties for the Add SOAP Web Service form. Click on the triangle arrow icon on the left end of any subpanel bar to expand or collapse the subpanel.

WSDL URL:

Input the URL of to the WSDL file for the specific Web service to be added to JaxView.

WSDL Authentication

Use this subpanel to enter a username and password if JaxView must use basic HTTP authentication in order to retrieve the WSDL information.

Service Proxy Port :

If JaxView needs to access the WSDL URL through a proxy server, enter the proxy server address here.

Groups:

Use this section to enter the name of a new Group node for this Web service by entering a name in the New Group Name field. Alternately, use the Select Group drop down menu to select the name of an existing Group node to which you want this Web service added.

Cluster Server Addresses:

If the target Web service is deployed in a cluster of servers and you want to be able to watch the performance of individual service endpoints within the cluster, use this section to specify the individual server addresses. Click the down arrow icon at the left side of the section to expand the section. Enter the addresses for the individual servers in the cluster in the fields provided. JaxView will create a separate Service object node for each server address specified in this section. The name displayed for each service endpoint in the cluster will include a unique server identifier appended to the service name in the JaxView interface.

Monitors to Assign:

Check the monitor types in this list that you want to assign to the target Web service. JaxView will automatically assign those monitors to every operation defined for the Web service in the WSDL file.

REST Service Properties

The following describes the configuration properties for the Add REST Web Service form.

Service Location:

Enter the URL Location of the service. This is the location where the request is originally intended to go. This should include the full URL of the request to the service. For example . http://ws.weather.com/getWeatherService/GetWeatherByZip?zipCode=80304

Note: In case of a open GIS format this will be the getCapabilities request such as http://<server>/geoserver/wfs?request=GetCapabilities

Service Name:

The name of the service as it appears in the URL of the request from the client. For example if the URL is http://myServer:9999/myService/muoperation?test=return the Service Name would be myService in this case.

Fault Element Name:

Enter the Fault Element name for this Web service, if any. For example, if during a service fault condition there is a specific element name that denotes the fault that gets generated. JaxView will use this name to distinguish between the messages with faults and without for monitoring fault performance.

Service Type:

This is the type of service. Currently JaxView supports OpenGIS standard (http://www.opengeospatial.org/) WFS, and WMS, as another non-SOAP service. JaxView also supports basic Servlet or CGI's. For these types select "Other" in the drop down.

Unique port for this service:

Enter the port that the JaxView proxy server will listen on for requests from clients making requests to this Web service. The default is port 9595. You can change this port to a different port. You can also create a different port for each REST service added. This port needs to be unique for the service if using SSL and certificates.
Note:Using this option could have an impact on performance.

Groups:

Use this section to enter the name of a new Group node for this Web service by entering a name in the New Group Name field. Alternately, use the Select Group drop down menu to select the name of an existing Group node to which you want this Web service added.

Cluster Server Addresses:

Use this section to define the addresses for a cluster of servers if the target Web service is deployed in a cluster. Click the down arrow icon at the left side of the section to expand the section.

Operations:

This is the list of operations for this service. Name of all operations for this service, exactly as the appear in the service URL. If same as service name then leave blank. For example: If URL is http://ws.weather.com/getWeatherService/GetWeatherByZip?zipCode=80304 then you can put GetWeatherByZip in this field.

Monitors to Assign:

Check the monitor types in this list that you want to assign to the target Web service. JaxView will automatically assign those monitors to every operation defined for the Web service in the WSDL file.

Editing Web Service Definitions

Each node in the Service object tree has an associated action menu. You use the Edit action to change service addresses, WSDL information, and to define and manage security and governance policies. Several of these options are only available after the service definition has been added to JaxView.

To edit a Web service definition:

1. Select the Service tab from the tab navigation menu. The Service View is displayed.
2. Select the Service node for the Web service definition you want to edit in the object tree and then click the right mouse button. The node action menu is displayed.
3. Click the Edit item from the list. The Edit Web Service form is displayed in the right side panel.
4. Make the desired changes to the properties. See the sections below for for a description of the additional properties that can be changed.
5. To define security or other governance policies for a Web service in JaxView, use the applicable Policy subpanels. See the section Applying Governance Policies to Services for more information on working with policies.
6. Click the Save button to record the changes.

Additional Web Service Definition Properties

Service Name:

This is the service name as derived from the WSDL. Usually, this is also the name of the class file that implements the service interface.

WSDL Location:

This field displays the address or location of the WSDL fo the Web service. Normally, this will be the same value as when the service definition was added in JaxView. You can change this address to use a different address or a file in the filesystem. The WSDL needs to be accessible to the JaxView server.

Service URL:

This field displays the endpoint address of the Web service. This value is derived from the WSDL information when the Web service definition was added to JaxView.

Virtual Service Location:

This field displays the proxied service location for the Web service. This is the address that should be used by clients that are to access the Web service using JaxView as the service proxy. This value is generated by JaxView based on information it gathers about the server where jaxView is running. These values can be changed in the Edit Web Service form.

Proxy Port For Service:

This displays the port number on the JaxView server that is used to receive requests for this Web service. When JaxView is used as a proxy to virtualize Web services, client applications should use this port number when making requests to the Web service so that the requests will be routed through JaxView. The default port number is 9595

Service Alias:

Use this field to enter an service display alias name for the Web service definition in JaxView. This can be helpful if the class name of a service is not very descriptive of its purpose, role, or scope. This alias is only used internally to JaxView and is displayed only in the Service Object tree. Please avoid using duplicate aliases for different Web service definitions.

WSDL Authentication

Optional. Expand this subpanel to enter or change the username and password that JaxView must use in order to retrieve the WSDL information using basic HTTP authentication.

Policies

This section of the form displays a number of folded subpanels used to define governance policies for Web services in JaxView. See the section Applying Policies to Services in JaxView for more information about Policies.