METHOD TO AUTO GENERATE JAX-RS REST SERVICE IMPLEMENTATION CLASSES FROM EXISTING INTERFACES

• US 20140372970A1
• Filed: 06/13/2013
• Published: 12/18/2014
• Est. Priority Date: 06/13/2013
• Status: Abandoned Application

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Broussard, Scott J., Pearson, Amartey S., Chakravarty, Swagat
• Application Number:
  US13/917,399
• Publication Number:
  US 20140372970A1
• Time in Patent Office: Days
• US Class Current: 717/106
• CPC Class Codes: G06F 8/30 Creation or generation of source code
• CPC Class Codes: G06F 9/541 via adapters, e.g. between incompatible applications

Abstract

A method, computer program product, and system for auto generating a Java application programming interface (JAX-RS) for representational state transfer (REST) web services. A reference interface for a REST service object is received by a server computer system. A set of determiners defines a plurality of configuration values for a REST service object to generate a service binding. A plurality of resource methods for each resource class in the reference interface is determined, and for each resource method, a parameter, a return type, and an exception are determined. Each resource method of each class is sequentially processed and the name of each resource is written into a string buffer. The operation type for each resource method for each resource class is determined based on at least one predefined match and an operation name is written into the string buffer for each resource method. A return type is determined for each resource method for each resource class. Each parameter in the resource method is converted to a JAX-RS compatible parameter.

Claims

1. A method for auto generating a Java interface (JAX-RS) for representational state transfer (REST) web services by a web server processing system, comprising:

receiving a reference interface for a REST service object;

receiving a set of determiners defining a plurality of configuration values for a REST service object to generate a service binding;

determining a plurality of resource methods for each resource class in the reference interface, and for each resource method, determining a parameter, a return type, and an exception;

sequentially processing each resource method of each class and writing the name of each resource into a string buffer;

determining the operation type for each resource method for each resource class based on at least one predefined match and writing an operation name into the string buffer for each resource method;

determining a return type for each resource method for each resource class; and

converting each parameter in the resource method to a JAX-RS compatible parameter.

2. The method for auto generating a Java interface of claim 1 further comprising writing a class definition into the string buffer, writing a Java class into the string buffer, and writing the string buffer onto a storage device.

3. The method for auto generating a Java interface of claim 1 further comprising providing a default value for any parameter not provided with a configuration value.

4. The method for auto generating a Java interface of claim 1 further comprising processing each exception and writing a class definition for an exception mapper to a second string buffer.

5. The method for auto generating a Java interface of claim 1 further comprising using universally unique identifiers (UUIDs) as parameters and automatically generating UUID support to populate an identifier from a UUID store in a memory.

6. The method for auto generating a Java interface of claim 5 further comprising automatically generating an exception mapper to handle exceptions for an associated resource method.

7. The method for auto generating a Java interface of claim 1 further comprising preparing a plurality of target parameter values and class types to be passed to the reference interface.

8. The method for auto generating a Java interface of claim 7 further comprising providing a query parameter for each resource method parameter.

9. The method for auto generating a Java interface of claim 1 further comprising automatically passing query parameters directly to a legacy interface.

10. The method for auto generating a Java interface of claim 1 further comprising providing a custom class to extract an Extensible Markup Language (XML) object or a JavaScript Object Notation (JSON) object.

11. The method for auto generating a Java interface of claim 1 further comprising adding each exception class to a collection of exception classes.

12. The method for auto generating a Java interface of claim 1 further comprising returning an Extensible Markup Language (XML) representation or a JavaScript Object Notation (JSON) representation.

13. A computer program product for auto generating a Java interface (JAX-RS) for representational state transfer (REST) web services when executed on a computer processor, the computer program product comprising a tangible computer readable medium having embedded thereon:

program instructions that cause the processor to receive a reference interface for a REST service object;

program instructions that cause the processor to receive a set of determiners defining a plurality of configuration values for a REST service object to generate a service binding;

program instructions that cause the processor to determine a plurality of resource methods for each resource class in the reference interface, and for each resource method, determine a parameter, a return type, and an exception;

program instructions that cause the processor to sequentially process each resource method of each resource class and to write the name of each resource into a string buffer;

program instructions that cause the processor to determine the operation type for each resource method for each resource class based on at least one predefined match and to write an operation name into the string buffer for each resource method;

program instructions that cause the processor to determine a return type for each resource method for each class; and

program instructions that cause the processor to convert each parameter in the resource method to a JAX-RS compatible parameter.

14. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to write a class definition into the string buffer, to write a Java class into the string buffer, and to write the string buffer onto a storage device.

15. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to provide a default value for any parameter not provided with a configuration value.

16. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to process each exception and to write a class definition for an exception mapper to a second string buffer.

17. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to use universally unique identifiers (UUIDs) as parameters and to automatically generate QUID support to populate an identifier from a QUID store in a memory.

18. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to automatically generate an exception mapper to handle exceptions for an associated resource method.

19. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to prepare a plurality of target parameter values and class types to be passed to the reference interface.

20. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to provide a query parameter for each resource method parameter.

21. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to automatically pass query parameters directly to a legacy interface.

22. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to provide a custom class to extract an Extensible Markup Language (XML) object or a JavaScript Object Notation (JSON) object.

23. The computer program product for auto generating a Java interface of claim 13, the computer readable medium further comprising program instructions that cause the processor to return an Extensible Markup Language (XML) representation or a JavaScript Object Notation (JSON) representation.

24. A system for auto generating a Java interface (JAX-RS) for representational state transfer (REST) web services, comprising:

a web server for exposing a web service interface for implementation of JAX-RS for REST web services;

a processor for executing a plurality of modules, including;

a module for receiving a reference interface for a REST service object;

a module for receiving a set of determiners defining a plurality of configuration values for a REST service object to generate a service binding;

a module for determining a plurality of resource methods for each resource class in the reference interface, and for each resource method, determining a parameter, a return type, and an exception;

a module for sequentially processing each resource method of each class and writing the name of each resource into a string buffer;

a module for determining the operation type for each resource method for each resource class based on at least one predefined match and writing an operation name into the string buffer for each resource method;

a module for determining a return type for each resource method for each resource class; and

a module for converting each parameter in the resource method to a JAX-RS compatible parameter.

25. The system for auto generating a Java interface of claim 24 further comprising a storage device for storing a string buffer including a resource class definition and a Java class.