WSO2 Web Services Application Server (WSO2 WSAS) for Java, v1.1- Administrator's Guide

This document will provide you with information & instructions on the functionality of Management Console of WSO2 WSAS for Java .

Your feedback on WSO2 WSAS for Java is most appreciated. Please send them to our mailing lists.

Content

Introduction

WSO2 WSAS is a lightweight, high performant and integrated Web services middleware platform.

To learn more about WSO2 WSAS see here.

WSO2 WSAS Management Console is your one stop shop to administer the WSO2 Web Services Application Server. You can administer/configure your modules/services as well as monitor the system through this interface.

WSO2 WSAS for Java Management Console runs on AJAX (Asynchronous Javascript and XML) and SOAP, making it a fast administration tool. All the functionality is provided by a set of web services exposed by the WSO2 WSAS.

The functionality of this Management Console is described in detail below.

Signing In

Once WSO2 WSAS for Java, v1.1 is successfully installed (See Installation Guide for installation details), start the WSO2 WSAS server, launch a Web browser instance and point it to the URL https://localhost:9443/ (for the Standalone Edition) or https://localhost:9443/wso2wsas/ (for the Servlet Edition) if you are using the default settings. This will take you to the "Sign In" page of WSO2 WSAS Management Console as shown below.

Note: WSO2 WSAS has two transport listeners: HTTP and HTTPS. The HTTP listener opens on port 9762, while the HTTPS listener opens on port 9443, by default. The admin functionality is exposed only via the HTTPS port.

Read all WSO2 WSAS for Java documents by pointing your Web browser to https://localhost:9443/docs (for the Standalone Edition) or https://localhost:9443/wso2wsas/docs (for the Servlet Edition) if you are using the default settings

Figure:Sign-In Page

Figure: Sign-In Page

The default username and password to sign in to WSO2 WSAS for Java Management Console:

User name : admin

Password : admin

To solve any problems with signing in click on "sign-in Help"

The Sign In page contains links to the "FAQ" and the "about WSO2 WSAS" page which gives an introduction about WSO2 WSAS and WSO2 Inc.

Navigation Bar

The following links are available on the navigation bar

Home

Home Page of the Management Console will contain following useful system and service information on WSO2 WSAS.

Figure1:WSO2 WSAS for Java HOME

Figure: WSO2 WSAS for Java HOME

Manage Services

Figure:Services and Service Group Management

Figure: Services and Service Group Management

As shown above, this page will list each of the services available, rather deployed in each service group of this system along with links to view WSDL both 1.1, Schema, Policy and Certificate (containing public key if the service has been signed using a private key) of each service.

This page also carries a link that displays RSS an Atom feeds.

Figure:View WSDL 1.1 of service echo

Figure: View WSDL 1.1 of Service echo

Remove Service Group:

A service group can be removed using the 'Remove' action icon listed for each service group, in which case all the services in that particular service archive will be removed from system.

Deploying Services:

Upload a New Service (.aar, .jar or .zip)

The most important feature of this page is the ability to deploy and manage services. In the case where the service archive of the relevant service is an .aar you can deploy the service by simply selecting the service archive using 'Browse' button, then uploading service using the 'Upload' button. For example, Axis2 packages services as .aar files. You can simply deploy an Axis2 service by uploading the relevant .aar file.

Where the service archive of the relevant service is a .jar or .zip file then deployment requires a few more steps. In this case you must select the service archive using 'Browse' button, then upload service using the 'Upload' button, where in doing so a page containing the classes of the archive will appear as shown below. Here you need to select the relevant classes of the web services you wish to deploy, by clicking on the corresponding check boxes. Once you have selected all the classes, click on 'Generate' button to deploy the relevant services. This process is called Dynamic Service Generation.

Figure: Dynamic Services Generation-Uploading .jar or .zip File

Figure: Dynamic Service Generation-Uploading .jar or .zip File

Upload a New Spring Service (.xml and .jar)

Likewise you can also deploy Spring services by browsing for and uploading relevant .xml and .jar files. Deploying Spring services follow the Dynamic Service Generation procedure as explained before.

Figure: Dynamic Service Generation for Spring Service-Uploading.xml or .jar File

Figure: Dynamic Service Generation for Spring Service-Uploading .xml or .jar File

If services were successfully deployed, then a message will appear saying so. The service that you deployed will now be listed on the main page of 'Manage Services' (as shown in Figure: Services and Service Group Management).

RSS Feed:

RSS feed gives the subscriber updates about any status changes in services in WSO2 WSAS. These include activation, de-activation, removal, etc. of the services. The RSS standard that is used is 2.0.

Figure:RSS Feed Page

Figure: RSS Feed Page

Atom Feed:

Atom feed gives the subscriber updates about any status changes in services in WSO2 WSAS. These include activation, de-activation, removal, etc. of the services. The Atom standard that is used is 2.0.


Figure:Atom Feed Page

Deleting Faulty Services:

If a faulty service is deployed it will be displayed in this Available Services page as [n] faulty service(s):

Click on the faulty service link and it will take you to a page as shown below where details of the faulty service(s) will be listed. By using the 'Delete Faulty Service' icon on this page you will be able to delete the deployed faulty service.

Figure: Deleting Faulty Services

Figure: Deleting Faulty Services

Service Group Management:

Clicking on the Service Group in of the main page of "Manage Services" (as shown in Figure:Services and Service Group Management) will take you to a page that allows you to:

Figure: Service Group Management-Engage Module

Figure: Service Group Management-Engage Module

Service Management:

Clicking on the Service of a specific Service Group of the main page of "Mange Services" (as shown in Figure:Services and Service Group Management) will take you to a page that not only contains certain service specific information, but also allows you to manage services.

Figure: Service Management

Figure: Service Management Page

Service information will consist of:

The service managementoptions that are available are as follows:

Figure: Application GUI

Manage Modules

On this page you can view all the modules available for engagement in the system. It will give name, version and description of the modules. Each module can be removed using the "Remove module" icon and can be globally engaged/disengaged through the "Globally engage/disengage" icon.

One a module is globally engaged it will be listed under the "Globally Engaged Modules" list.

When you remove a module that module will be completely removed from the system. That is, the module handlers will be removed from the handler chain and the module mar file will be deleted. However if you disable a module then the module will be still in the system while the handlers from that module will be removed from the handler chain.

You can upload a new module by using the 'Browse' button to browse for the .mar file (module archive) and upload using 'Upload' button. The uploaded module will be added to the topmost list of available modules with options to "Engage globally" or 'Remove module'.

Figure:Globally Engage Modules

Figure: Globally Engage Modules

When you click on the module name it takes you to a page where module configuration is possible. Module configuration is done through parameter configuration and policy configuration. The page also lists module information such as module ID, version, description and whether the fact that the module is globally engaged or not.

Figure:Module Information and Configuration

Figure: Module Information and Configuration

When the Configure Parameters link is clicked, the page that appears will contain editable parameters allowing you to add or update parameters using 'Add' or 'Update' buttons.

Figure: Module Parameter Configuration

Figure: Module Parameter Configuration

In the case where there are no editable parameters, page will say that there are no editable parameters found, with the option of adding a new parameter using the 'Add' button.

Figure:Module Parameter Configuration- No Parameters Found

Figure: Module Parameter Configuration- No Parameters Found

Similarly, when the 'Configure Policies' link in "Figure: Module Information and Configuration" is clicked you would obtain the following page where policies are present. You can edit in the text area itself and update any changes using the 'Update' button. If there are no policies for the module then page will read as "No module policies found."

Figure:Module Policy Configuration

Figure: Module Policy Configuration

Manage Security

This page will list areas of security management, currently User and Role management.

  1. Role Management - Create new roles and edit existing roles.
  2. User Management - Create new users, assign roles to users and edit existing users.

Figure:Security Management Main Page

Figure: Security Management Main Page

Role Management:

Clicking on the Role Management link will take you to a page that consists of a list of existing role names with the option of adding new role names. This is done by typing in new role name and clicking on 'Add' button. If role was added successfully an alert message will pop up.

You can also delete a role by using the "Delete Role" icon.

Figure:Role Management

Figure: Role Management

User Management:

User Management link will take you to a page with a list of present users with the option of adding in new users to this list. In order to add a new user, Username, Password & Confirm password (same as password) need to be typed in and user role selected from the list, then click on the 'Add' button. If the user was added successfully an alert message will pop up saying so.

Note that user role list contains all role names listed in Role Management page from which new roles can be added as well.

Figure:User Management

Figure: User Management

The present users list comes with columns of "User Name", "user Description, "User Actions", "User Role" and "User Role Actions". User Actions contain "Edit" and "Delete User" icons.

Clicking on "Edit" icon will take you to a page that allows you to edit corresponding user- change the role name of the user and reset password. Once new user role is selected from the list in order to update change click on 'Update Role' button. If role has been successfully changed an alert message will pop up saying so. To reset the password, the new password & the confirmation of new password (same as new password) should be correctly typed in, then click on 'Reset Password' button. If password was reset successfully an alter message will pop up.

Figure:User Management-Edit User

Figure: User Management- Edit User

Using "Delete user" icon you can delete the corresponding user. Using "Delete Role" icon under the "User Role Actions" column one can delete the user role.

Manage Transports

This page lists the https and http transports available, their names and values.

Figure:Transport Management

Figure: Transport Management

Manage Key Stores

This page allows you Key Store management. It lists the available key stores, name, type and actions- "Importing Certificates" and "Delete Key Store", which removes the key store.

The page also contains instructions to add a key store. This is a 3 step process:

  1. Upload key store file
  2. Enter Password for Private Key 'client'
  3. Key store upload complete

Figure:Key Store Management

Figure:Key Store Management

Click on "Import Certificate" icon and it will take you to the page below. Here you have option of adding a certificate- "Browse" and "Upload". Imported certificate too will be listed here.

Figure:Import Certificate for Key Store

Figure:Import Certificate for Key Store

Manage Logging

This page contains server settings for logging. Logging settings include Log4J Loggers and Log4J Appenders. Loggers filter log messages to Appenders, while Appenders filter the messages for the second time before writing to the log files.

Configure Log4J Loggers:

Log4J Loggers contain the values- Name, Log Level and Additivity. Log level list contains TRACE, INFO, DEBUG, WARN, ERROR, FATAL and OFF from which any one can be selected. Once you select a Log Level, only messages at that level and below will be logged. For example, if you select Log Level ERROR, then all ERROR and FATAL messages will be logged, rather passed on to the Appender. Switching on Additivity allows to inherit all the Appenders of the parent Logger.

Configure Log4J Appenders:

Log4J Appenders include values for Appender Name, Log level, known as Threshold in this case, Log Pattern and Log File.

The Threshold list is the same as Log Level in Loggers in name and action. The Log Pattern allows you to edit the format or the layout in which the logs are created. You can have a look at the log4j PatternLayout page to get the meanings of the values that are used in the log pattern. Finally you can change the location of the log file with the Log File option.

Global Log4J Configuration:

Note that using the Global Log4J Configuration options you can set Log Level and Log Pattern of Log4J Appenders and Loggers to the same value in one go.

Values for the above 3 settings can be edited/changed and updated using Update button.

Figure:Logging Management

Figure: Logging Management

Restart Server

Figure:Restart Server

Figure: Restart Server

Monitor System

Figure: Monitor System

Figure: Monitor System

Monitor Statistics

This page shows some statistics related to the WSO2 WSAS instance. These include Free memory, Request count, Server name, Server start time, System up time, Active services, Total memory, Average response time, Minimum response time and the Maximum response time.

Figure: Monitor Statistics

Figure: Monitor Statistics

Monitor Logs

The system log can be viewed on this page. Log entries will be categorized into information messages, warning messages, error messages, fatal error messages & debug messages.

Figure:Monitor Logs

Figure: Monitor Logs

Monitor Tracer

This tracer shows the soap messages, their respective SOAP message requests and responses when services are deployed on the server and their operations invoked. Make sure that the messages are monitored by turning the SOAP Tracer ON. By default it is switched OFF. You can switch it on by selecting the ON value in the list box.

Warning:Turning this ON will have a performance hit, since all SOAP messages will be always completely built (i.e. deferred building will not be done) and stored in the database by WSO2 WSAS hence this option should be used with caution.

Figure:Turn ON SOAP Tracer

Figure: Turn ON SOAP Tracer

The tracer will only show the messages of operations invoked after point of switching ON the SOAP tracing.

Using this SOAP tracer it is possible to see SOAP messages with their time-stamps, service name, operation invoked and the number of requests to the server. The most recent SOAP messages are listed on the top. When a particular SOAP message is selected it's Request and the Response can be viewed in collapsible/expandable text boxes.

Note: This tracer does not apply to operations invoked in the admin services, as they are filtered out.

Soap Tracer- Request/Response Messages

Figure: SOAP Tracer- Request/Response Messages

Monitor Flows

Monitor Flows- Graphical View

Figure: Monitor Flows- Graphical View

Using the "Text View" link on the top right hand corner of the page you can view the textual representation of In flow, Out flow, In-Out flow, Out-Fault flow SOAP message flows. Using the "Graphical View" link you can go back to the "Monitor Flows- Graphical View".

Monitor Flows- Textual View

Figure: Monitor Flows- Textual View

Miscellaneous

Signing Out

Once signed in, in order to sign out form the system simply click on the Sign Out link on the right hand-top end of any page.

Register

You can register your WSO2 WSAS instance by clicking on this link. By registering you will be providing the developers with valuable information to make WSO2 WSAS a better product. Only information that is shown to you on the Register Product page will be submitted to the server and you can change the information that is extracted from your WSO2 WSAS instance before you submit them to the server, if you wish to do so.

Figure:Registration Page

Figure: Registration Page