Generic code book compression for XML based application programming interfaces

• US 6,711,740 B1
• Filed: 01/17/2002
• Issued: 03/23/2004
• Est. Priority Date: 01/17/2002
• Status: Active Grant

• Current Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Original Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Inventors: Toebes, John A., Moon, Billy G.
• Primary Examiner(s): COURTENAY III, ST JOHN
• Application Number:
  US10/047,110
• Time in Patent Office: 796 Days
• Field of Search: 709/328, 709/329, 719/220-231
• US Class Current: 719/328
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]
• CPC Class Codes: H04L 67/04 specially adapted for terminals or networks with limited capabilities; specially adapted for terminal portability
• CPC Class Codes: H04L 67/561 Adding application-functional data or data for application control, e.g. adding metadata
• CPC Class Codes: H04L 67/564 Enhancement of application control based on intercepted application data
• CPC Class Codes: H04L 67/565 Conversion or adaptation of application format or content adding application control or application functional data H04L67/561
• CPC Class Codes: H04L 69/04 Protocols for data compression, e.g. ROHC

Abstract

A synthetic code book document type definition (DTD) is generated that identifies selected compression codes, based on specifying code-book extensible markup language (XML) tags having semantics defined according to a generic code book document type definition (DTD). The compression codes are used to compress API commands, defined by second XML tags having semantics defined by a generic API DTD, into synthesized data. The synthesized data and the code-book XML tags are supplied to a destination device configured for storing the generic code book DTD and the generic API DTD, enabling the destination device to synthesize a code book for recovery of the API commands from the synthesized data.

Claims

1. A method in a source device of supplying an application programming interface (API) command to a destination device via a communications channel, the method comprising:

specifying the API command using first tags having semantics defined based on a generic API document type definition (DTD);

compressing the first tags using selected compression codes to generate compressed data;

synthesizing a synthetic DTD, identifying the selected compression codes, by specifying second tags having semantics defined by a generic code book DTD; and

transmitting the compressed data and the second tags via the communications channel, enabling the destination device to synthesize the synthetic DTD based on the second tags and a stored copy of the generic code book DTD, for synthesis of the API command by decompressing the first tags and based on a stored copy of the generic API DTD.

2. The method of claim 1, wherein the first and second tags are extensible markup language (XML) tags, the synthesizing step including second specifying within the second tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag having a generated value specified as mandatory by the generic code book DTD and generated based on runtime execution of an executable resource in the source device.

3. The method of claim 2, wherein the specifying step includes generating a device specific DTD having device specific tags that define semantics for interpreting the first tags for execution of the API command by the destination device, the generating step including generating the device specific DTD based on the generic API DTD.

4. The method of claim 3, wherein the specifying step further includes:

generating the first tags according to the device specific DTD and based on runtime execution of an application resource in the source device; and

third specifying within the first tags a third attribute tag configured for modifying a second prescribed attribute value specified by the generic API DTD, and a fourth attribute tag having a second generated value specified as mandatory by the generic API DTD.

5. The method of claim 3, wherein the transmitting step includes transmitting the compressed data as a payload of a UDP packet.

6. The method of claim 3, wherein the transmitting step includes transmitting the device specific tags to the destination device for synthesis of the API command from the first tags.

7. The method of claim 6, wherein the transmitting step includes transmitting the second tags and the device specific tags in response to a DTD request from the destination device.

8. A method in a destination device of receiving an application programming interface (API) command from a source device via a communications channel, the method comprising:

storing a generic API document type definition (DTD) and a generic code book DTD;

receiving, from the source device, compressed data and first tags having semantics defined based on the generic code book DTD;

first synthesizing a synthetic DTD based on the first tags and the generic code book DTD;

second synthesizing second tags based on decompressing the compressed data according to the synthetic DTD, the second tags having semantics defined based on the generic API DTD; and

executing the API command based on interpreting the second tags based on the generic API DTD.

9. The method of claim 8, wherein the first and second tags are extensible markup language (XML) tags, the first synthesizing step including identifying within the first tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and second attribute tag configured for specifying a second value specified as mandatory by the generic code book DTD.

10. The method of claim 8, wherein the second synthesizing step includes recovering a device specific DTD having device specific tags that define semantics for interpreting the second tags for execution of the API command.

11. The method of claim 10, wherein the second synthesizing step further includes identifying within the second tags a third attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a fourth attribute tag that specifies a third value specified as mandatory by the generic code book DTD.

12. The method of claim 10, further comprising sending a DTD request for the first tags and the device specific tags.

13. The method of claim 8, further comprising sending a DTD request for the first tags.

14. A source device configured for supplying an application programming interface (API) command to a destination device via a communications channel, the source device comprising:

a device memory configured for storing a generic API document type definition (DTD) and a generic code book DTD;

a processor configured for;

(1) generating first tags for specifying the API command and having semantics defined based on the generic API DTD,

(2) generating compressed data by compressing the first tags using selected compression codes,

(3) synthesizing a synthetic DTD, identifying the selected compression codes, by specifying second tags having semantics defined by a generic code book DTD; and

a network interface configured for outputting the compressed data and the second tags via the communications channel, enabling the destination device to synthesize the synthetic DTD based on the second tags and a stored copy of the generic code book DTD, for synthesis of the API command by decompressing the first tags and based on a stored copy of the generic API DTD.

15. The source device of claim 14, wherein the processor is configured for generating the first and second tags as extensible markup language (XML) tags, the second tags including a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag having a generated value specified as mandatory by the generic code book DTD and generated based on runtime execution of an executable resource by the processor.

16. The source device of claim 15, wherein the processor is configured for generating a device specific DTD having device specific tags that define semantics for interpreting the first tags for execution of the API command by the destination device, the processor generating the device specific DTD based on the generic API DTD.

17. The source device of claim 16, wherein the processor is configured for generating the first tags according to the device specific DTD and based on runtime execution of an application resource.

18. The source device of claim 16, wherein the network interface is configured for outputting the compressed data as a payload of a UDP packet.

19. The source device of claim 16, wherein the processor is configured for sending the second tags to the destination device via the network interface in response to a DTD request from the destination device.

20. A destination device configured for receiving an application programming interface (API) command from a source device via a communications channel, the destination device comprising:

a device memory configured for storing a generic API document type definition (DTD) and a generic code book DTD;

a network interface configured for receiving from the source device compressed data and first tags having semantics defined based on the generic code book DTD; and

a processor configured for;

(1) first synthesizing a synthetic DTD based on the first tags and the generic code book DTD,

(2) second synthesizing second tags based on decompressing the compressed data according to the synthetic DTD, the second tags having semantics defined based on the generic API DTD, and

(3) executing the API command based on interpreting the second tags based on the generic API DTD.

21. The destination device of claim 20, wherein the first tags and second tags are extensible markup language (XML) tags, the processor configured for synthesizing the synthetic DTD based on identifying within the first tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and second attribute tag configured for specifying a second value specified as mandatory by the generic code book DTD.

22. The destination device of claim 21, wherein the processor is configured for recovering, from decompressing the compressed data, a device specific DTD having device specific tags that define semantics for interpreting the second tags for execution of the API command.

23. The destination device of claim 22, wherein the processor is configured for sending a DTD request for the first tags and the device specific tags.

24. The destination device of claim 20, wherein the processor is configured for sending a DTD request for the first tags.

25. A computer readable medium having stored thereon sequences of instructions for supplying an application programming interface (API) command by a source device to a destination device via a communications channel, the sequences of instructions including instructions for performing the steps of:

specifying the API command using first tags having semantics defined based on a generic API document type definition (DTD);

compressing the first tags using selected compression codes to generate compressed data;

synthesizing a synthetic DTD, identifying the selected compression codes, by specifying second tags having semantics defined by a generic code book DTD; and

transmitting the compressed data and the second tags via the communications channel, enabling the destination device to synthesize the synthetic DTD based on the second tags and a stored copy of the generic code book DTD, for synthesis of the API command by decompressing the first tags and based on a stored copy of the generic API DTD.

26. The medium of claim 25, wherein the first and second tags are extensible markup language (XML) tags, the synthesizing step including second specifying within the second tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag having a generated value specified as mandatory by the generic code book DTD and generated based on runtime execution of an executable resource in the source device.

27. The medium of claim 26, wherein the specifying step includes generating a device specific DTD having device specific tags that define semantics for interpreting the first tags for execution of the API command by the destination device, the generating step including generating the device specific DTD based on the generic API DTD.

28. The medium of claim 27, wherein the specifying step further includes:

generating the first tags according to the device specific DTD and based on runtime execution of an application resource in the source device; and

third specifying within the first tags a third attribute tag configured for modifying a second prescribed attribute value specified by the generic API DTD, and a fourth attribute tag having a second generated value specified as mandatory by the generic API DTD.

29. The medium of claim 27, wherein the transmitting step includes transmitting the compressed data as a payload of a UDP packet.

30. The medium of claim 27, wherein the transmitting step includes transmitting the device specific tags to the destination device for synthesis of the API command from the first tags.

31. The medium of claim 30, wherein the transmitting step includes transmitting the second tags and the device specific tags in response to a DTD request from the destination device.

32. A computer readable medium having stored thereon sequences of instructions for receiving by a destination device an application programming interface (API) command from a source device via a communications channel, the sequences of instructions including instructions for performing the steps of:

storing a generic API document type definition (DTD) and a generic code book DTD;

receiving, from the source device, compressed data and first tags having semantics defined based on the generic code book DTD;

first synthesizing a synthetic DTD based on the first tags and the generic code book DTD;

second synthesizing second tags based on decompressing the compressed data according to the synthetic DTD, the second tags having semantics defined based on the generic API DTD; and

executing the API command based on interpreting the second tags based on the generic API DTD.

33. The medium of claim 32, wherein the first and second tags are extensible markup language (XML) tags, the first synthesizing step including identifying within the first tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag configured for specifying a second value specified as mandatory by the generic code book DTD.

34. The medium of claim 32, wherein the second synthesizing step includes recovering a device specific DTD having device specific tags that define semantics for interpreting the second tags for execution of the API command.

35. The medium of claim 34, wherein the second synthesizing step further includes identifying within the second tags a third attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a fourth attribute tag that specifies a third value specified as mandatory by the generic code book DTD.

36. The medium of claim 34, further comprising instructions for performing the step of sending a DTD request for the first tags and the device specific tags.

37. The medium of claim 32, further comprising instructions for performing the step of sending a DTD request for the first tags.

38. A source device configured for supplying an application programming interface (API) command to a destination device via a communication channel, the source device comprising:

means for specifying the API command using first tags having semantics defined based on a generic API document type definition (DTD);

means for compressing the first tags using selected compression codes to generate compressed data;

means for synthesizing a synthetic DTD, identifying the selected compression codes, by specifying second tags having semantics defined by a generic code book DTD; and

means for transmitting the compressed data and the second tags via the communications channel, enabling the destination device to synthesize the synthetic DTD based on the second tags and a stored copy of the generic code book DTD, for synthesis of the API command by decompressing the first tags and based on a stored copy of the generic API DTD.

39. The device of claim 38, wherein the first and second tags are extensible markup language (XML) tags, the synthesizing means configured for specifying within the second tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag having a generated value specified as mandatory by the generic code book DTD and generated based on runtime execution of an executable resource in the source device.

40. The device of claim 39, wherein the specifying means is configured for generating a device specific DTD having device specific tags that define semantics for interpreting the first tags for execution of the API command by the destination device, the device specific DTD generated based on the generic API DTD.

41. The device of claim 40, wherein the specifying means is configured for:

generating the first tags according to the device specific DTD and based on runtime execution of an application resource in the source device; and

specifying within the first tags a third attribute tag configured for modifying a second prescribed attribute value specified by the generic API DTD, and a fourth attribute tag having a second generated value specified as mandatory by the generic API DTD.

42. The device of claim 40, wherein the transmitting means is configured for transmitting the compressed data as a payload of a UDP packet.

43. The device of claim 40, wherein the transmitting means is configured for transmitting the device specific tags to the destination device for synthesis of the API command from the first tags.

44. The device of claim 43, wherein the transmitting means is configured for transmitting the second tags and the device specific tags in response to a DTD request from the destination device.

45. A destination device configured for receiving an application programming interface (API) command from a source device via a communications channel, the destination device comprising:

means for storing a generic API document type definition (DTD) and a generic code book DTD;

means for receiving, from the source device, compressed data and first tags having semantics defined based on the generic code book DTD;

means for first synthesizing a synthetic DTD based on the first tags and the generic code book DTD;

means for second synthesizing second tags based on decompressing the compressed data according to the synthetic DTD, the second tags having semantics defined based on the generic API DTD; and

means for executing the API command based on interpreting the second tags based on the generic API DTD.

46. The device of claim 45, wherein the first and second tags are extensible markup language (XML) tags, the first synthesizing means configured for identifying within the first tags a first attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a second attribute tag configured for specifying a second value specified as mandatory by the generic code book DTD.

47. The device of claim 45, wherein the second synthesizing means is configured for recovering a device specific DTD having device specific tags that define semantics for interpreting the second tags for execution of the API command.

48. The device of claim 47, wherein the second synthesizing means is configured for identifying within the second tags a third attribute tag configured for modifying a prescribed attribute value specified by the generic code book DTD, and a fourth attribute tag that specifies a third value specified as mandatory by the generic code book DTD.

49. The device of claim 47, further comprising means for sending a DTD request for the first tags and the device specific tags.

50. The device of claim 45, further comprising means for sending a DTD request for the first tags.