soap adapter

7/24/2019 SOAP Adapter

1/12

Adapters in details

SOAP Adapter

Lecturer: Jerome Delune


2/12

SAP AG 2004, SOAP Adapter, Jerome Delune

Objectives

After completing this session you will be able to:

Understand the basics of J2EE SOAP adapter

Understand how to configure sender & receiver SOAP adapter

Be familiar with technical aspects of the SOAP adapter


3/12

Some remote clients or Web services providers are only able to communicate by

means of SOAP messages.

You use the SOAP adapter to connect such systems to the Integration Server

directly.

The SOAP adapter uses a helper class to instantiate and control these SOAP

components.

The SOAP adapter receives a message from the remote client or Web services

provider, converts the SOAP protocol into the XI message protocol (SOAP withheader enhancements) and then sends the message to the Integration Server to

be processed further.

To forward messages to a receiver remote client or Web services provider, the

SOAP adapter receives the message from the Integration Server, converts it into a

SOAP message, and then sends it to the remote client or Web services provider.

It is recommended to use HTTPS for communication between the Integration

Server and the adapter, as well as between the adapter and the Web service

client or provider.


SOAP Adapter

Some remote clients or Web services providers are only able

to communicate by means of SOAP messages.

The SOAP adapter enables you to exchange SOAP messagesbetween remote clients or Web service servers and the

Integration Server.

The SOAP adapter provides a runtime environment that

includes various SOAP components for the processing of

SOAP messages.

Supported Protocols:

HTTP

HTTPS


4/12

A remote client sends a SOAP message to the SOAP adapter on the Integration

Server.

The SOAP adapter converts the SOAP message to XI message protocol and

transfers it to the Integration Server for further processing.

Two receivers are determined:

A remote Web services provider

An SAP Business system, which is able to receive XI message protocol directly

On the receiver side, the SOAP adapter converts the XI message protocol into aSOAP message and then sends the message to the remote Web services

provider.

The other receiver simply receives the XI message protocol message.


SOAP Adapter

You require the SOAP adapter to convert the SOAP message

format used by the Web service to the message format used

by SAP Exchange Infrastructure (XI message).


5/12

You configure the adapter on the Parameters tab page during the definition of a

communication channel.

In addition to the adapter configuration, on the Module tab page in the module

processor, you can specify generic modules, which give the adapter additional

functions.

The inbound address for SOAP messages is:

http://host:port/XISOAPAdapter/MessageServlet?channel=party:service:channel

Under party:service:channel enter the party name, the service name, and the name of the

communication channel.

If no party has been created, enter: channel=:service:channel

Prerequisites

You have created a new communication channel or have opened an existing one.

On the Parameter tab page you have selected the adapter type SOAP.

You have selected the Sender radio button to define the adapter as a sender adapter.


Configuring the Sender SOAP Adapter

You need to configure theSender SOAP adapter tosend content from remote

clients or Web serviceservers to the IntegrationServer .

A Sender CommunicationChannel defines how aSOAP adapter transforms amessage so that it can beprocessed by the IntegrationEngine during inboundprocessing.

A sender channel containsthe configuration data for asender adapter.


6/12

The Transport Protocol for the Sender SOAP Adapter is HTTP

Message Protocol is SOAP 1.1.

Select the Adapter Engine on the Integration Server, or select a non-centrally

installed Adapter Engine.

In the Conversion Parameters,

choose With Header checkbox, if you want the header of the Web service message to be

included in the XI message.

choose With Attachments checkbox, if you want attachments of the Web service message tobe included in the XI message.

choose With encoded headers checkbox, if you want the headers to be encoded.

choose With query string checkbox, if you want to specify a query string.


Configuring the Sender SOAP Adapter (Contd.)

You configure the Sender SOAP

adapter to be able to send SOAP

messages to the Integration

Server.

Transport Protocol:

HTTP

Message Protocol:

SOAP 1.1

Adapter Engine:

Integration Server

Conversion Parameters:

With Header

With Attachments

With encoded Headers

With query string


7/12

You can overwrite the default values for the Interface Namespace and Interface.

Under Quality of Service, specify how the messages are to be processed by theIntegration Engine:

Best Effort for Synchronous processing

Exactly Once for Asynchronous processing with guaranteedexecution exactly once.

Exactly Once In Order for asynchronous processing using queues.

This means guaranteed execution exactly once following thesequence of successive messages. You have to specify the QueueName.

Set the Adapter Status to Active to enable messages to beexchanged.

To specify additional parameters in the adapter configuration, set theAdvanced Mode indicator.

Specify the additional parameter names and parameter values in the table.


Configuring the Sender SOAP Adapter (Contd.)

Default XI Parameters:

Interface Namespace

Interface Name

Processing Parameters :

Best Effort

Exactly Once

Exactly Once In Order

Adapter Status:

Integration Engine

Advanced Mode:

To Specify Additional Parameters


8/12

You configure the adapter on the Parameters tab page when you define a

communication channel. In addition to the adapter configuration, on the Module

tab page in the module processor, you can specify generic modules, which give

the adapter additional functions.

Prerequisites

You have created a new communication channel or have opened an existing

one.

On the Parameters tab page you have selected the adapter type SOAP.

You have selected the Receiver radio button to define the adapter as a

receiver adapter.


Configuring the Receiver SOAP Adapter

You need to configure the

receiver SOAP adapter to

send information from

remote clients to theIntegration Server.

Receiver Communication

Channel defines how a

SOAP adapter transforms a

message so that it can be

processed by the receiver

during outbound

processing.

A receiver channel contains

the configuration data for a

receiver adapter.


9/12

The Transport Protocol for the Receiver SOAP Adapter is HTTP

Message Protocol is SOAP 1.1.

Select the Adapter Engine on the Integration Server, or select a non-centrally

installed Adapter Engine.

Under Target Address, enter the complete address (URL) of the Web Service

provider that you want to send the message to.

Specify the Username and Pasword to connect to Remote Server.

If the Web service provider can only be reached by using an http proxy server and

not directly, select the Use Proxy indicator and enter the Host and Port used for

receiving proxy http-requests.


Configuring the Receiver SOAP Adapter (Contd.)

You configure the receiver SOAPadapter to send information fromremote clients to the Integration

Server.

Transport Protocol:

HTTP

Message Protocol:

SOAP 1.1

Adapter Engine:

Integration Server

Connection Parameters: Target URL (address of Web

Service Provider)

User and Password

Use Proxy:

Host and Port


10/12

In the Conversion Parameters,

choose With Header checkbox, if you want the header of the Web service message to be

included in the XI message.

choose With Attachments checkbox, if you want attachments of the Web service message to

be included in the XI message.

choose With encoded headers checkbox, if you want the headers to be encoded.

choose With query string checkbox, if you want to specify a query string.

Set the Adapter Status to Active to enable messages to be

exchanged.

To specify additional parameters in the adapter configuration, set the

Advanced Mode indicator.

Specify the additional parameter names and parameter values in the table.


Configuring the Receiver SOAP Adapter (Contd.)

Conversion Parameters:

With Header

With Attachments

With encoded Headers

With query string

Adapter Status

Advanced Mode:

To specify Additional Parameters


11/12

This function enables you to create a WSDL description for a message interface and a sender.

A Web service platform, for example, can then use the Web service description to generate an

outbound proxy that it can then use to send a message.

You require the SOAP adapter to convert the SOAP message format used by the Web service to

the message format used by SAP Exchange Infrastructure (XI message).

Use the Define Web Service wizard to create a WSDL document.

To create a Web service document:

In the Integration Directory menu bar choose Tools Define Web Service.

Enter the URL of the Web server that is to receive the Web service.

Click Propose URL ( ) to specify the URL of the Integration Server entered in the System Landscape

Directory.

Specify the message interface for which you want to create the Web service document.

Enter the sender of the message (party, service, and outbound interface).

An overview of all the information that will be used to create the Web service document is then displayed.

Choose Finish to generate the WSDL.


Defining Web Services

You Choose Tools Define Web

Service in the Integration

Directory menu bar to create Web

Service document or WSDL.

This function enables you to

create a WSDL description for a

message interface and a sender.

You can create WSDL

descriptions from both outbound

and inbound message interfaces.


12/12


Summary

Now you should be able to:

Understand the basics of J2EE SOAP adapter

Understand how to configure sender & receiver SOAP adapter

Be familiar with technical aspects of the SOAP adapter

No narration

on this slide!

soap adapter

Documents