A Service Group is a convenient way of deploying multiple services in one service archive file. There is a logical relationship between the services at runtime. The only difference in the services.xml for a service group and a single service is its root element. For a service group, the root element is <serviceGroup>
, and we have multiple <service>
elements inside the <serviceGroup>
element. For example,
Code Block | ||
---|---|---|
| ||
<serviceGroup> <service name=Test1> ... </service> <service name=Test2> ... </service> </serviceGroup> |
The steps below show how to access and manage service groups.
- Log in to the m anagement console and select Services > List under the Main menu .
- In the Deployed Services page that appears, click the deployed service group(s) link to access the groups.
- The Deployed Service Groups window opens. Click a group to go to its dashboard.
- A typical service group dashboard contains three panels as follow:
Services
The Services Panel lists all the services included in the group. For example,
From here you can:
- Click a service's name and view its dashboard
- View the service's WSDLs
- Test the service using the Try try this service link.
Actions
The following functions are available to manage service groups:
- Managing the parameters of the service group
- Managing the module engagements
- Creating the archive file
- MTOM - By default, MTOM is set to optional. You can set it to True or False. A change of value causes all underline services and operations to change the way they correspond to MTOM.
Managing the parameters of the service group
Anchor | ||||
---|---|---|---|---|
|
Parameters can be defined inside the service's XML as an immediate child element of the service element. These parameters can be accessed using the message context (at the runtime), AxisService or AxisOperation. A parameter has two attributes:
- name - The mandatory Mandatory attribute that specifies the name of a parameter
- locked - Optional attribute. A locked attribute specifies whether we allow the parameter value to be overridden by a child node in the hierarchy
For example, if a parameter is added in the axis2.xml file with the locked attribute set to True, then at the even of a service trying to add another parameter with the same name, it throws an exception.
You can add a new service group parameters using the Add New... button.
Managing the
Module Engagementsmodule engagements
Anchor |
---|
|
Sometimes, you want to engage the WS-security module into a service in order to run it. Engaging a module is just a matter of adding a module tag into the services service's XML. If the module is available, then the engaging will take placeit will be engaged, else it will be a faulty service.
Follow the instructions steps below to engage a module into a service group.1.
- In the
- Actions
- panel, select
- Modules.
2.
- Select a module
- and click engage . WSO2
- DSS provides the following modules
- for service groups.
- WSO2xfer-3.20 - Is an implementation of WS-Transfer
- WSO2mex-3.20 - Provides
MetadataExchange
services for any services that the module is engaged
- WSO2mex-3.20 - Provides
- to
- rampart-1.61-wso2v1 - Provides the WS-Security and WS-SecureConversation
- to
- functionality for Axis2, based on Apache WSS4J, Apache XML-Security and Apache Rahas implementations
- sandesha1-3.20
- rahas-1.61-wso2v1 -
- Used to enable STS
- in a service
- . It adds the
-
Request SecurityToken
operation to a service that the module is engaged to.
-
3. A message appears if the module is successfully engaged. Click "OK."
Creating the Archive File
Creating an archive file
Anchor | ||||
---|---|---|---|---|
|
Click "Using the Create Service Archive" on the "Service Group Dashboard" page and it will create the service archive file.
You will be prompted to save the file (test.aar in this case) somewhere in your machine.
Using this link option, you can create an Axis2 archive file out of all the configurations available to a given service group. Before shipping deploying the service to in a production environment, users you can test the validity of its functions such as parameters, module engagement, polices etc.
However, currently this feature can archive This feature archives only an .aar service . The WSO2 Application Server does not support archiving files with XML formatted description, such as POJO. Also, an archive can be created only at the moment. Also, it only creates an archive to a service group; not to an individual service. Because a service group is mapped to a physical .aar, it is logical to create an archive to an entire a service group.