Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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
languagehtml/xml
<serviceGroup>
   <service name=Test1>
     ...
   </service>
   <service name=Test2>
     ...
   </service>
</serviceGroup>

Follow the instructions below The steps below show how to access and manage service groups.  

Accessing Service Groups

1.

  1. Log
on
  1. in to the
product's "
  1. m anagement console and select
 
  1. Services
-
  1. > List
"
  1.   under the
"
  1. Main
"

Image Removed

2. The "
  1. menu.
  1.  
  2. In the Deployed Services
"
  1. page that appears
. Click on
  1. , click the
"
  1. deployed service group(s)
"
  1. link to access the
Deployed Service
  1. groups.
  1. Image Modified  
3. In the "
  1. The Deployed Service Groups
" page, click on the necessary service group. For example,

Image Removed

4. The "Service Group Dashboard" page appears. For example,

Image Removed

It
  1. window opens. Click a group to go to its dashboard.  
  2. A typical service group dashboard contains three panels as follow:
Service Group DetailsService Group Details  

The "Service Group Details" panel shows the name of the service group.

Image Removed

anchorService Group Details Anchor

Services

ServicesServices

The " Services " Panel lists all the services included in the group. For example,

From here you can:

Actions AnchorActions

Actions

 

The following functions are available to manage the service groups:

Image Added

Image Removed

Managing the

Parameters

parameters of the

Service Group

service group
Anchor
Managing the parameters of the service group
Managing the parameters of the service group
 

1. In the "Service Group Dashboard", select "Parameters."

Image Removed

2. Parameters can be defined inside the services 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 which that specifies the name of a parameter.
  • locked - The optional Optional attribute. The idea of a "A locked " attribute is to express 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 setting with the " locked " attribute set to " True, " then at the even of a service trying to add another parameter with the same name, it gives throws an exception.

The WSO2 Carbon provides an easy method to generate the Service Group parameters.

Click on the "Add New..." button to generate a new service parameter.

Image Removed

3. Enter the parameter's name and click "OK" to add the parameter to the list.

Image Removed

4. Enter the parameter's value and click on the "Update."

5. If you want to delete a parameter, click on the "Delete" button.

Image Removed

6. Confirm your request by clicking "Yes" in the message that prompts.

Image Removed

Managing the Module Engagements AnchorManaging the module engagementsManaging the module engagements 

There may be some instances where it's impossible to run the service without engaging the WS-Security module into the serviceYou can add a new service group parameters using the Add New... button.

Managing the module engagements
Anchor
moduleEngagement
moduleEngagement
 

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.

  1. In the
"
  1. Actions
"
  1. panel, select
"
  1. Modules.
"

Image Removed

2.
  1.  
  2.   Select a module
to add
  1. and click engage . WSO2
Carbon
  1. DSS provides the following modules
, which you can engage into your service group
  1. 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
.
    • to
    • rampart-1.61-wso2v1 - Provides the WS-Security and WS-SecureConversation
functionalities
    • functionality for Axis2, based on Apache WSS4J, Apache XML-Security and Apache Rahas implementations
.
    • sandesha1-3.20
    • rahas-1.61-wso2v1 -
Is used
    • Used to enable STS
enable
    • in a service
, where it
    • . It adds the
RequestSecurityToken
    • Request SecurityToken operation to a service that the module is engaged to.
    •  
Image Removed3. A message appears if the module is successfully engaged. Click "OK."

Image Removed

Creating the Archive File

Creating an archive file
Anchor
Creating the archive file
Creating the archive file
 

Click "Using the Create Service Archive" on the "Service Group Dashboard" page and it will create the service archive file.

Image Removed

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.