Deploy a Service Interface

Walks you through the steps required to associate an enterprise server instance with your project, build the project, set deployment properties, deploy the service interface, and verify the deployment results.
Restriction: This topic applies to Windows environments (local development) only.

To successfully deploy a Java service interface to an enterprise server instance, you need to first set some options in Enterprise Developer.

Set Deployment Properties

To ensure that the deployment process runs smoothly, you must set some options that tell Enterprise Developer the name of your enterprise server instance, what application server to use, and where to find certain files.

  1. From the Application Explorer view in the ProgramEJB project, expand Java Interfaces
  2. Right-click the ProgramEJB Java interface; then select Java Properties from the context menu.
  3. On the General tab, click EJB Generation (default).
  4. On the Deployment Server tab, click Change that corresponds to the Enterprise Server name field.

    This opens the Select Enterprise Server dialog box.

  5. Select the ESDEMO Server, and then click OK.
  6. On the Application Files tab, click Legacy application needs deploying; then click Add Files to add the following files:
    File Project Folder
    bookfile.dat ProgramEJB
    bookfile.idx ProgramEJB
    book.dll ProgramEJB > New_Configuration.bin
    These files are copied to the enterprise server instance when you deploy. The .dat and .idx files are the data and index parts of the indexed file accessed by the service. The .dll is the executable file you need to debug the service.
  7. On the EJB Generation tab, use the lists to set the Application Server to JEE 6 and JBOSS 7.1.1.
  8. Uncheck Transactional.
  9. In the Java compiler field, type the location of your javac.exe.
  10. Click Browse that corresponds to the Java EE Class Path field, and type following EJB connector class file paths, they are located in the following subfolders:
    • jboss-as-7.1.1.Final\modules\javax\resource\api\main\jboss-connector-api_1.6_spec-1.0.0.Final.jar
    • jboss-as-7.1.1.Final\modules\javax\ejb\api\main\jboss-ejb-api_3.1_spec-1.0.1.Final.jar
    • jboss-as-7.1.1.Final\modules\javax\servlet\api\main\jboss-servlet-api_3.0_spec-1.0.0.Final.jar

    In addition, add the javac.exe from your Java installation bin folder.

  11. Click OK.

Stop Enterprise Server Instances

To ensure that your enterprise server instance does not encounter any port conflicts with other enterprise server instances that use the same listener port, stop all started enterprise server instances as follows:

  1. If the Server Explorer in Enterprise Developer is not active, click Window > Show View > Other > Micro Focus > Server Explorer; then click OK.
  2. From the Server Explorer, expand Local [localhost:86] to see a list of enterprise server instances.
  3. Right-click each started enterprise server instance, and stop it by selecting Stop from the context menu. Started enterprise server instances show with a green icon Started enterprise server instance.

Start the ESDEMO Enterprise Server Instance

Before deploying your service interface, you must start the ESDEMO instance where the ProgramEJB service will run.

  1. If the Server Explorer in Enterprise Developer is not active, click Window > Show View > Other > Micro Focus > Server Explorer; then click OK.
  2. From the Server Explorer, expand Local [localhost:86] to see a list of available enterprise server instances.
  3. To start the ESDEMO enterprise server instance, right-click it; then click Start.

    ESDEMO provides a default user name and password that you can customize. For this tutorial, you use the default information.

  4. If a sign-on dialog box appears, click OK; then click No to disable password recovery.

The Enterprise Server Daemon is then invoked via the Console, starting the enterprise server instance.

Deploy the ProgramEJB Java interface

  • From Application Explorer view, right-click the ProgramEJB Java interface; then click Deploy.
  • In Eclipse, click the Console tab.
  • On the icon bar, click the down arrow associated with Display Selected Console Display Selected Console.
  • Click Service Interfaces Console.

The Console shows the progression of the deployment process. If deployment was successful, you should see a message indicating success.

Note: If the console switches to the Micro Focus Build view after deployment, switch the view back to Service Interfaces Console to review the deployment log.

If deployment ever fails, you should find a message in the output window indicating why it failed. Also, the failure message contains the path to the deployment log file. You can type the address into a browser and view the log file from there.

View deployment results

Now that your Java interface has been deployed as a service running on the ESDEMO enterprise server, you can look at the details of the deployed service Enterprise Server Administration page.

  1. If you have closed Enterprise Server Administration, start it again from the from the Server Explorer.

    In the row showing information for the ESDEMO enterprise server, you should see that the Objects column shows the number of services that this enterprise server runs. In this case, the number of running services should be at least 9. These are the five that come standard with the ESDEMO enterprise server, plus the one service you added containing four operations. You might see more if you have deployed other services to the ESDEMO enterprise server.

  2. Click the Details button for the ESDEMO Services.

    In the row showing your new service, ProgramEJB, you see that the Current Status column shows all four operations as Available. This means that the service is ready to be access by a client.

Parent topic: Tutorial: EJB Service Interface
Previous topic: Configure ESDEMO
Next topic: Generate and Deploy a JSP Client