Flexibly transferring typed application data

• US 8,296,354 B2
• Filed: 12/03/2004
• Issued: 10/23/2012
• Est. Priority Date: 12/03/2004
• Status: Active Grant

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Christensen, Erik Bo, Balayoghan, Vaithiakingam B., Coulson, Michael James, Sturgell, Ryan Thomas, Jethanandani, Natasha Harish, Marucheck, Michael Jon, Purdy, Douglas M., Wolf, Kenneth David, Vernal, Michael Steven, Pharies, Stefan Harrington, Wortendyke, David
• Primary Examiner(s): Salad, Abdullahi
• Assistant Examiner(s): Keehn, Richard G
• Application Number:
  US11/003,099
• Publication Number:
  US 20060123047A1
• Time in Patent Office: 2,881 Days
• Field of Search: 709/203
• US Class Current: 709/203
• CPC Class Codes: G06F 9/547 Remote procedure calls [RPC]; Web services
• CPC Class Codes: H04L 67/01 Protocols
• CPC Class Codes: H04L 67/133 Protocols for remote procedure calls [RPC]

Abstract

The present invention extends to using Simple Object Access Protocol (“SOAP”) to exchange typed objects, such as, for example, parameters for invoking methods. A computer system accesses typed object parameters corresponding to a typed object. The typed object is annotated with one or more message contract attributes of a message contract model defining a mapping between typed object parameters and corresponding SOAP elements. The computer system utilizes the message contract attributes to map the typed object parameters into a SOAP element and inserts the SOAP element into a SOAP envelope. A receiving computer system accessing the SOAP element and utilizes the message contract attributes to map the SOAP element back into the typed object parameters.

Claims

1. A first computer system, comprising:

at least one processing unit; and

at least one system memory communicatively coupled to the at least one processing unit and comprising computer-readable instructions that when executed by the at least one processing unit perform a method of converting typed application data into a Simple Object Access Protocol (SOAP) format, the method comprising;

an act of storing by the first computer system a typed data object, wherein the typed data object defines a method associated with a first portion of a distributed application, wherein the typed data object comprises;

typed application data comprising at least one typed object parameter for invoking the method, wherein the at least one typed object parameter is in a format compatible with the first portion of the distributed application and with a second portion of the distributed application on a second computer system; and

at least one message contract attribute of a message contract model, wherein the at least one message contract attribute annotates the typed data object such that the at least one message contract attribute is adjacent to the at least one typed object parameter, wherein the at least one message contract attribute defines a mapping between the at least one typed object parameter and a corresponding SOAP element, and wherein the at least one message contract attribute specifies a location within a SOAP envelope for inserting the corresponding SOAP element;

an act of accessing the typed data object;

an act of mapping the at least one typed object parameter to the corresponding SOAP element by referring to the at least one message contract attribute that annotates the accessed typed data object;

an act of inserting the corresponding SOAP element into the location within the SOAP envelope in accordance with the at least one message contract attribute; and

an act of transmitting the SOAP envelope to the second portion of the distributed application on the second computer system.

2. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing a class that represents parameters to the method.

3. The first computer system as recited in claim 2, wherein the act of accessing the class that represents parameters to the method comprises an act of accessing a public class that represents parameters to a Common Language Runtime method.

4. The first computer system as recited in claim 1, wherein the typed data object is annotated with an Action URI.

5. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing a class that represents a method return value.

6. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing a Common Language Runtime representation of a SOAP element.

7. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing a typed message.

8. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing the typed object parameter that is annotated with the at least one message contract attribute, wherein the at least one message contract attribute indicates that an XML representation of the typed object parameter is to be included in a SOAP envelope header.

9. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing the typed object parameter that is annotated with the at least one message contract attribute, wherein the at least one message contract attribute indicates that an XML representation of the typed object parameter is to be included in a SOAP envelope body.

10. The first computer system as recited in claim 1, wherein the act of accessing the typed data object comprises an act of accessing one or more typed object parameters that are annotated with one or more message contract attributes, the one or more message contract attributes being selected from among attributes that indicate a position within a SOAP envelope, a name, a namespace URI, whether a typed object parameter must be understood, whether a typed object parameter can be relayed, and an actor for the a typed object parameter.

11. The first computer system as recited in claim 1, wherein the act of mapping the typed object parameter into the corresponding SOAP element in accordance with the at least one message contract attribute comprises an act of serializing the typed object parameter to the corresponding SOAP element.

12. The first computer system as recited in claim 1, wherein the act of mapping the typed object parameter into the corresponding SOAP element in accordance with the at least one message contract attribute comprises an act of mapping typed object parameter into a corresponding XML element.

13. The first computer system as recited in claim 1, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting the corresponding SOAP element into a header portion of the SOAP envelope in accordance with the at least one message contract attribute.

14. The first computer system as recited in claim 1, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting the corresponding SOAP element into a body portion of a SOAP envelope in accordance with the at least one message contract attribute.

15. The first computer system as recited in claim 1, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting corresponding XML instructions into a header portion of the SOAP envelope.

16. The first computer system as recited in claim 1, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting corresponding XML elements into a body portion of the SOAP envelope.

17. The first computer system as recited in claim 1, further comprising:

an act of encoding the SOAP envelope into raw octets; and

an act of sending the raw octets to the second computer system.

18. The first computer system as recited in claim 17, wherein the act of encoding the SOAP envelope into raw octets comprises an act of encoding the SOAP envelope into raw octets wherein the size of the raw octets has no predefined limit.

19. The first computer system as recited in claim 17, wherein the act of encoding the SOAP envelope into raw octets comprises an act of generating a text-based encoding of the SOAP envelope.

20. The first computer system as recited in claim 17, wherein the act of encoding the SOAP envelope into raw octets comprises an act of using a Message-Transmission Optimization Mechanism to encode the SOAP envelope.

21. The first computer system as recited in claim 17, wherein the act of encoding the SOAP envelope into raw octets comprises an act of generating a binary-based encoding of the SOAP envelope.

22. The first computer system as recited in claim 21, wherein the act of generating a binary-based encoding of the SOAP envelope comprises an act of substituting one or more SOAP terms or XML terms with substitute terms of reduced length such that the SOAP envelope can be transferred more efficiently.

23. The first computer system as recited in claim 17, wherein the act of sending the raw octets to the other computer system comprises an act of streaming the raw octets to the second computer system.

24. A computer-implemented method for converting typed application data into a Simple Object Access Protocol (SOAP) format, the method comprising:

an act of storing by a first computer system a typed data object, wherein the typed data object defines a method associated with a first portion of a distributed application, wherein the typed data object comprises;

typed application data comprising at least one typed object parameter for invoking the method, wherein the at least one typed object parameter is in a format compatible with the first portion of the distributed application and with a second portion of the distributed application on a second computer system; and

at least one message contract attribute of a message contract model, wherein the at least one message contract attribute annotates the typed data object such that the at least one message contract attribute is adjacent to the at least one typed object parameter, wherein the at least one message contract attribute defines a mapping between the at least one typed object parameter and a corresponding SOAP element, and wherein the at least one message contract attribute specifies a location within a SOAP envelope for inserting the corresponding SOAP element;

an act of accessing the typed data object;

an act of mapping the at least one typed object parameter to the corresponding SOAP element by referring to the at least one message contract attribute that annotates the accessed typed data object;

an act of inserting the corresponding SOAP element into the location within the SOAP envelope in accordance with the at least one message contract attribute; and

an act of transmitting the SOAP envelope to the second portion of the distributed application on the second computer system.

25. The computer-implemented method as recited in claim 24, wherein the act of accessing the typed data object comprises accessing a public class that represents parameters to a Common Language Runtime method.

26. The computer-implemented method as recited in claim 24, wherein the act of accessing the typed data object comprises accessing a public class that represents a Common Language Runtime method return value.

27. The computer-implemented method as recited in claim 24, wherein the act of mapping the typed object parameter to the corresponding SOAP element comprises serializing the typed object parameter to the corresponding SOAP element.

28. The computer-implemented method as recited in claim 24, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting the corresponding SOAP element into a header portion of the SOAP envelope in accordance with the at least one message contract attribute.

29. The computer-implemented method as recited in claim 24, wherein the act of inserting the corresponding SOAP element into the location within the SOAP envelope comprises an act of inserting the corresponding SOAP element into a body portion of the SOAP envelope in accordance with the at least one message contract attribute.

30. The computer-implemented method as recited in claim 24, wherein the typed data object comprises at least a first typed object parameter that is mapped to a header portion of the SOAP envelope in accordance with a first message contract attribute, and wherein the type data object further comprises at least a second typed object parameter that is mapped to a body portion of the SOAP envelope in accordance with a second message contract attribute.