LibraryLink ToToggle FramesPrintFeedback

A Service Unit Project

Each service unit in the service assembly needs to be its own project. These projects are placed at the same level as the service assembly project. The contents of a service unit's project depends on the component at which the service unit is targeted. At a minimum, a service unit project will contain a POM and an XML configuration file.

FUSE ESB provides Maven artifacts for a number of service unit types. You can use them to seed a project with the smx-arch command. As shown in Example C.3, the smx-arch command takes three arguments. The groupId value and the artifactId values correspond to the project's group ID and artifact ID.


[Important]Important

The double quotes(") are required when using the -DgroupId argument and the -DartifactId argument.

The suArchetypeName specifies the type of service unit to seed. Table C.1 lists the possible values and describes what type of project will be seeded.

Table C.1. Service Unit Archetypes

NameDescription
camelCreates a project for using the FUSE Mediation Router service engine.
cxf-seCreates a project for developing a Java-first service using the FUSE Services Framework service engine.
cxf-se-wsdl-firstCreates a project for developing a WSDL-first service using the FUSE Services Framework service engine.
cxf-bcCreates an endpoint project targeted at the FUSE Services Framework binding component.
http-consumerCreates a consumer endpoint project targeted at the HTTP binding component.
http-providerCreates a provider endpoint project targeted at the HTTP binding component.
jms-consumerCreates a consumer endpoint project targeted at the JMS binding component. See Using the JMS Binding Component.
jms-providerCreates a provider endpoint project targeted at the JMS binding component. See Using the JMS Binding Component.
file-pollerCreates a polling (consumer) endpoint project targeted at the file binding component. See Using Poller Endpoints in Using the File Binding Component.
file-senderCreates a sender (provider) endpoint project targeted at the file binding component. See Using Sender Endpoints in Using the File Binding Component.
ftp-pollerCreates a polling (consumer) endpoint project targeted at the FTP binding component.
ftp-senderCreates a sender (provider) endpoint project targeted at the FTP binding component.
jsr181-annotatedCreates a project for developing an annotated Java service to be run by the JSR181 service engine. [a]
jsr181-wsdl-firstCreates a project for developing a WSDL generated Java service to be run by the JSR181 service engine.[a]
saxon-xqueryCreate a project for executing xquery statements using the Saxon service engine.
saxon-xsltCreate a project for executing XSLT scripts using the Saxon service engine.
eipCreates a project for using the EIP service engine. [b]
lwcontainerCreate a project for deploying functionality into the lightweight container. [c]
beanCreates a project for deploying a POJO to be executed by the bean service engine.
odeCreate a project for deploying a BPEL process into the ODE service engine.

[a] The JSR181 has been deprecated. The FUSE Services Framework service engine has superseded it.

[b] The EIP service engine has been deprecated. The FUSE Mediation Router service engine has superseded it.

[c] The lightweight container has been deprecated.


The contents of your service unit project change from service unit to service unit. Different components require different configuration. Some components, such as the FUSE Services Framework service engine, require that you include Java classes.

At a minimum, a service unit project will contain two things:

You configure the Maven plug-in to package the results of the project build as a service unit by changing the value of the project's packaging element to jbi-service-unit as shown in Example C.4.


In order to properly fill in the metadata required for packaging a service unit, the Maven plug-in needs to be told what component, or components, the service unit is targeting. If your service unit only has a single component dependency, you can specify it in one of two ways:

  • list the targeted component as a dependency

  • add a componentName property specifying the targeted component

If your service unit has more than one component dependency you need to configure the project as follows:

  1. Add a componentName property specifying the targeted component.

  2. Add the remaining components to the list dependencies.

Example C.5 shows configuration for a service unit targeting the FUSE Services Framework binding component.


The advantage of using the Maven dependency mechanism is that it allows Maven to check if the targeted component is deployed in the container. If one of the components is not deployed, FUSE ESB will not hold off deploying the service unit until all of the required components are deployed.

[Tip]Tip

A message identifying the missing component(s) is typically written to the log.

If your service unit targets is not available as a Maven artifact, you can specify the targeted component using the componentName element. This element is added to the standard Maven properties block and specifies the name of a targeted component. Example C.6 shows how to use the componentName element to specify the target component.


When you use the componentName element Maven does not check to see if the component is installed. Maven also cannot download the required component.

Example C.7 shows the POM file for a project building a service unit targeted to the FUSE Services Framework binding component.

Example C.7. POM for a Service Unit Project

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent> 1
        <groupId>com.widgets.demo</groupId>
        <artifactId>cxf-wsdl-first</artifactId>
        <version>1.0</version>
    </parent>

  <groupId>com.widgets.demo.cxf-wsdl-first</groupId>
  <artifactId>cxfse-wsdl-first-su</artifactId>
  <name>CXF WSDL Fisrt Demo :: SE Service Unit</name>
  <packaging>jbi-service-unit</packaging> 2

  <dependencies> 3
    <dependency>
      <groupId>org.apache.servicemix</groupId>
      <artifactId>servicemix-cxf-bc</artifactId>
      <version>3.3.1.0-fuse</version>
    </dependency>
  >/dependencies>

  <build>
    <plugins>
      <plugin> 4
        <groupId>org.apache.servicemix.tooling</groupId>
        <artifactId>jbi-maven-plugin</artifactId>
        <extensions>true</extensions>
      </plugin>
    </plugins>
  </build>
</project>

The POM in Example C.7 does the following:

1

Specifies that it is a part of the top-level project described in Example C.2.

2

Specifies that this project builds a service unit.

3

Specifies that the service unit targets the FUSE Services Framework binding component.

4

Specifies that the FUSE ESB Maven plug-in is to be used.



[2] You replace this with the version of FUSE Services Framework you are using.