Creating Outside-In Web Services

Prerequisites

You have created an EJB project 3.0.

More information: Creating EJB 3.0 Projects in the Developer Studio .
You have created an Enterprise Application Project and the EJB project 3.0 is added to it.
You have configured the AS Java settings in Window Preferences SAP AS Java . More information: Configuring the Application Server in the Developer Studio
The application server and Web service runtime are set in the SAP NetWeaver Developer Studio from Window Preferences Web Services Server and Runtime . In the Server field, choose SAP Server , and in the Web service runtime , choose SAP NetWeaver .
If you want to use the WSDL of a Service Interface modeled in the ESR, open the Enterprise Service Browser. In this case you can start the wizard directly from the Enterprise Service browser. More information: Browsing Enterprise Services from the SAP NetWeaver Developer Studio .
If you want to use customization files, you should have them available in advance.
Optionally, you can configure resource management settings of the SAP NetWeaver Developer Studio.

More Information: Configuring Resource Management Settings

Context

You can create a Web service using a WSDL document as a basis.

In this case, the Web service framework generates the skeleton of the implementation bean containing the Web service methods' declarations for the operations in the WSDL document. You have to provide your own implementation to the Web service methods.

The Java EE Web service tools generate outside-in Web services with EJB endpoints only. By default, the framework creates a stateless session EJB for an endpoint.

Note

Once the skeleton of the implementation bean is generated, you can change the stateless EJB to stateful by replacing the @Stateless annotation with @Stateful in the generated skeleton of the implementation bean.

As a basis for the outside-in Web service generation, you can use a WSDL document located in the Services Registry, the Enterprise Services Repository, or on a file system, or at a remote location (such as a URL). Some WSDL documents, such as those for Service Interfaces (SI) modeled in the ESR may not contain service, port, and/or binding information. During the Web service generation, the framework updates the WSDL document with the necessary information. By default, when the WSDL document does not contain binding information, the Web service framework updates the WSDL and sets the binding to SOAP over HTTP. You cannot change this default setting.

Note

If you have generated an outside-in Web service and want to generate it again based on the same WSDL document that was already imported in the SAP NetWeaver Developer Studio, you have to delete the imported WSDL document from the project in the Developer Studio. You also have to delete all Java artifacts, including the implementation bean, generated in result of the previous generation of the Web service. In this case, before you delete the Java artifacts, you may want to back up any implementation which you have provided in the implementation bean.

More information: Collision Resolution and Global Customizations

Procedure

Import the WSDL document which you want to use to create a Web service. More information: Importing WSDL Documents in the SAP NetWeaver Developer Studio .

Note
If you want to create a Web service from a Service Interface modeled in the ESR, you can start the wizard from the ES Browser (see the next step below). In this case, you do not need to import the WSDL document from the ESR manually. The Web service framework imports it automatically in the project folder. Note that if you use this option, you will not be able to use your own customization files.

Note
On some operating systems, especially when running on virtual machines, long path names or file names may be automatically truncated by the system. This avoids validation of internal references between development objects and affects the Web service artifacts where the references are implemented via file names.

More information: SAP Note https://service.sap.com/sap/support/notes/1291018
To create a Web service from a WSDL document you imported, in the Project Explorer of the Java EE perspective, choose the WSDL document, and then from the context menu choose Web Services Generate Java bean skeleton .

Note
If you want to create a Web service from a Service Interface modeled in the ESR, in the Enterprise Service Browser view, expand the Service Interfaces node of a software component, choose a Service Interface, and then from the context menu choose Generate Java bean skeleton . Note that if you use this option, you will not be able to use your own customization files.

The Web Services wizard opens.

On the Web Services screen, proceed as follows:

Move the slider to the Develop Service position.

In this case, the Web service framework only generates the relevant artifacts (it does not deploy them on the application server) and you can provide an implementation of the generated Java bean skeleton.

Note
It is essential that you configure SAP server and runtime settings in Window Preferences Web Services Server and Runtime prior to creating a Web service. For more information, see the prerequisites section.
Under Configuration , choose Service EAR Project , and make sure that the correct service EAR project is selected in the Service project field.
Choose Next .

Note
If the WSDL document you are using does not contain service, port, and/or binding information, you receive a message, which informs you that the WSDL document will be updated.
If the imported WSDL document does not contain a service endpoint, the Update WSDL window opens.
- To update the WSDL document with a service endpoint or binding, choose Update WSDL . At a later stage, the system overwrites the WSDL document using the values that you provide.
- To preserve the original WSDL document, choose Do not update WSDL . At a later stage, the system creates a new WSDL document using the values that you provide.

On the Select output path screen, proceed as follows:

If necessary, specify the output folder in which you want the Java artifacts to be generated.
Choose the way in which you want to resolve the possible collisions in the WSDL to Java mapping during the conversion of the WSDL document to Java artifacts.

The table below provides information about the separate options and their meaning:

Option	Meaning
Resolve collisions interactively	The Web service framework resolves collisions based on input from you. More information: Using Interactive Conflict Resolution
Resolve collisions automatically	The Web service framework resolves collisions compliant with a predefined algorithm. More information: Using Automatic Conflict Resolution
Specify JAX-WS customization files	You can use JAX-WS 2.0-compliant customization files prepared in advance to apply customizations. This option is available only when the WSDL document is imported in the SAP NetWeaver Developer Studio. Note During the generation process, the Web service framework does not validate the external customization files you might use. You have to ensure that these files are correct and comply with the JAX-WS 2.0 specification. More information: Using JAX-WS Customization Files
Apply WSDL without customizations	The Web service framework processes the WSDL document as it is. If the WSDL document itself contains customizations in that, for example, it was manually edited, the framework will process these customizations. More information: Using No Customizations

Depending on the customizations level you choose on this screen, the wizard provides different options on the subsequent screens. In addition, depending on the settings, which you provided in the Start of the navigation path Window Next navigation step Preferences Web Services Resource Management End of the navigation path window, the tools prompt you to confirm creation of resources or check out of updated existing resources.

Results

The implementation bean is generated. For every property of a design time feature, such as authentication level, or WSRM enablement, which is configured in the WSDL document, the Web service framework has generated the corresponding design time annotations. Next steps:

Provide implementation to the business methods of the Web service.
When you implement the Web service, you can configure the properties of design time or runtime features for this Web service by using annotations provided by SAP. More information: Configuring Web Services at Design Time .

If you want to provide a WS-RM-enabled Web service, or a Web service, which uses TU&C/C, In the application-j2ee-engine.xml file of the EAR containing the Web service, add a runtime reference to the WS-RM application on the application server as shown in the code sample below:
```
<?xml version="1.0" encoding="UTF-8"?>
<application-j2ee-engine xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="application-j2ee-engine.xsd">
  <reference reference-type="hard">
    <reference-target target-type="application" provider-name="sap.com">tc~esi~esp~wsrm~app</reference-target>
  </reference>
</application-j2ee-engine>

               
```
More information: Providing TU&C/C Web Services

Note
If you use development components (DC) to provide Web services, you have to add references to the respective public DC.
Deploy the implemented Web service. More information: Building, Publishing and Removing Published Java EE Applications .

Note
When you create and deploy an outside-in Web service using a WSDL document that has a WS-Policy artifacts on a portType element, the system does not create a service endpoint during deployment. In this case, after you deploy the Web service, you have to create and configure a service endpoint manually.

If the portType element has no policies attached, the system creates a default service endpoint without any authentication policies.
Configure the Web service in the SAP NetWeaver Administrator. More information: Configuring Web Services and Web Service Clients in the SAP NetWeaver Administrator