Method, system, and articles of manufacture for providing a servlet container based web service endpoint

• US 7,159,224 B2
• Filed: 04/09/2002
• Issued: 01/02/2007
• Est. Priority Date: 04/09/2002
• Status: Active Grant

• Current Assignee: Oracle America, Inc. (Oracle Corporation)
• Original Assignee: Sun Microsystems Incorporated (Oracle Corporation)
• Inventors: Sharma, Rahul, Chinnici, Roberto
• Primary Examiner(s): Thomson; William
• Assistant Examiner(s): Ho; Andy
• Application Number:
  US10/118,169
• Publication Number:
  US 20030204645A1
• Time in Patent Office: 1,729 Days
• Field of Search: 719/310, 719/316, 719/330, 709/200, 709/201, 709/203, 717/103
• US Class Current: 719/310
• CPC Class Codes: G06F 8/10 Requirements analysis; Specification techniques

Abstract

Methods, systems, and articles of manufacture consistent with certain principles related to the present invention enable a computing system to layer the packaging and deployment of a web service endpoint on a standard servlet component model. To define a web service endpoint, the computing system may develop a service endpoint class that implements a configured service endpoint interface. The interface and endpoint class may be packaged by the computing system into an archive file. The computing system may use the information stored in the archive file to define the service endpoint modify the archive file with class information associated with the defined service endpoint. The modified archive file may be deployed on a container operating within the computing system. Further, the computing system may produce a WSDL based description of the defined service endpoint and export the document such that a remote client may use the information contained in the document to locate and remotely invoke methods on the defined service endpoint.

Claims

1. A computer-implemented method for providing a service associated with a service endpoint program fragment description associated with a service definition interface, the method comprising:

packaging, independent of a servlet component model, at least one of the service endpoint program fragment description, a service endpoint interface, and a deployment descriptor, in an archive file;

defining a service endpoint based on information included in the archive file;

converting the archive file into a servlet component model archive file; and

deploying the converted archive file on a servlet container.

2. The method of claim 1, further comprising:

creating a document that describes the service endpoint based on the information contained in the converted archive file; and

exporting the document such that a process may use the document to access the service endpoint.

3. The method of claim 1, wherein prior to packaging the service endpoint program fragment description the method comprises:

developing the service endpoint program fragment description based on an existing definition of an existing service endpoint.

4. The method of claim 3, wherein developing the service endpoint program fragment description comprises:

mapping elements included in the existing definition to corresponding objects; and

developing the service endpoint program fragment description based on the mapped objects.

5. The method of claim 1, wherein packaging further comprises:

creating a description that describes the service endpoint definition; and

selecting among the service endpoint program fragment description, the description, and a service endpoint interface to form the archive file.

6. The method of claim 2, wherein creating the document further comprises:

creating the document based on a description packaged in the archive file.

7. The method of claim 6, wherein creating the document includes:

mapping objects associated with the defined service endpoint to corresponding elements; and

creating the document based on the mapped elements.

8. The method of claim 1, wherein defining a service endpoint comprises:

linking the service endpoint program fragment description with a servlet program fragment description.

9. The method of claim 8, wherein defining the service endpoint further comprises:

assigning a unique address to the service endpoint definition.

10. The method of claim 9, wherein assigning a unique address comprises:

accessing a deployment descriptor included in the archive file that contains address information associated with the defined service endpoint; and

assigning the unique address to the defined service endpoint based on the address information.

11. The method of claim 1, wherein defining a service endpoint comprises:

defining a protocol binding for the service endpoint definition based on information included in a deployment descriptor contained in the archive file.

12. The method of claim 8, wherein converting the archive file comprises:

adding the servlet program fragment description to the archive file.

13. The method of claim 12, wherein the deployment descriptor includes location information associated with a document that describes the defined service endpoint.

14. The method of claim 1, wherein the archive file is a Web Application Archive (WAR) file.

15. A system for providing a service, comprising:

a developer component, operating independent of a servlet component model, configured to develop a service endpoint interface and a service endpoint class that implements the service endpoint interface, and package the service endpoint interface and class in an archive file; and

a deployer component configured to define a service endpoint using the service endpoint program fragment description packaged in the archive file, convert the archive file into a servlet component model archive file with information associated with the defined service endpoint, deploy the converted archive file on a servlet component model container, develop a document including information describing the defined service endpoint, and export the document such that a process may use the document to access the service endpoint.

16. The system of claim 15, wherein the information associated with the defined service endpoint includes address information used to access the defined service endpoint in response to a remote call received from the process.

17. The system of claim 15, wherein the information associated with the defined service endpoint includes binding information reflecting a protocol binding corresponding to remote calls and responses associated with the defined service endpoint received from and provided to, respectively, the process.

18. The system of claim 15, wherein the information associated with the defined service endpoint includes a servlet program fragment description that is used to initialize the defined service endpoint from the service endpoint program fragment description.

19. The system of claim 16, wherein the information included in the document comprises the address information included in the archive file.

20. The system of claim 17, wherein the information included in the document comprises the binding information included in the archive file.

21. The system of claim 18, wherein the information included in the document comprises the servlet program fragment description.

22. The system of claim 15, wherein the deployer component is further configured to map objects associated with the defined service endpoint to elements that are included in the document.

23. The system of claim 15, wherein the developer component is further configured to develop the service endpoint interface from an available document including information describing a previously defined service endpoint.

24. The system of claim 15, wherein the service program fragment description implements a lifecycle interface that manages a lifecycle of the defined service endpoint in response to a remote call received from the process.

25. The system of claim 15, wherein the developer component is further configured to package a description of the service endpoint definition in the archive file.

26. The system of claim 25, wherein the description is used by the deployer component to develop the document.

27. The method of claim 15, wherein the service endpoint is a Java-based API.

28. The method of claim 15, wherein the service endpoint is a Java API for XML-based RPC (JAX-RPC)-based service endpoint.

29. A system for providing a service, comprising:

a component configured to define a service endpoint using a service endpoint program fragment description packaged in an archive file;

a component configured to modify the archive file with information associated with the defined service endpoint;

a component configured to provide the modified archive file on a servlet container;

a component configured to develop a document including information describing the defined service endpoint; and

a component configured to export the document such that a process may use the document to access the service endpoint.

30. The system of claim 29, wherein the information added to the archive file includes address information used to access the defined service endpoint in response to a remote call received from the process.

31. The system of claim 29, wherein the information added to the archive file includes binding information reflecting a protocol binding corresponding to remote calls and responses associated with the defined service endpoint received from and provided to, respectively, the process.

32. The system of claim 29, wherein the information added to the archive file includes a servlet program fragment description used to initialize the defined service endpoint from the service endpoint program fragment description.

33. The system of claim 30, wherein the information included in the document comprises the address information added to the archive file.

34. The system of claim 31, wherein the information included in the document comprises the binding information added to the archive file.

35. The system of claim 32, wherein the information included in the document comprises the servlet program fragment description.

36. The system of claim 29, further comprising a mapping tool for mapping objects associated with the defined service endpoint to elements that are included in the document.

37. The system of claim 29, wherein the service endpoint interface is developed from an available document including information describing a previously defined service endpoint.

38. The system of claim 29, wherein the service endpoint class implements a lifecycle interface that manages a lifecycle of the defined service endpoint in response to a remote call received from the process.

39. The system of claim 29, wherein the system further comprises:

a component configured to package a description of the service endpoint definition in the archive file.

40. The system of claim 39, wherein the description is used to develop the document.

41. The method of claim 29, wherein the service endpoint is a Java-based API service endpoint.

42. The method of claim 29, wherein the service endpoint is a Java API for XML-based RPC (JAX-RPC)-based service endpoint.

43. A computer-implemented method for providing a web service endpoint on a server implementing a servlet component model, comprising:

developing a web service endpoint class based on an existing web service description document;

packaging, independent of the servlet component model, at least one of the web service endpoint class, service endpoint interface, and deployment information in an archive file;

defining a service endpoint using information included in the archive file and a web services description document;

converting the archive file into a servlet component model archive file; and

deploying the converted archive file on a servlet container.

44. A method, performed by a host computer system, for providing a web service endpoint, the method comprising:

providing a development process for developing a web service endpoint in a first archive file;

providing a deployer process for assembling the first archive file into a second archive file; and

implementing the development and deployment processes with an existing component model implemented by the host computer system such that the existing component model is used to deploy the developed web service endpoint for use by the host system.

45. The method of claim 44, wherein layering comprises:

deploying the second archive file to a servlet container implemented by the host system.

46. The method of claim 44, wherein layering comprises:

linking a class based on the existing component model to a class associated with the web service endpoint.

47. The method of claim 44, further comprising:

creating a web services description of the web service endpoint; and

posting the web services description on a shared access registry.

48. A computer-readable medium memory device including instructions for performing a method, when executed by a processor, for providing a service associated with a service endpoint program fragment description associated with a service definition interface, the method comprising:

packaging, independent of a servlet component model, at least one of the service endpoint program fragment description, a service endpoint interface, and a deployment descriptor, in an archive file;

defining a service endpoint based on information included in the archive file;

converting the archive file into a servlet component model archive file; and

deploying the converted archive file on a servlet container.

49. The computer-readable medium of claim 48, wherein the method further comprises:

creating a document that describes the service endpoint based on the information contained in the converted archive file; and

exporting the document such that a process may use the document to access the service endpoint.

50. The computer-readable medium of claim 48, wherein prior to packaging the service endpoint program fragment description the method comprises:

developing the service endpoint program fragment description based on an existing definition of an existing service endpoint.

51. The computer-readable medium of claim 50, wherein developing the service endpoint program fragment description comprises:

mapping elements included in the existing definition to corresponding objects; and

developing the service endpoint program fragment description based on the mapped objects.

52. The computer-readable medium of claim 48, wherein packaging further comprises:

creating a description that describes the service endpoint definition; and

selecting among the service endpoint program fragment description, the description, and a service endpoint interface to form the archive file.

53. The computer-readable medium of claim 49, wherein creating the document further comprises:

creating the document based on a description packaged in the archive file.

54. The computer-readable medium of claim 53, wherein creating the document includes:

mapping objects associated with the defined service endpoint to corresponding elements; and

creating the document based on the mapped elements.

55. The computer-readable medium of claim 48, wherein defining a service endpoint comprises:

linking the service endpoint program fragment description with a servlet program fragment description.

56. The computer-readable medium of claim 55, wherein defining the service endpoint further comprises:

assigning a unique address to the service endpoint definition.

57. The computer-readable medium of claim 56, wherein assigning a unique address comprises:

accessing a deployment descriptor included in the archive file that contains address information associated with the defined service endpoint; and

assigning the unique address to the defined service endpoint based on the address information.

58. The computer-readable medium of claim 48, wherein defining a service endpoint comprises:

defining a protocol binding for the service endpoint definition based on information included in a deployment descriptor contained in the archive file.

59. The computer-readable medium of claim 55, wherein converting the archive file comprises:

adding the servlet program fragment description to the archive file.

60. The computer-readable medium of claim 59, wherein the deployment descriptor includes location information associated with a document that describes the defined service endpoint.

61. The computer-readable medium of claim 48, wherein the archive file is a Web Application Archive (WAR) file.

62. A system for providing a service associated with a service endpoint program fragment description associated with a service definition interface, the system comprising:

means for packaging, independent of a servlet component model, at least one of the service endpoint program fragment description, the service endpoint interface, and a deployment descriptor, in an archive file;

means for defining a service endpoint based on information included in the archive file;

means for converting the archive file into a servlet component model archive file; and

means for deploying the converted archive file on a servlet container.

63. The system of claim 62, further comprising:

means for creating a document that describes the service endpoint based on the information contained in the converted archive file; and

means for exporting the document such that a process may use the document to access the service endpoint.

64. The system of claim 62, wherein the means for packaging the service endpoint program fragment further comprises:

means for developing the service endpoint program fragment description based on an existing definition of an existing service endpoint.

65. The system of claim 64, wherein developing the service endpoint program fragment description comprises:

mapping elements included in the existing definition to corresponding objects; and

developing the service endpoint program fragment description based on the mapped objects.

66. The system of claim 62, wherein the means for packaging further comprises:

means for creating a description that describes the service endpoint definition; and

means for selecting among the service endpoint program fragment description, the description, and a service endpoint interface to form the archive file.

67. The system of claim 63, wherein the means for creating the document further comprises:

means for creating the document based on a description packaged in the archive file.

68. The system of claim 67, wherein the means for creating the document includes:

means for mapping objects associated with the defined service endpoint to corresponding elements; and

means for creating the document based on the mapped elements.

69. The system of claim 62, wherein the means for defining a service endpoint comprises:

means for linking the service endpoint program fragment description with a servlet program fragment description.

70. The system of claim 69, wherein the means for defining the service endpoint further comprises:

means for assigning a unique address to the service endpoint definition.

71. The system of claim 70, wherein the means for assigning a unique address comprises:

means for accessing a deployment descriptor included in the archive file that contains address information associated with the defined service endpoint; and

means for assigning the unique address to the defined service endpoint based on the address information.

72. The system of claim 62, wherein the means for defining a service endpoint comprises:

means for defining a protocol binding for the service endpoint definition based on information included in a deployment descriptor contained in the archive file.

73. The system of claim 69, wherein the means for converting the archive file comprises:

means for adding the servlet program fragment description to the archive file.

74. The system of claim 73, wherein the deployment descriptor includes location information associated with a document that describes the defined service endpoint.

75. The system of claim 62, wherein the archive file is a Web Application Archive (WAR) file.