System and method for a Web service definition

• US 7,620,934 B2
• Filed: 05/28/2004
• Issued: 11/17/2009
• Est. Priority Date: 05/28/2004
• Status: Active Grant

• Current Assignee: SAP SE
• Original Assignee: SAP AG (SAP SE)
• Inventors: Wiechers, Volker, Falter, Timm, Savchenko, Vladimir, Bender, Joachim, Huvar, Martin
• Primary Examiner(s): Vital; Pierre M
• Assistant Examiner(s): Raab; Christopher J
• Application Number:
  US10/856,073
• Publication Number:
  US 20050278348A1
• Time in Patent Office: 1,999 Days
• Field of Search: 717/104, 717/106, 717/108, 717/114, 717/116, 717/118, 719/320, 719/328, 709/223, 707/100
• US Class Current: 717/106
• CPC Class Codes: G06F 16/252 between a Database Management System and a front-end application
• CPC Class Codes: G06F 16/972 Access to data in other repository systems, e.g. legacy data or dynamic Web page generation
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]

Abstract

Embodiments of the invention are generally directed to a system and method for a Web service definition. A development environment may receive input selecting a Web service interface. The development environment may also receive input to specify one or more system independent features of the selected interface. In an embodiment, the development environment may create a Web service definition descriptor file that includes the received input specifying the one or more system independent features.

Claims

1. A method for generating a definition of a Web service comprising:

receiving input selecting a Web service virtual interface that represents an abstract interface defining at least one of a plurality of views of a Web service implementation, the Web service implementation providing logic for a Web service, the plurality of views selectively exposing methods and parameters of the Web service implementation;

receiving input specifying one or more system independent features for the selected virtual interface;

creating a Web service definition descriptor file corresponding to the selected virtual interface based on

generic metadata of the selected virtual interface, the generic metadata providing an abstraction layer over endpoint types underlying the logic for the Web service provided by the Web service implementation, and

the one or more system independent features specified for the selected virtual interface;

wherein the Web service definition descriptor file and the selected virtual interface provide a system independent design time description of the Web service;

generating a Web service description of the at least one of the plurality of views of the Web service implementation defined by the selected virtual interface, wherein the Web service description is a Web Service Description Language (WSDL) file that is based, at least in part, on the Web service definition descriptor file and the selected virtual interface to provide the system independent design time description of the Web service; and

referencing a Web service configuration to generate the Web service description, the Web service configuration mapping the system independent design time description of the Web service provided in the generated WSDL file to particular transports, bindings and protocols.

2. The method of claim 1, wherein receiving input specifying one or more system independent features for the selected virtual interface comprises:

receiving input specifying at least one of

a session feature,

a security feature,

a transport guarantee feature, and

a quality-of-service feature.

3. The method of claim 2, wherein receiving input specifying the session feature of the selected virtual interface comprises:

receiving input specifying that a session between the selected virtual interface and a Web service client is to be stateful.

4. The method of claim 2, wherein receiving input specifying a session feature of the selected virtual interface comprises:

receiving input specifying that a session between the selected virtual interface and a Web service client is to be stateless.

5. The method of claim 2, wherein receiving input specifying the security feature of the selected virtual interface comprises:

receiving input specifying an authentication feature of the virtual interface.

6. The method of claim 5, wherein receiving input specifying the authentication feature of the selected virtual interface comprises:

receiving input specifying a minimum level of authentication.

7. The method of claim 6, wherein receiving input specifying the minimum level of authentication comprises at least one of:

receiving input specifying no authentication for a call from a Web service client;

receiving input specifying the Web service client is to provide a user identifier and a password; and

receiving input specifying the use of client certificates.

8. The method of claim 2, wherein receiving input specifying the transport guarantee feature of the selected virtual interface comprises at least one of:

receiving input specifying message integrity for a message sent between the virtual interface and a Web service client;

receiving input specifying message confidentiality; and

receiving input specifying both message integrity and message confidentiality.

9. The method of claim 8, wherein receiving input specifying message confidentiality comprises:

receiving input specifying the message is to be encrypted.

10. The method of claim 2, wherein receiving input specifying the quality-of-service feature of the selected virtual interface comprises:

receiving input specifying that a message sent between the virtual interface and a Web service client is sent once.

11. The method of claim 1, further comprising:

publishing the Web service description on a service directory.

12. The method of claim 1, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates at least one of renaming and hiding methods and parameters of the Web service implementation.

13. The method of claim 1, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining standard values for the parameters of the Web service implementation.

14. The method of claim 1, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates converting parameter types of the parameters of the Web service implementation, including converting integer parameter types to string parameter types and string parameter types to integer parameter types.

15. The method of claim 1, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining how parameters of the Web service implementation are represented in a protocol, including how parameters of the Web service implementation are represented in the SOAP protocol.

16. An apparatus to generate a definition of a Web service comprising:

a development environment to create a Web service virtual interface that represents an abstract interface defining at least one of a plurality of views of a Web service implementation, the Web service implementation providing logic for a Web service, the plurality of views selectively exposing methods and parameters of the Web service implementation; and

a processor and logic executable thereon to

receive input selecting the virtual interface;

receive input specifying one or more system independent features for the selected virtual interface;

create a Web service definition descriptor file corresponding to the selected virtual interface based on

generic metadata of the selected virtual interface, the generic metadata providing an abstraction layer over endpoint types underlying the logic for the Web service provided by the Web service implementation, and

the one or more system independent features specified for the selected virtual interface;

wherein the Web service definition descriptor file and the selected virtual interface provide a system independent design time description of the Web service;

generate a Web service description of the at least one of the plurality of views of the Web service implementation defined by the selected virtual interface, wherein the Web service description is a Web Service Description Language (WSDL) file that is based, at least in part, on the Web service definition descriptor file and the selected virtual interface to provide the system independent design time description of the Web service; and

reference a Web service configuration to generate the Web service description, the Web service configuration mapping the system independent design time description of the Web service provided in the generated WSDL file to particular transports, bindings and protocols.

17. The apparatus of claim 16, wherein the processor and logic executable thereon to receive input specifying one or more system independent features for the selected virtual interface comprises a processor and logic executable thereon to receive input specifying at least one of

a session feature,

a security feature,

a transport guarantee feature, and

a quality-of-service feature.

18. The apparatus of claim 17, wherein the processor and logic executable thereon is further to

generate a Web service description of the Web service implementation based, at least in part, on the Web service definition descriptor file;

and

publish the Web service description on a service directory.

19. The apparatus of claim 16, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates at least one of renaming and hiding methods and parameters of the Web service implementation.

20. The apparatus of claim 16, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining standard values for the parameters of the Web service implementation.

21. The apparatus of claim 16, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates converting parameter types of the parameters of the Web service implementation, including converting integer parameter types to string parameter types and string parameter types to integer parameter types.

22. The apparatus of claim 16, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining how parameters of the Web service implementation are represented in a protocol, including how parameters of the Web service implementation are represented in the SOAP protocol.

23. A system for generating a definition of a Web service comprising:

means for receiving input selecting a Web service virtual interface that represents an abstract interface defining at least one of a plurality of views of a Web service implementation, the Web service implementation providing logic for a Web service, the plurality of views selectively exposing methods and parameters of the Web service implementation;

means for receiving input specifying one or more system independent features for the selected virtual interface;

means for creating a Web service definition descriptor file corresponding to the selected virtual interface based on

the generic metadata of the selected virtual interface, the generic metadata providing an abstraction layer over endpoint types underlying the logic for the Web service provided by the Web service implementation, and

the one or more system independent features specified for the selected virtual interface;

wherein the Web service definition descriptor file and the selected virtual interface provide a system independent design time description of the Web service;

means for generating a Web service description of the at least one of the plurality of views of the Web service implementation defined by the selected virtual interface, including means for generating a Web Service Description Language (WSDL) file that is based, at least in part, on the Web service definition descriptor file and the selected virtual interface to provide the system independent design time description of the Web service; and

means for referencing a Web service configuration in the means for generating the Web service description, the Web service configuration providing a means for mapping the system independent design time description of the Web service provided in the generated WSDL file to particular transports, bindings and protocols.

24. The system of claim 23, wherein the means for receiving input specifying one or more system independent features for the selected virtual interface comprises:

means for receiving input specifying at least one of

a session feature,

a security feature,

a transport guarantee feature, and

a quality-of-service feature.

25. The system of claim 24, wherein the means for receiving input specifying the session feature of the selected virtual interface comprises:

means for receiving input specifying that a session between the selected virtual interface and a Web service client is to be stateful.

26. The system of claim 24, wherein the means for receiving input specifying the security feature of the selected virtual interface comprises:

means for receiving input specifying an authentication feature of the virtual interface.

27. The system of claim 24, wherein the means for receiving input specifying a security feature of the selected virtual interface comprises:

means for receiving input specifying an authorization feature for the selected virtual interface.

28. The system of claim 24, wherein receiving input specifying the transport guarantee feature of the selected virtual interface comprises at least one of:

receiving input specifying message integrity for a message sent between the virtual interface and a Web service client;

receiving input specifying message confidentiality for the message; and

receiving input specifying both message integrity and message confidentiality for the message.

29. The system of claim 23, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates at least one of renaming and hiding methods and parameters of the Web service implementation.

30. The system of claim 23, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining standard values for the parameters of the Web service implementation.

31. The system of claim 23, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates converting parameter types of the parameters of the Web service implementation, including converting integer parameter types to string parameter types and string parameter types to integer parameter types.

32. The system of claim 23, wherein the plurality of views selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining how parameters of the Web service implementation are represented in a protocol, including how parameters of the Web service implementation are represented in the SOAP protocol.

33. An article of manufacture for generating a definition of a Web service comprising:

an machine-readable storage medium providing instructions that, when executed by an apparatus, cause the apparatus to

receive input selecting a Web service virtual interface, the selected virtual interface representing an abstract interface defining at least one of a plurality of views of a Web service implementation, the Web service implementation providing logic for a Web service, the plurality of views selectively exposing, at least in part, methods and parameters of an interface for the Web service implementation;

receive input specifying one or more system independent features for the selected virtual interface;

create a Web service definition descriptor file corresponding to the selected virtual interface based on

generic metadata of the selected virtual interface, the generic metadata providing an abstraction layer over endpoint types underlying the logic for the Web service provided by the Web service implementation, and

the one or more system independent features specified for the selected virtual interface;

wherein the Web service definition descriptor file and the selected virtual interface provide a system independent design time description of the Web service;

generate a Web service description of the at least one of the plurality of views of the Web service implementation defined by the selected virtual interface wherein the Web service description is a Web Service Description Language (WSDL) file that is based, at least in part, on the Web service definition descriptor file and the selected virtual interface to provide the system independent design time description of the Web service; and

reference a Web service configuration to generate the Web service description, the Web service configuration mapping the system independent design time description of the Web service provided in the generated WSDL file to particular transports, bindings and protocols.

34. The article of manufacture of claim 33, wherein the instructions that, when executed by the apparatus, cause the apparatus to receive input specifying one or more system independent features for the selected virtual interface cause the apparatus to receive input specifying at least one of

a session feature,

a security feature,

a transport guarantee feature, and

a quality-of-service feature.

35. The article of manufacture of claim 34, wherein the instructions that, when executed by the apparatus, cause the apparatus to receive input specifying the session feature of the selected virtual interface cause the apparatus to receive input specifying that a session between the selected virtual interface and a Web service client is to be stateless.

36. The article of manufacture of claim 34, wherein the instructions that, when executed by the apparatus, cause the apparatus to receive input specifying the security feature of the selected virtual interface cause the apparatus to receive input specifying an authentication feature of the virtual interface.

37. The article of manufacture of claim 36, wherein the instructions that, when executed by the apparatus, cause the apparatus to receive input specifying the authentication feature of the selected virtual interface cause the apparatus to perform at least one of

receive input specifying no authentication for a call from a Web service client;

receive input specifying the Web service client is to provide a user identifier and a password; and

receive input specifying the use of client certificates.

38. The article of manufacture of claim 36, wherein the instructions that, when executed by the apparatus, cause the apparatus to receive input specifying the transport guarantee feature of the selected virtual interface cause the apparatus to perform at least one of

receive input specifying message integrity for a message sent between the virtual interface and a Web service client;

receive input specifying message confidentiality; and

receive input specifying both message integrity and message confidentiality.

39. The article of manufacture of claim 33, wherein the machine-readable storage medium provides further instructions that, when executed by the apparatus, cause the apparatus to

receive input specifying that a message sent between the virtual interface and a Web service client is sent once;

and

publish the Web service description on a service directory.

40. The article of manufacture of claim 33, wherein the view selectively exposing methods and parameters of the Web service implementation includes a view that facilitates at least one of renaming and hiding methods and parameters of the Web service implementation.

41. The article of manufacture of claim 33, wherein the view selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining standard values for the parameters of the Web service implementation.

42. The article of manufacture of claim 33, wherein the view selectively exposing methods and parameters of the Web service implementation includes a view that facilitates converting parameter types of the parameters of the Web service implementation, including converting integer parameter types to string parameter types and string parameter types to integer parameter types.

43. The article of manufacture of claim 33, wherein the view selectively exposing methods and parameters of the Web service implementation includes a view that facilitates defining how parameters of the Web service implementation are represented in a protocol, including how parameters of the Web service implementation are represented in the SOAP protocol.