2 Deploying Web Services Manager

This chapter describes how to deploy and launch the Oracle Communications Billing and Revenue Management (BRM) Web Services Manager.

Before reading this chapter, you should have read "Installing Web Services Manager" and you should be familiar with the administration console of your chosen application server.

About Deploying Web Services Manager

Web Services Manager includes a servlet-based implementation that hosts the deployed web service. Web Services Manager uses the JAX-WS API to support SOAP, WSDL, and other low-level web service protocols.

Web Services Manager can be deployed on the following servers:

Deploying and Launching Web Services Manager on WebLogic Server

You can deploy Web Services Manager on WebLogic server through the WebLogic Server Administration Console. Depending on the type of payload supported by web services, deploy one of the following files:

  • infranetwebsvc.war: Includes web services that support the payload as an XML string data type.

  • BrmWebServices.war: Includes web services that support the payload as an XML element data type.

If you customize web services, regenerate infranetwebsvc.war or BrmWebServices.war and use the generated version. Otherwise, you should use the default infranetwebsvc.war or BrmWebServices.war file. For more information about customizing web services, see "Customizing Web Services."

To deploy Web Services Manager on WebLogic Server:

  1. Create the WebLogic Server domain. See the discussion about creating a WebLogic domain in Fusion Middleware Creating Domains Using the Configuration Wizard for detailed instructions.

  2. If you deploy the BrmWebServices.war file, set the heap size required to start WebLogic Server:

    1. Open the WebLogic_Home/user_projects/domains/Domain_Name/setDomainEnv.sh file in a text editor.

      Where:

      WebLogic_Home is the directory in which WebLogic Server is installed.

      Domain_Name is the name of the domain you created in step 1.

    2. Add the following entry:

      USER_MEM_ARGS ="-Xms2048m -Xmx2048m"

    3. Save and close the file.

    4. Restart WebLogic Server.

  3. Do one of the following:

    • If you customized web services:

      • Extract the BRM_Home/deploy/web_services/infranetwebsvc.war or the BRM_Home/deploy/web_services/BrmWebServices.war file to local_dir.

        Where:

        BRM_Home is the directory in which BRM is installed.

        local_dir is a directory on the machine on which you installed WebLogic Server.

      • Copy the CustomFields.jar files to the local_dir/WEB-INF/lib directory. See "Setting Up Web Services Manager to Support Custom Opcodes" for more information.

        Note:

        The JRE version that was used to generate CustomFields.jar must be the same or lower than the version of the WebLogic Server JRE.

      • Open the BRM_Home/deploy/web_services/Infranet.properties file in a text editor.

      • Modify the following entry:

        infranet.custom.field.package = package

        where package is the name of the package that contains the CustomOp.java file; for example, com.portal.classFiles.

      • Add all the custom fields to the Infranet.properties file.

      • Save and close the file.

      • Copy the BRM_Home/deploy/web_services/Infranet.properties file to the local_dir/WEB-INF/classes or in the home directory on the machine on which WebLogic Server is installed.

      • Regenerate the WAR file by running one of the following commands:

        To regenerate the infranetwebsvc.war file:

        jar -cvf infranetwebsvc.war *

        To regenerate the BrmWebServices.war file:

        jar -cvf BrmWebServices.war *

    • If you did not customize web services:

      • Extract the BRM_Home/deploy/web_services/infranetwebsvc.war or the BRM_Home/deploy/web_services/BrmWebServices.war file to local_dir.

      • Copy the BRM_Home/deploy/web_services/Infranet.properties file to the local_dir/WEB-INF/classes directory or in the home directory on the machine on which WebLogic Server is installed.

      • Regenerate the WAR file by running one of the following commands:

        To regenerate the infranetwebsvc.war file:

        jar -cvf infranetwebsvc.war *

        To regenerate the BrmWebServices.war file:

        jar -cvf BrmWebServices.war *

  4. Log in to WebLogic Server Administration Console.

  5. In the Domain Structure pane, click Deployments.

    The Summary of Deployments page appears.

  6. Click Install.

    The Install Application Assistant page appears.

  7. Enter the local directory path for infranetwebsvc.war or BrmWebServices.war in the Path field and press Enter.

    Note:

    If you use WebLogic Server 12.2, make sure you put serverlet-to-URL within a comment.

  8. Select Install this deployment as an application and click Next.

  9. Select the server or servers on which you want to deploy Web Services Manager and click Next.

  10. Click Next.

    Note:

    When you deploy Web Services Manager on WebLogic Server, select the Custom Roles and Policies option in the Security section of WebLogic Server Administration Console.

  11. Verify your deployment options and click Finish.

    WebLogic Server displays the deployed application on the Deployments page.

To launch Web Services Manager for web services, do one of the following:

  • If you have deployed infranetwebsvc.war, launch web services from the WebLogic Server Administration Console:

    1. On the Home page, select Deployments in the Domain Structure pane.

      The Summary of Deployments page appears.

    2. Click the infranetwebsvc link.

      The Settings page for the deployment appears.

    3. Click the Testing tab.

    4. Click the default url link.

      The Apache Axis Web page appears.

    5. Click the link for the list of the supported BRM web services for this Web Services Manager deployment.

  • If you have deployed BrmWebServcies.war, launch web services from the WebLogic Server Administration Console:

    1. On the Home page, select Deployments in the Domain Structure pane.

      The Summary of Deployments page appears.

    2. Click the BrmWebServices link, a list of all the web services is displayed.

    3. Click on any of the web service.

    4. Click the Testing tab.

    5. The WebLogic Server Administration console displays an URL for the BRM web services.

Deploying and Launching Web Services Manager on GlassFish Server

You can deploy Web Services Manager on GlassFish Server through the GlassFish Server Administration Console. Depending on the type of payload supported by web services, deploy one of the following files:

  • infranetwebsvc.war: Includes the web services that support the payload as an XML string data type.

  • BrmWebServices.war: Includes the web services that support the payload as an XML element data type.

If you customize web services, regenerate infranetwebsvc.war or BrmWebServices.war and use the generated version. Otherwise, you should use the default infranetwebsvc.war or BrmWebServices.war file. For more information about customizing web services, see "Customizing Web Services."

To deploy Web Services Manager on GlassFish Server:

  1. Create the GlassFish Server domain. See the GlassFish documentation for detailed instructions.

    If you plan to deploy the BrmWebServices.war file, do the following:

    1. Open the BrmWebServices.war/WEB-INF/web.xml file in a text editor.

    2. Uncomment the serverlet-to-URL mapping.

    3. Save and close the file.

  2. Copy the BRM_Home/deploy/web_services/infranetwebsvc.war file or the BRM_Home/deploy/web_services/BrmWebServices.war to a local_dir.

    Where:

    BRM_Home is the directory in which BRM is installed.

    local_dir is a directory on the machine on which you installed GlassFish Server.

  3. Log in to the GlassFish Server Administration Console.

  4. In the Common Tasks pane, click Applications.

    The Applications page appears.

  5. On the Applications page, click Deploy...

    The Deploy Applications or Modules page appears.

  6. In the Location: Packaged File to Be Uploaded to the Server field, click Choose File and do one of the following:

    • To support the payload as an XML string data type, select infranetwebsvc.war from the list of available applications and click OK to deploy the infranetwebsvc.war file.

    • To support the payload as an XML payload data type, select BrmWebServices.war from the list of available applications and click OK to deploy the BrmWebServices.war file.

    GlassFish Server displays the deployed application on the Applications page.

  7. To launch Web Services Manager for web services, do one of the following:

    If you have deployed infranetwebsvc.war, launch web services from the GlassFish Server Administration Console:

    1. On the Applications page, select the infranetwebsvc checkbox and click Launch.

      The GlassFish Server Administration console displays an HTTP and an HTTPS URL for the web services.

    2. Click on a URL for any available web service.

    If you have deployed BrmWebServices.war, launch web services from the GlassFish Server Administration Console:

    1. On the Applications page, select the BrmWebServices checkbox and click Launch.

      The GlassFish Server Administration console displays an HTTP and an HTTPS URL for the BRM web services.

      A sample URL for the BRMCUSTServices_v2Web service is as follows:

      http://ipaddress:port/BrmWebServices/BRMCUSTServices_v2?wsdl

      where:

      • ipaddress is the domain IP address of the application server on which Web Services Manger is deployed.

      • port is the domain port number of the application server on which Web Services Manger is deployed.

  8. Restart GlassFish Server. See "Starting and Stopping GlassFish Server".

For more information on the BRM web services included in Web Services Manager that take the payload as an XML element data type, see the Table 6-2, "Web Services Included in Web Services Manager that Support XML Element Payload".

Starting and Stopping GlassFish Server

Note:

You must restart GlassFish Server after you deploy or undeploy Web services on GlassFish Server.

To start GlassFish Server:

  1. Go to the directory in which GlassFish Server is installed.

  2. Run the following command, which starts GlassFish Server:

    start-domain GlassFish_domain

    where GlassFish_domain is the GlassFish Server domain; for example, domain1.

To stop GlassFish Server:

  1. Go to the directory in which GlassFish Server is installed.

  2. Run the following command, which stops GlassFish Server:

    stop-domain GlassFish_domain

Deploying and Launching Web Services Manager on Tomcat Server

You can deploy Web Services Manager on Tomcat Server through the Tomcat Web Application Manager. Depending on the type of payload supported by web services, deploy one of the following files:

If you customize web services, regenerate infranetwebsvc.war or BrmWebServices.war and use the generated version. Otherwise, you should use the default infranetwebsvc.war or BrmWebServices.war file. For more information about customizing web services, see "Customizing Web Services."

Deploying and Launching infranetwebsvc.war

To deploy Web Services Manager for web services that support the payload as an XML string data type, on Tomcat server:

  1. Create the Tomcat server domain. See Tomcat documentation for detailed instructions.

  2. Download JAX-WS Reference Implementation (RI) library from the JAX-WS RI page (http://jax-ws.java.net/).

  3. Extract the jaxws-ri-2.2.10.zip file and copy the following files to Tomcat_home/lib, where Tomcat_home is the directory in which the Tomcat server is installed:

    • gmbal-api-only.jar

    • jaxb-api.jar

    • jaxb-impl.jar

    • jaxws-rt.jar

    • management-api.jar

    • policy.jar

    • stax-ex.jar

    • jaxb-core.jar

    • ha-api.jar

    • jaxws-tools.jar

    • jaxb-xjc.jar

    • jaxb-impl.jar

    • jaxb-jxc.jar

    • streambuffer.jar

  4. In the War file to deploy section, click Browse.

  5. Download jaxrpc.jar from the Download jaxrpc.jar web page (http://www.java2s.com/Code/Jar/j/Downloadjaxrpcjar.htm) and copy the file to Tomcat_home/lib.

  6. Click Deploy.

    Tomcat Web Application Manager displays the deployed application in the Applications list.

    Note:

    (UNIX only) The GUI user must have execute permissions for infranetwebsvc.war. If the GUI user does not have the appropriate permissions, Tomcat will deploy the application, but will be unable to start it. Verify that the Running column of the Applications list has a value of true for /intranetwebsvc to ensure that Web Services Manager has been deployed successfully.

To launch Web Services Manager for web services that support the payload as an XML string data type, from the Tomcat Web Application Manager:

  1. In the Applications list, click the /infranetwebsvc link.

  2. Click the Services link to view a list of the supported BRM web services for this Web Services Manager deployment.

Deploying and Launching BrmWebServices.war

To deploy Web Services Manager for web services that support the payload as an XML element data type, on Tomcat server:

  1. Create the Tomcat server domain. See Tomcat documentation for detailed instructions.

  2. Download JAX-WS RI library from the JAX-WS Reference Implementation page (http://jax-ws.java.net/).

  3. Extract the jaxws-ri-2.2.10.zip file and copy the following files to Tomcat_home/lib, where Tomcat_home is the directory in which Tomcat server is installed:

    • gmbal-api-only.jar

    • jaxb-api.jar

    • jaxb-impl.jar

    • jaxws-rt.jar

    • management-api.jar

    • policy.jar

    • stax-ex.jar

    • jaxb-core.jar

    • ha-api.jar

    • jaxws-tools.jar

    • jaxb-xjc.jar

    • jaxb-impl.jar

    • jaxb-jxc.jar

    • streambuffer.jar

  4. Download jaxrpc.jar from the Download jaxrpc.jar web page (http://www.java2s.com/Code/Jar/j/Downloadjaxrpcjar.htm) and copy the file to Tomcat_home/lib.

    If you plan to deploy the BrmWebServices.war file, do the following:

    1. Open the BrmWebServices.war/WEB-INF/web.xml file in a text editor.

    2. Uncomment the serverlet-to-URL mapping.

    3. Save and close the file.

  5. Copy the BRM_home/deploy/web_services/BrmWebServices.war file to a local directory on the machine on which you installed Tomcat server, where BRM_home is the directory in which BRM is installed.

  6. Log in to the Tomcat Web Application Manager.

  7. In the War file to deploy section, click Browse....

  8. Select the BrmWebServices.war file.

  9. Click Deploy.

    Tomcat Web Application Manager displays the deployed application in the Applications list.

To launch Web Services Manager for web services that support the payload as an XML element data type, from the Tomcat Web Application Manager:

  1. In the Applications list, click the /BrmWebServices link.

  2. Web Services Manager displays the WSDL URLs for each available service.

    A sample URL for the BRMCUSTServices_v2Web service is as follows:

    http://ipaddress:port/BrmWebServices/BRMCUSTServices_v2?wsdl

    where:

    • ipaddress is the domain IP address of the application server on which Web Services Manger is deployed.

    • port is the domain port number of the application server on which Web Services Manger is deployed.

For more information on the BRM web services included in Web Services Manager that take the payload as an XML element data type, see Table 6-2, "Web Services Included in Web Services Manager that Support XML Element Payload".