Method and apparatus for providing web services in a collaborative computing system

• US 7,363,342 B1
• Filed: 07/08/2003
• Issued: 04/22/2008
• Est. Priority Date: 07/08/2003
• Status: Expired due to Fees

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Ozzie, Jack E., Wang, Weidong, Burkhardt, John
• Primary Examiner(s): Najjar; Saleh
• Assistant Examiner(s): Hamza; Faruk
• Application Number:
  US10/615,281
• Time in Patent Office: 1,750 Days
• Field of Search: 709204-207, 709227-228, 709/223
• US Class Current: 709/204
• CPC Class Codes: H04L 61/4541 Directories for service discovery
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]

Abstract

An API development framework uses a Simple Object Access Protocol (SOAP) protocol to provide access to a collaborative client from a remote user that does not have access to the collaborative software. A WSAP server acts as a bridge between the native collaborative environment and any non-native environment or application that can process SOAP commands and allows the two entities to communicate regardless of firewalls and other security software. The non-native environment can be either local (on the same machine as the collaborative client program) or physically remote (on a different machine). In addition to the server, the illustrative framework includes client side support that is comprised of a SOAP proxy component and remote interfaces to collaborative system objects and platform tools.

Claims

1. A method for providing access over a network to data and services available within a collaborative computer system, the collaborative system comprising a plurality of collaborative clients, the method comprising:

a) maintaining, by each collaborative client, data based on user interactions with the collaborative system, the maintaining comprising, for each collaborative client, having a local copy of collaborative data and forwarding data change requests to other collaborative clients and using data change requests in modifying the local copy;

b) providing access to the collaborative data in response to a request message from a non-native client, the non-native client accessing the collaborative data other than through the collaborative system, the request message containing information identifying the non-native client;

c) receiving the request message in a server connected to the non-native client, extracting from the request message the information identifying the non-native client and modifying the request message by replacing the information identifying the non-collaborative client with information identifying a queue in the server, the queue being associated with the non-native client and the server;

d) sending the modified request message to a collaborative client of the plurality of collaborative clients via the network, wherein the request message specifies collaborative data to update or return, and the collaborative client provides a response message based on the request message;

e) sending the response message to the server queue identified in the modified request message, and

f) using the information in the server identifying the non-native client to forward the response message from the server queue to the non-collaborative client.

2. The method of claim 1 further comprising:

(e) before step (a) is performed, the collaborative client publishing a convenient name associated with at least a portion of the data and services available within the collaborative computer system.

3. The method of claim 2 wherein the request message includes the convenient name and step (a) comprises:

(a1) extracting from the request message the convenient name; and

(a2) using the convenient name to retrieve information identifying a location of the collaborative client that can provide the at least a portion of the data and services.

4. The method of claim 2 wherein step (b) comprises:

(b1) sending the modified request message directly to the collaborative client when the collaborative client is connected to the network; and

(b2) sending the modified request message to a relay server when the collaborative client is not connected to the network.

5. The method of claim 4 wherein the server is part of the relay server that connects the non-native client to the network.

6. The method of claim 4 wherein the server waits on the server queue after step (b) and wherein step (d) further comprises:

(d1) forwarding the response message from the server queue to the non-native client when the response message is received in the server queue.

7. The method of claim 4 wherein the server does not wait for a response in step (b) and wherein step (d) is performed in response to a method call by the non-native client.

8. The method of claim 7 wherein the request message contains a unique request identifier and wherein the response message returns the unique request identifier to the non-native client and the non-native client compares the request identifier sent in the request message with the request identifier in the response message to determine if the response is associated with the request.

9. The method of claim 4 further comprising:

(e) subscribing to an event service at the collaborative client indicating a request for notification of selected actions in the collaborative system; and

(f) the collaborative client placing event messages in the server queue when a selected action occurs.

10. The method of claim 9 wherein:

the request and the response messages have a same protocol; and

the protocol is the Simple Object Access Protocol (SOAP).

11. The method of claim 10, wherein:

the request message identifies a specific collaborative client with a collaborative client identifier; and

the server;

performs a name lookup of the collaborative client identifier to determine a name look-up result for the collaborative client;

removes the collaborative client identifier from the message; and

adds the name lookup result to the message.

12. Apparatus for providing access over a network to data and services, the apparatus comprising:

a collaborative system comprising a plurality of collaborative clients, each collaborative client having a local copy of collaborative data and being adapted to forward data change requests to other collaborative clients and use data change requests in modifying the local copy;

an external client, the external client being external to the collaborative system and being adapted to send a request message, the request message containing information identifying the external client, wherein the collaborative system is adapted to provide access to the collaborative data in response to the request message;

a server connected to the external client, including means for receiving the request message, means for extracting from the request message the information identifying the external client and means for modifying the request message by replacing the information identifying the external client with information identifying a queue in the server, the queue being associated with the external client and the server;

a first communication mechanism for sending the modified request message to a collaborative client of the plurality of collaborative clients via the network, wherein the collaborative client provides a response message containing the data and services requested;

a second communication mechanism for storing the response message in the server queue identified in the modified request message, the queue being associated with the external client, and

a contact mechanism responsive to the information in the server identifying the external client for forwarding the response message from the server queue to the external client.

13. The apparatus of claim 12 further comprising means operable by the collaborative client for publishing a convenient name associated with selected data and services available in the collaborative computer system before the external client generates the request message.

14. The apparatus of claim 13 wherein the request message includes the convenient name and wherein the receiving means in the server comprises a mechanism for extracting from the request message the convenient name and a name service that is responsive to the convenient name for retrieving information identifying the location of the collaborative client that can provide the selected data and services.

15. The apparatus of claim 12 wherein the first communication mechanism comprises:

means for sending the modified request message directly to the collaborative client when the collaborative client is connected to the network; and

means for sending the modified request message to a relay server when the collaborative client is not connected to the network.

16. The apparatus of claim 15 wherein the server is part of the relay server that connects the external client to the network.

17. The apparatus of claim 12 wherein the server waits on the server queue after the first communication mechanism sends the request message to the collaborative client and wherein the contact mechanism comprises means for forwarding the response message from the server queue to the external client when the response message is received in the server queue.

18. The apparatus of claim 12 wherein the server does not wait for a response in after the first communication mechanism sends the request message to the collaborative client and wherein the contact mechanism sends forwarding the response message from the server queue to the client in response to a method call by the non-collaborative client.

19. The apparatus of claim 18 wherein the request message contains a unique request identifier and wherein the response message returns the unique request identifier to the external client and the external client comprises a comparator that compares the request identifier sent in the request message with the request identifier in the response message to determine if the response is associated with the request.

20. The apparatus of claim 12 further comprising:

a subscription service responsive to a request from the external client for subscribing to an event service at the collaborative client indicating a request for notification of selected actions in the collaborative system; and

an event mechanism in the collaborative client that places event messages in the server queue when a selected action occurs.

21. The apparatus of claim 12 wherein:

the request and the response messages have the same protocol; and

the protocol is the Simple Object Access Protocol.

22. The method of claim 21, wherein the queue is identified with a generated device URL associated with a SOAP header.

23. A computer program product for providing access over a network to data and services available within a collaborative computer system, the collaborative system comprising a plurality of collaborative clients, the computer program product comprising a tangible computer usable medium having computer readable program code thereon, including:

program code for maintaining, by each collaborative client, data based on user interactions with the collaborative system, the maintaining comprising, for each collaborative client, having a local copy of collaborative data and forwarding data change requests to other collaborative clients and using data change requests in modifying the local copy;

program code for providing access to the collaborative data in response to a request message from a non-native client the non-native client accessing the collaborative data other than through the collaborative system, the request containing information identifying the non-native client;

program code for receiving the request message in a server connected to the non-native client, extracting from the request message the information identifying the non-native client and modifying the request message by replacing the information identifying the non-native client with information identifying a queue in the server;

program code for sending the modified request message to a collaborative client in the collaborative computer system via the network, wherein the collaborative client provides a response message containing the data and services requested from the collaborative system;

program code for sending the response message to the server queue identified in the modified request message, and

program code for using the information in the server identifying the non-native client to forward the response message from the server queue to the non-native client, the queue being associated with the non-native client and the server.