Chapter 284. SAP NetWeaver Component

Available as of Camel version 2.12

The sap-netweaver integrates with the SAP NetWeaver Gateway using HTTP transports.

This camel component supports only producer endpoints.

Maven users will need to add the following dependency to their pom.xml for this component:

    <!-- use the same version as your Camel core version -->

284.1. URI format

The URI scheme for a sap netweaver gateway component is as follows


You can append query options to the URI in the following format, ?option=value&option=value&…​

284.2. Prerequisites

You would need to have an account to the SAP NetWeaver system to be able to leverage this component. SAP provides a demo setup where you can requires for an account.

This component uses the basic authentication scheme for logging into SAP NetWeaver.

284.3. SAPNetWeaver options

The SAP NetWeaver component has no options.

The SAP NetWeaver endpoint is configured using URI syntax:


with the following path and query parameters:

284.3.1. Path Parameters (1 parameters):



Required Url to the SAP net-weaver gateway server.



284.3.2. Query Parameters (6 parameters):


flatternMap (producer)

If the JSON Map contains only a single entry, then flattern by storing that single entry value as the message body.



json (producer)

Whether to return data in JSON format. If this option is false, then XML is returned in Atom format.



jsonAsMap (producer)

To transform the JSON from a String to a Map in the message body.



password (producer)

Required Password for account.



username (producer)

Required Username for account.



synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).



284.4. Message Headers

The following headers can be used by the producer.




Mandatory: The command to execute in MS ADO.Net Data Service format.

284.5. Examples

This example is using the flight demo example from SAP, which is available online over the internet here.

In the route below we request the SAP NetWeaver demo server using the following url

And we want to execute the following command


To get flight details for the given flight. The command syntax is in MS ADO.Net Data Service format.

We have the following Camel route

    .setHeader(NetWeaverConstants.COMMAND, constant(command))
    .toF("sap-netweaver:%s?username=%s&password=%s", url, username, password)

Where url, username, password and command is defined as:

    private String username = "P1909969254";
    private String password = "TODO";
    private String url = "";
    private String command = "FlightCollection(AirLineID='AA',FlightConnectionID='0017',FlightDate=datetime'2012-08-29T00%3A00%3A00')";

The password is invalid. You would need to create an account at SAP first to run the demo.

The velocity template is used for formatting the response to a basic HTML page

  Flight information:

  <br/>Airline ID: $body["AirLineID"]
  <br/>Aircraft Type: $body["AirCraftType"]
  <br/>Departure city: $body["FlightDetails"]["DepartureCity"]
  <br/>Departure airport: $body["FlightDetails"]["DepartureAirPort"]
  <br/>Destination city: $body["FlightDetails"]["DestinationCity"]
  <br/>Destination airport: $body["FlightDetails"]["DestinationAirPort"]


When running the application you get sampel output:

Flight information:
Airline ID: AA
Aircraft Type: 747-400
Departure city: new york
Departure airport: JFK
Destination city: SAN FRANCISCO
Destination airport: SFO

284.6. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • HTTP