Show TOC Start of Content Area

Procedure documentation Configuring Individual Web Service Clients  Locate the document in its SAP Library structure

Use

A logical port is a reference to a service endpoint available at a unique service endpoint URL on the provider system. That is why you create a logical port based on the service endpoint URL of the respective service endpoint. You can create a logical port in any of the following ways:

·        Based on the location of the WSDL document (WSDL URL) of the service which holds the service endpoint.

The WSDL document of the service contains the service endpoint URLs of all the service endpoints grouped into the service. You can take the WSDL URL of the WSDL document from the details of the service definition (see the Prerequisites below).

·        Manually, by using the exact location of a particular endpoint (service endpoint URL).

The endpoint URL is available in the WSDL document of a service. It is displayed in the location property of a port as the code excerpt below shows:

Syntax

<service xmlns="http://schemas.xmlsoap.org/wsdl/" name="service name">

 <port name="<endpoint name>" xmlns:bref="http://ip.test/" binding="bref:DefaultService_">

  <address xmlns="http://schemas.xmlsoap.org/wsdl/soap/" location="<endpoint URL>" />

 </port>

</service>

Note

For every proxy definition deployed on the application server, by default the system creates a logical port. This logical port points to the URL on which the Web service was available when the proxy was generated for that Web service (normally, this would be a development or a test system, not a productive one). If you want to use this “default“ logical port, you have to manually edit it by setting the service endpoint URL of the service endpoint which you want the logical port to call.

Prerequisites

·        To create a logical port based on the location of a WSDL document, you need the following information:

¡        The URL to the WSDL document of the service.

You have to use the URL to the WSDL of a configured service definition. The WSDL contains the settings of the service definition in the form of policy assertions compliant with the WS-Policy standard. You can copy the WSDL URL from the details about the service definition. It ends with the following parameter: mode=ws_policy.

More information: Managing WSDL Documents.

¡        The name of the service endpoint for which you want to create a logical port.

·        To create a logical port manually by using the service endpoint URL directly, you have to know the service endpoint URL.

Procedure

       1.      Log on to the SAP NetWeaver Administrator.

       2.      Choose SOA Management Business Administration Web Services Administration.

Alternatively, you can use the quick link /WSAdmin as follows:

http://<host>:<port>/nwa/WSAdmin

The Web Services Administration screen opens.

       3.      Find the proxy definitions which you want to configure. Proceed as follows:

                            a.      In the Search by field, make sure that Proxy Definition Name is selected.

                            b.      In the Value field, enter the name of the proxy definition. You can use the wildcard search symbols (?) and (*).

                            c.      Choose Go.

The system lists all available proxy definitions which match your search criteria.

       4.      Choose an the proxy definition you want to configure, and choose the Configuration tab.

You can configure new logical port or edit an existing one.

Creating a Logical Port

...

       1.      Choose Create LP.

       2.      Choose the source of the endpoint URL that you want to use. The following options are available:

·        WSDL URL

The system automatically extracts the endpoint URL from the WSDL document of a service.

                            a.      Choose WSDL URL, and then choose Next.

                            b.      At the Provide WSDL step, enter the path to the WSDL document, and then choose Next.

                            c.      At the Provide User/Password step, enter a user name and a password, and then choose Next.

                            d.      At the Select Binding Data step, choose the name of the endpoint for which you want to create a logical port, and then choose Next.

                            e.      At the Save Logical Port step, the Logical Port Name and the WS Endpoint URL fields are automatically populated with the name of the service endpoint, and the service endpoint URL. Proceed as follows:

                                                  i.       Choose Default Logical Port if you want to mark the LP as the default one. In this case, if the consumer application is not designed to call a specific LP for a service, it calls the LP marked as default.

                                                ii.       Set the necessary runtime configuration settings.

The Configuration Options for Logical Ports section below explains the runtime settings you can apply for the logical ports.

·        Manually

The system uses the exact endpoint URL to create a logical port.

...

                            a.      Choose Manually, and then choose Next.

                            b.      At the Save Logical Port step, proceed as follows:

                                                  i.       Enter a unique name for the LP.

                                                ii.       Choose Default Logical Port if you want to mark the LP as the default one. In this case, if the consumer application is not designed to call a specific LP for a service, it calls the LP marked as default.

                                               iii.       In the WS Endpoint URL field, enter the endpoint URL.

                                               iv.       Set the necessary runtime configuration settings.

The Configuration Options for Logical Ports section below explains the runtime settings you can apply for the logical ports.

       3.      Choose Save.

Editing a Logical Port

...

       1.      From the Logical Ports table, choose a logical port, and then choose Edit.

Note

If you want to edit a logical port which the system created during the deployment of the proxy definition, you have to manually edit its current service endpoint URL. You have to provide the URL for a service endpoint in your landscape.

       2.      To edit the Web service endpoint URL, choose the Details tab, and then in the WS Endpoint URL field, enter a valid service endpoint URL.

       3.      Set the necessary runtime configuration settings.

The Configuration Options for Logical Ports section below explains the runtime settings you can apply for the logical ports.

       4.      Choose Save.

Configuration Options for Logical Ports

On the tabs that open, set the configuration settings which suit your requirements.

·        Configure Web service Security.

Caution

Currently, it is not possible to configure a proxy definition to use WSRM together with Web service SecureConversation (WS-SC). You have to either configure WSRM, or enable the use of WS-SC for a proxy definition.

On the Security tab, specify the relevant options. More information: Recommended WS Security Scenarios.

HTTP Authentication

Option

Description

User ID/Password (Basic)

Authentication with user ID and password in HTTP header

More Information: HTTP Transport Level Authentication

User ID/Password (Digest)

Username and password based authentication, in which the password is encrypted.

More Information: Basic Authentication (User ID and Password)

X.509 Client Certificate

Authentication with an X.509 certificate using Secure Sockets Layer (SSL).

More Information: HTTP Transport Level Authentication

Logon Ticket

Authentication with SAP authentication assertion ticket in the HTTP header, which authenticates the identity of the user.

More Information: HTTP Transport Level Authentication

Message Authentication

Option

Description

User ID/Password (Basic)

Authentication with a WS-Security Username Token in the security header of the SOAP message.

More Information: WS-Security UsernameToken

User ID/Password (Digest)

Username and password based authentication, in which the password is encrypted.

More Information: Basic Authentication (User ID and Password)

X.509 Client Certificate

Authentication with an X.509 certificate using Secure Sockets Layer (SSL).

More Information: HTTP Transport Level Authentication

SAML Assertion

Authentication with a signed SAML 1.1 assertion in the message header, which authenticates the identity of the user.

More Information: SAML Token Profile

 

·        Configure Transport Settings

On the Transport Settings tab you specify the transport between the provider side and the consumer side. The table below lists the available options and explains their meaning.

Option

Description

Use ‘Connection: KeepAlive’ http header

Enables multiple requests and responses through a single HTTP connection. The provider system keeps the connection alive so that you can use the same connection for multiple request and response cycles.

Support gzip responses

Enables the provider side to return compressed responses to the consumer and, in this way, improves performance. This option is useful when you expect the provider to return responses whose size is several MB.

Note

If you want to set this option, the provider system has to support compressed responses (gzip).

Max wait-time for http response

Denotes how long the consumer waits for a response from the provider. If you expect huge load on the provider system that would delay the responses to consumers, Increase the default value.

Issue chunked requests

Optimizes the method in which the client communicates to the provider the size of it own requests. If the option is selected, the client communicates the size of the message directly in the stream, and does not write it in memory.

·        Configure Web service addressing

On the Web Service Addressing, specify the protocol for Web service Addressing.

·        Configure stateful communication

On the State Management tab, choose the method for session handling. Currently, only HTTP cookies are supported.

·        Configure Web Service Reliable Messaging

You configure WS-RM on the Messaging tab. The messaging tab appears only for Web service clients created for WS-RM-enabled Web services.

On the Messaging tab, set the relevant options. The table below lists the available options and explains their meaning.

Caution

Currently, it is not possible to configure a proxy definition to use WS-RM together with Web service SecureConversation (WS-SC). You should either configure WSRM, or enable the use of WS-SC for a proxy definition.

Option

Description

RM Protocol

Sets the protocol for reliable messaging.

ExponentialBackoff

Exponential backoff sets an algorithm used by the client when it resends messages. If you choose this option, the retransmission interval increases exponentially after each unsuccessful transmission.

Retransmission interval

The interval at which the Web service client will try to resend each message which has not been acknowledged by the Web service.

Inactivity Timeout

If the Web service receives no messages within this interval, it considers the sequence terminated due to the lack activity.

Lifetime of a sequence

The time for which a sequence will remain active.

·        Configure service metering settings. More information: Service Metering

¡        In the Data transfer scope screen area, choose the amount of service metering data transferred:

§         Choose Minimal Data Transfer when you want the consumer application to send only Calling Application Type to the provider.

§         Choose Basic Data Transfer when you want the consumer application to send Calling Application Type, Calling Component, and Calling Application ID to the provider.

§         Choose Enhanced Data Transfer when you want the consumer application to send all caller information attributes to the provider.

Caution

Increasing the service metering level may lead to a security risk. When choosing the amount of service metering data you should consider the trustworthiness of the Web service provider:

    If you don't have information on where and how the Web service is provided you should choose the Minimal Data Transfer level.

    When you are sure that the Web service is provided by a trustworthy party you can increase the service metering level. For example, you can do this for service providers residing in your internal network.

¡        In the Transfer Protocol screen area, choose the protocol you want to use for transfer of service metering data.

 

 

 

 

End of Content Area