Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 288. 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: 

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-sap-netweaver</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
Copy to Clipboard Toggle word wrap

288.1. URI format
Copy link

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

sap-netweaver:https://host:8080/path?username=foo&password=secret
Copy to Clipboard Toggle word wrap

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

288.2. Prerequisites
Copy link

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.

288.3. SAPNetWeaver options
Copy link

The SAP NetWeaver component has no options.

The SAP NetWeaver endpoint is configured using URI syntax: 

sap-netweaver:url
Copy to Clipboard Toggle word wrap

with the following path and query parameters:

288.3.1. Path Parameters (1 parameters):
Copy link

Expand
NameDescriptionDefaultType

url

Required Url to the SAP net-weaver gateway server.

 

String

288.3.2. Query Parameters (6 parameters):
Copy link

Expand
NameDescriptionDefaultType

flatternMap (producer)

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

true

boolean

json (producer)

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

true

boolean

jsonAsMap (producer)

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

true

boolean

password (producer)

Required Password for account.

 

String

username (producer)

Required Username for account.

 

String

synchronous (advanced)

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

false

boolean

288.4. Message Headers
Copy link

The following headers can be used by the producer.

Expand
NameTypeDescription

CamelNetWeaverCommand

String

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

288.5. Examples
Copy link

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 

https://sapes1.sapdevcenter.com/sap/opu/odata/IWBEP/RMTSAMPLEFLIGHT_2/
Copy to Clipboard Toggle word wrap

And we want to execute the following command 

FlightCollection(AirLineID='AA',FlightConnectionID='0017',FlightDate=datetime'2012-08-29T00%3A00%3A00')
Copy to Clipboard Toggle word wrap

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 

from("direct:start")
    .setHeader(NetWeaverConstants.COMMAND, constant(command))
    .toF("sap-netweaver:%s?username=%s&password=%s", url, username, password)
    .to("log:response")
    .to("velocity:flight-info.vm")
Copy to Clipboard Toggle word wrap

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

    private String username = "P1909969254";
    private String password = "TODO";
    private String url = "https://sapes1.sapdevcenter.com/sap/opu/odata/IWBEP/RMTSAMPLEFLIGHT_2/";
    private String command = "FlightCollection(AirLineID='AA',FlightConnectionID='0017',FlightDate=datetime'2012-08-29T00%3A00%3A00')";
Copy to Clipboard Toggle word wrap

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 

<html>
  <body>
  Flight information:

  <p/>
  <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"]

  </body>
</html>
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

288.6. See Also
Copy link

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • HTTP
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat