Building and Packaging Web Services

This section discusses the targets (websphereWebServices and weblogicWebServices) for building the web services EAR file.

The steps in this build process are:

1. Package global WAR file directories: lib, conf, modules;
2. Iterate over the web service directories in build/svr/gen/wsc2 (one directory per web service class) created by the generator:
   • Process the properties in the following order: custom, generator, defaults (see Inbound Web Service Properties File for more information);
   • Generate the services.xml descriptor file, unless a custom services.xml has been provided (see Deployment Descriptor File for more information);
   • Package the web service directory.

The following properties and customizations are available:

• Generation of the webservices2.war can be turned off by setting property: disable.axis2.build;
• You can specify an alternate location for the build to read in additional or custom Axis2 module files by setting the axis2.modules.dir property that will contain all the .mar files and the modules.list file to be copied into the WEB-INF\modules directory;
• You can include additional, external content into the webservices.war by either of the following properties:
  • axis2.include.location - that points to a directory containing a structure mapping to the the Axis2 WAR file directory structure;
  • axis2.include.zip - that points to a zip file containing a structure mapping to the Axis2 WAR file directory structure.

  In conjunction with either of the two properties above, setting the axis2.include.overwrite property will cause these contents to override the IBM Cúram Social Program Management -packaged content in the WAR file. This capability is for including additional content into your WAR file. An example of how you might use this would be to include the sample Version service to enable Axis2 to successfully validate the environment (see Axis2 Environment Validation).

  For example, to include the sample Version web service for IBM® WebSphere® Application Server you need to create a directory structure that maps to the webservices2.war file and includes the structure of Version.aar file as is shipped in the Axis2 binary distribution: axis2-1.5.1-bin/repository/services/version.aar. That structure would look like this:

  + WEB-INF
          + services
            + Version
              + META-INF
                - ./services.xml
              + sample
                + axisversion
                  - ./Version.class

  Then, if the location of the Version directory were in C:\Axis2-includes, you would specify the following property value at build time: -Daxis2.include.location=C:\Axis2-includes. Alternatively, you could package the above file structure into a zip file and specify the -Daxis2.include.zip property instead. In both cases the file structure specified would be overlaid onto the file structure (depending on the value of axis2.include.overwrite) and packaged into the webservice2.war WAR file. (For Oracle WebLogic Server the above would be changed to replace the contents of the Version directory with a Version.aar file, which is a compressed file.)

• You can set global, default web services credentials at build time via the following properties set in your Bootstrap.properties file:
  • curam.security.credentials.ws.username - the username used when executing inbound web service calls;
  • curam.security.credentials.ws.password - the password used when executing inbound web service calls. This password must be encrypted.

    The above credentials must exist on the Cúram 'Users' table, must be enabled, and should be assigned the appropriate security role.

    Default credentials can streamline your development and testing processes, but should not be used in a production environment when working with sensitive data and/or processes.