Processing fast and slow SOAP requests differently in a web service application of a multi-functional peripheral

• US 7,904,917 B2
• Filed: 12/18/2006
• Issued: 03/08/2011
• Est. Priority Date: 12/18/2006
• Status: Active Grant

• Current Assignee: Ricoh Company Limited
• Original Assignee: Ricoh Company Limited
• Inventors: Tian, Lifen, Regnier, Alain, Wang, Yao-Tian
• Primary Examiner(s): Sough; Hyung S
• Assistant Examiner(s): Seye; Abdou K
• Application Number:
  US11/641,355
• Publication Number:
  US 20080148278A1
• Time in Patent Office: 1,541 Days
• Field of Search: 719/330, 709/217
• US Class Current: 719/330
• CPC Class Codes: G06F 9/4881 Scheduling strategies for dispatcher, e.g. round robin, multi-level priority queues
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]
• CPC Class Codes: H04L 67/61 taking into account QoS or priority requirements
• CPC Class Codes: H04L 69/16 Implementation or adaptation of Internet protocol [IP], of transmission control protocol [TCP] or of user datagram protocol [UDP]

Abstract

Techniques are provided for efficiently processing SOAP requests at a Web service application (WSA) of a multi-functional device (MFP). In one technique, a WSA includes at least three threads. An external request processing thread processes SOAP requests from different client applications. A request processing thread processes a SOAP request according to the business logic of the WSA. A internal communications thread communicates with other components of the MFP that are distinct from the WSA. In another technique, a WSA processes different SOAP request differently, depending on the size of the SOAP and the resources required to process the SOAP request so that fast requests may be processed immediately while slow requests are pending. In another technique, a WS-Eventing specification is implemented within a WSA to simplify the event subscription and notification process.

Claims

1. A method for processing different types of SOAP requests at a multi-functional peripheral (MFP), wherein the MFP comprises a plurality of service applications that each provides at least one service, the method comprising:

receiving, at a service application of the plurality, a SOAP request from a client application;

determining whether a time required to process the SOAP request and data associated with the SOAP request is long enough to cause the client application to timeout;

if the time required to process the SOAP request and said data is not long enough to cause the client application to timeout, then processing the SOAP request as a request of a first type;

if the time required to process the SOAP request and said data is long enough to cause the client application to timeout, then processing the SOAP request as a request of a second type;

if the SOAP request is of the first type, then, without narrowing a transmission control protocol (TCP) window of a connection between the service application and the client application, placing the SOAP request in a first queue for subsequent handling and processing the SOAP request and said data;

if the SOAP request is of the second type, then;

determining whether a second queue that is different than the first queue is full;

if the second queue is full, then sending, to the client application, a response that indicates that the service application is presently unable to handle the SOAP request;

if the second queue is not full, then narrowing the TCP window and placing the SOAP request in the second queue for subsequent handling, and then, when the time required to process the SOAP request is no longer long enough to cause the client application to timeout, widening the TCP window and processing the SOAP request and said data.

2. The method of claim 1, wherein:

the time required to process the SOAP request is long enough due, at least in part, to unavailability of a resource that is required by the SOAP request;

the resource is unavailable to the SOAP request;

the resource is shared among a plurality of client applications; and

the method further comprising processing the SOAP request after the resource becomes available to the SOAP request.

3. The method of claim 1, wherein the MFP includes a print process for processing print data and causing a printed version of an electronic document reflected in the print data to be generated.

4. The method of claim 1, wherein:

a device facility manager (DFM) is associated with the MFP and handles device metadata requests from client applications that seek services provided by the MFP; and

the DFM implements one or more Web Services protocols.

5. The method of claim 1, further comprising:

composing a response based on the SOAP request; and

returning the response to the client application.

6. The method of claim 1, wherein:

the service application includes;

a first thread that is dedicated to handling requests of the first type; and

a second thread that is dedicated to handling requests of the second type; and

a third thread determines whether the SOAP request is a request of the first type or of the second type;

if the SOAP request is of the first type, then the third thread places the SOAP request in the first queue for subsequent handling by the first thread; and

if the SOAP request is of the second type, then the third thread places the SOAP request in the second queue for subsequent handling by the second thread.

7. The method of claim 6, wherein the third thread waits for SOAP requests from client applications and receives the SOAP request.

8. The method of claim 6, wherein:

if the SOAP request is of the first type, then the first thread initiates the processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread initiates the processing of the SOAP request.

9. The method of claim 8, wherein:

if the SOAP request is of the first type, then the first thread initiates communication with a platform of the MFP; and

if the SOAP request is of the second type, then the second thread initiates communication with the platform.

10. The method of claim 8, wherein:

if the SOAP request is of the first type, then the first thread forwards the SOAP request to another module of the MFP for further processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread forwards the SOAP request to the other module for further processing of the SOAP request.

11. One or more non-transitory machine-readable media for processing different types of SOAP requests at a multi-functional peripheral (MFP), wherein the MFP comprises a plurality of service applications that each provides at least one service, the non-transitory machine-readable medium storing instructions which, when processed by one or more processors, causes:

receiving, at a service application of the plurality, a SOAP request from a client application;

determining whether a time required to process the SOAP request and data associated with the SOAP request is long enough to cause the client application to timeout;

if the time required to process the SOAP request is not long enough to cause the client application to timeout, then processing the SOAP request as a request of a first type;

if the time required to process the SOAP request is long enough to cause the client application to timeout, then processing the SOAP request as a request of a second type;

if the SOAP request is of the first type, then, without narrowing a transmission control protocol (TCP) window of a connection between the service application and the client application, placing the SOAP request in a first queue for

subsequent handling and processing the SOAP request and said data;

if the SOAP request is of the second type, then;

determining whether a second queue that is different than the first queue is full;

if the second queue is full, then sending, to the client application, a response that indicates that the service application is presently unable to handle the SOAP request;

if the second queue is not full, then narrowing the TCP window and placing the SOAP request in the second queue for subsequent handling, and then, when the time required to process the SOAP request is no longer long enough to cause the client application to timeout, widening the TCP window and processing the SOAP request and said data.

12. The one or more non-transitory machine-readable media of claim 11, wherein:

the time required to process the SOAP request is long enough due, at least in part, to unavailability of a resource that is required by the SOAP request;

the resource is unavailable to the SOAP request;

the resource is shared among a plurality of client applications; and

the machine-readable medium further comprising processing the SOAP request and said data after the resource becomes available to the SOAP request.

13. The one or more non-transitory machine-readable media of claim 11, wherein the MFP includes a print process for processing print data and causing a printed version of an electronic document reflected in the print data to be generated.

14. The one or more non-transitory machine-readable media of claim 11, wherein a device facility manager (DFM) is associated with the MFP and handles device metadata requests from client applications that seek services provided by the MFP;

and

the DFM implements one or more Web Services protocols.

15. The one or more non-transitory machine-readable media of claim 11, wherein the instructions include instructions which, when processed by the one or more processors, further causes:

composing a response based on the SOAP request; and

returning the response to the client application.

16. The one or more non-transitory machine-readable media of claim 11, wherein the service application includes:

a first thread that is dedicated to handling requests of the first type; and

a second thread that is dedicated to handling requests of the second type; and

a third thread determines whether the SOAP request is a request of the first type or of the second type;

if the SOAP request is of the first type, then the third thread places the SOAP request in the first queue for subsequent handling by the first thread; and

if the SOAP request is of the second type, then the third thread places the SOAP request in the second queue for subsequent handling by the second thread.

17. The one or more non-transitory machine-readable media of claim 16, wherein the third thread waits for SOAP requests from client applications and receives the SOAP request.

18. The one or more non-transitory machine-readable media of claim 16, wherein:

if the SOAP request is of the first type, then the first thread initiates the processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread initiates the processing of the SOAP request.

19. The one or more non-transitory machine-readable media of claim 18, wherein:

if the SOAP request is of the first type, then the first thread initiates communication with a platform of the MFP; and

if the SOAP request is of the second type, then the second thread initiates communication with the platform.

20. The one or more non-transitory machine-readable media of claim 18, wherein:

if the SOAP request is of the first type, then the first thread forwards the SOAP request to another module of the MFP for further processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread forwards the SOAP request to the other module for further processing of the SOAP request.

21. A multi-functional peripheral (MFP) for processing different types of SOAP requests at the MFP, wherein the MFP comprises one or more processors and a plurality of service applications that each provides at least one service, the MFP being configured to:

receive, at a service application of the plurality, a SOAP request from a client application;

determine whether a time required to process the SOAP request and data associated with the SOAP request is long enough to cause the client application to timeout;

if the time required to process the SOAP request is not long enough to cause the client application to timeout, then process the SOAP request as a request of a first type;

if the time required to process the SOAP request is long enough to cause the client application to timeout, then process the SOAP request as a request of a second type;

if the SOAP request is of the first type, then, without narrowing a transmission control protocol (TCP) window of the connection between the service application and the client application, placing the SOAP request in a first queue for subsequent handling and process the SOAP request and said data;

if the SOAP request is of the second type, then;

determining whether a second queue that is different than the first queue is full;

if the second queue is full, then sending, to the client application, a response that indicates that the service application is presently unable to handle the SOAP request;

if the second queue is not full, then narrowing the TCP window and placing the SOAP request in the second queue for subsequent handling, and then, when the time required to process the SOAP request is no longer long enough to cause the client application to timeout, widening the TCP window and processing the SOAP request and said data.

22. The MFP of claim 21, wherein the time required to process the SOAP request is long enough due, at least in part, to unavailability of a resource that is required by the SOAP request;

the resource is unavailable to the SOAP request;

the resource is shared among a plurality of client applications; and

the MFP further comprising processing the SOAP request after the resource becomes available to the SOAP request.

23. The MFP of claim 21, wherein the MFP includes a print process for processing print data and causing a printed version of an electronic document reflected in the print data to be generated.

24. The MFP of claim 21, wherein:

a device facility manager (DFM) is associated with the MFP and handles device metadata requests from client applications that seek services provided by the MFP; and

the DFM implements one or more Web Services protocols.

25. The MFP of claim 21, being further configured to:

compose a response based on the SOAP request; and

return the response to the client application.

26. The MFP of claim 21, wherein:

the service application includes;

a first thread that is dedicated to handling requests of the first type; and

a second thread that is dedicated to handling requests of the second type; and

a third thread determines whether the SOAP request is a request of the first type or of the second type;

if the SOAP request is of the first type, then the third thread places the SOAP request in the first queue for subsequent handling by the first thread; and

if the SOAP request is of the second type, then the third thread places the SOAP request in the second queue for subsequent handling by the second thread.

27. The MFP of claim 26, wherein the third thread waits for SOAP requests from client applications and receives the SOAP request.

28. The MFP of claim 26, wherein:

if the SOAP request is of the first type, then the first thread initiates the processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread initiates the processing of the SOAP request.

29. The MFP of claim 28, wherein:

if the SOAP request is of the first type, then the first thread initiates communication with a platform of the MFP; and

if the SOAP request is of the second type, then the second thread initiates communication with the platform.

30. The MFP of claim 28, wherein:

if the SOAP request is of the first type, then the first thread forwards the SOAP request to another module of the MFP for further processing of the SOAP request; and

if the SOAP request is of the second type, then the second thread forwards the SOAP request to the other module for further processing of the SOAP request.