Defining an EJB web service with JBoss

You can define an EJB web service with JBoss, and can add more APIs later if you need to.

Procedure

  1. In the <INSTALL_DIR>/repository/eardata/platform/webservices folder, locate the namedwebservices.xml.sample file. Rename (or copy) it to namedwebservices.xml. This is the file you will edit.
  2. In namedwebservices.xml, specify each API you want to expose as a web service in an Api/Name attribute.
    Property
    Description
    ServiceName
    The name of the service that you configured using the Service Definition Framework (SDF).
    ExposedName
    The name that is used in the Web Services Description Language (WSDL) file. This is the name that is used to call the web service programmatically. When specifying a service name for ExposedName, choose a literal that does not match any of the standard application API names.

    The exposed name must start with a lower case letter.

  3. Set the properties necessary for your application server in sandbox.cfg:
    Parameter
    Description
    EJB_3_ENABLED
    Set to true or false. Determines whether the EJBs are generated according to the spec version 2 or 3. JBoss supports both.

    Required if building EJB web services (JBoss only).

    JBOSS_PRECOMPILE_JSP
    Precompiles pages in the WAR file.

    Set to true (precompile jsps) or false (do not precompile jsps). There is no default set by installation, but jsps will not be precompiled unless you set this to true.

    Required if building EJB web services.

    For JBoss only.

    JBOSS_DIR
    Set to the absolute path of the JBoss installation directory.

    Required if building EJB web services or if EJB_3_ENABLED is true.

    For JBoss only.

    WEBSERVICES_BUILDS
    Takes a comma-separated list that can include YIFWebService and SIXBeanXapiJaxWS. Defaults to YIFWebService.

    Required for EJB and JAX-WS web services, on all application servers.

  4. Save the file, navigate to the bin directory, and run the setupfiles command:
    • For UNIX/Linux: <INSTALL_DIR>/bin/setupfiles.sh
    • For Windows: <INSTALL_DIR>\bin\setupfiles.cmd
  5. Create the EAR as described in Creating the EAR on JBoss. The web services defined in the file will be built when you create the application EAR.
  6. Later, if you want to add more APIs and services as EJB Web services, repeat these steps.