RestMethod.java

  1. /*
  2.  * The coLAB project
  3.  * Copyright (C) 2021-2023 AlbaSim, MEI, HEIG-VD, HES-SO
  4.  *
  5.  * Licensed under the MIT License
  6.  */
  7. package ch.colabproject.colab.generator.plugin.rest;

  9. import java.io.File;
  10. import java.io.InputStream;
  11. import java.lang.reflect.Type;
  12. import java.text.MessageFormat;
  13. import java.util.ArrayList;
  14. import java.util.List;
  15. import java.util.Optional;
  16. import org.glassfish.jersey.media.multipart.FormDataBodyPart;
  17. import org.glassfish.jersey.media.multipart.FormDataContentDisposition;

  19. /**
  20.  * Represent a rest method
  21.  *
  22.  * @author maxence
  23.  */
  24. public class RestMethod {

  26.     /**
  27.      * HTTP method. One of GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS.
  28.      */
  29.     private String httpMethod;

  31.     /**
  32.      * Method name
  33.      */
  34.     private String name;

  36.     /**
  37.      * full path. class path + method path
  38.      */
  39.     private String fullPath;

  41.     /**
  42.      * List of path parameters
  43.      */
  44.     private List<Param> pathParameters = new ArrayList<>();

  46.     /**
  47.      * List of querystring parameters
  48.      */
  49.     private List<Param> queryParameters = new ArrayList<>();

  51.     /**
  52.      * List of form parameters
  53.      */
  54.     private List<Param> formParameters = new ArrayList<>();

  56.     /**
  57.      * body param
  58.      */
  59.     private Param bodyParam;

  61.     /**
  62.      * return type
  63.      */
  64.     private Type returnType;

  66.     /**
  67.      * Is return type generic ?
  68.      */
  69.     private boolean returnTypeGeneric;

  71.     /**
  72.      * is this class only for admin ?
  73.      */
  74.     private boolean adminResource;

  76.     /**
  77.      * Is the method deprecated?
  78.      */
  79.     private boolean deprecated;

  81.     /**
  82.      * does this class restricted to authenticated users ?
  83.      */
  84.     private boolean authenticationRequired;

  86.     /**
  87.      * MIME Type the method produces.
  88.      */
  89.     private List<String> produces;

  91.     /**
  92.      * Effective MIME Type the method consumes.
  93.      */
  94.     private List<String> consumes;

  96.     /**
  97.      * Get the value of authenticationRequired
  98.      *
  99.      * @return the value of authenticationRequired
  100.      */
  101.     public boolean isAuthenticationRequired() {
  102.         return authenticationRequired;
  103.     }

  105.     /**
  106.      * Set the value of authenticationRequired
  107.      *
  108.      * @param authenticationRequired new value of authenticationRequired
  109.      */
  110.     public void setAuthenticationRequired(boolean authenticationRequired) {
  111.         this.authenticationRequired = authenticationRequired;
  112.     }

  114.     /**
  115.      * Get the value of adminResource
  116.      *
  117.      * @return the value of adminResource
  118.      */
  119.     public boolean isAdminResource() {
  120.         return adminResource;
  121.     }

  123.     /**
  124.      * Set the value of adminResource
  125.      *
  126.      * @param adminResource new value of adminResource
  127.      */
  128.     public void setAdminResource(boolean adminResource) {
  129.         this.adminResource = adminResource;
  130.     }

  132.     /**
  133.      * Get the value of deprecated
  134.      *
  135.      * @return the value of deprecated
  136.      */
  137.     public boolean isDeprecated() {
  138.         return deprecated;
  139.     }

  141.     /**
  142.      * Set the value of deprecated
  143.      *
  144.      * @param deprecated new value of deprecated
  145.      */
  146.     public void setDeprecated(boolean deprecated) {
  147.         this.deprecated = deprecated;
  148.     }

  150.     /**
  151.      * Get the value of returnTypeGeneric
  152.      *
  153.      * @return the value of returnTypeGeneric
  154.      */
  155.     public boolean isReturnTypeGeneric() {
  156.         return returnTypeGeneric;
  157.     }

  159.     /**
  160.      * Set the value of returnTypeGeneric
  161.      *
  162.      * @param returnTypeGeneric new value of returnTypeGeneric
  163.      */
  164.     public void setReturnTypeGeneric(boolean returnTypeGeneric) {
  165.         this.returnTypeGeneric = returnTypeGeneric;
  166.     }

  168.     /**
  169.      * Get the value of returnType
  170.      *
  171.      * @return the value of returnType
  172.      */
  173.     public Type getReturnType() {
  174.         return returnType;
  175.     }

  177.     /**
  178.      * Set the value of returnType
  179.      *
  180.      * @param returnType new value of returnType
  181.      */
  182.     public void setReturnType(Type returnType) {
  183.         this.returnType = returnType;
  184.     }

  186.     /**
  187.      * Get the value of bodyParam
  188.      *
  189.      * @return the value of bodyParam
  190.      */
  191.     public Param getBodyParam() {
  192.         return bodyParam;
  193.     }

  195.     /**
  196.      * Set the value of bodyParam
  197.      *
  198.      * @param bodyParam new value of bodyParam
  199.      */
  200.     public void setBodyParam(Param bodyParam) {
  201.         this.bodyParam = bodyParam;
  202.     }

  204.     /**
  205.      * Get the value of queryParameters
  206.      *
  207.      * @return the value of queryParameters
  208.      */
  209.     public List<Param> getQueryParameters() {
  210.         return queryParameters;
  211.     }

  213.     /**
  214.      * Set the value of queryParameters
  215.      *
  216.      * @param queryParameters new value of queryParameters
  217.      */
  218.     public void setQueryParameters(List<Param> queryParameters) {
  219.         this.queryParameters = queryParameters;
  220.     }

  222.     /**
  223.      * Get the value of formParameters
  224.      *
  225.      * @return the value of formParameters
  226.      */
  227.     public List<Param> getFormParameters() {
  228.         return formParameters;
  229.     }

  231.     /**
  232.      * Set the value of formParameters
  233.      *
  234.      * @param formParameters new value of formParameters
  235.      */
  236.     public void setFormParameters(List<Param> formParameters) {
  237.         this.formParameters = formParameters;
  238.     }

  240.     /**
  241.      * Get the value of pathParameters
  242.      *
  243.      * @return the value of pathParameters
  244.      */
  245.     public List<Param> getPathParameters() {
  246.         return pathParameters;
  247.     }

  249.     /**
  250.      * Set the value of pathParameters
  251.      *
  252.      * @param pathParameters new value of pathParameters
  253.      */
  254.     public void setPathParameters(List<Param> pathParameters) {
  255.         this.pathParameters = pathParameters;
  256.     }

  258.     /**
  259.      * Get the value of name
  260.      *
  261.      * @return the value of name
  262.      */
  263.     public String getName() {
  264.         return name;
  265.     }

  267.     /**
  268.      * Set the value of name
  269.      *
  270.      * @param name new value of name
  271.      */
  272.     public void setName(String name) {
  273.         this.name = name;
  274.     }

  276.     /**
  277.      * Get the value of fullPath
  278.      *
  279.      * @return the value of fullPath
  280.      */
  281.     public String getFullPath() {
  282.         return fullPath;
  283.     }

  285.     /**
  286.      * Set the value of fullPath
  287.      *
  288.      * @param fullPath new value of fullPath
  289.      */
  290.     public void setFullPath(String fullPath) {
  291.         this.fullPath = fullPath;
  292.     }

  294.     /**
  295.      * Get the value of httpMethod
  296.      *
  297.      * @return the value of httpMethod
  298.      */
  299.     public String getHttpMethod() {
  300.         return httpMethod;
  301.     }

  303.     /**
  304.      * Set the value of httpMethod
  305.      *
  306.      * @param httpMethod new value of httpMethod
  307.      */
  308.     public void setHttpMethod(String httpMethod) {
  309.         this.httpMethod = httpMethod;
  310.     }

  312.     /**
  313.      * Get the value of produces
  314.      *
  315.      * @return the value of produces
  316.      */
  317.     public List<String> getProduces() {
  318.         return produces;
  319.     }

  321.     /**
  322.      * Set the value of produces
  323.      *
  324.      * @param produces new value of produces
  325.      */
  326.     public void setProduces(List<String> produces) {
  327.         this.produces = produces;
  328.     }

  330.     /**
  331.      * Get the value of consumes
  332.      *
  333.      * @return the value of consumes
  334.      */
  335.     public List<String> getConsumes() {
  336.         return consumes;
  337.     }

  339.     /**
  340.      * Set the value of consumes
  341.      *
  342.      * @param consumes new value of consumes
  343.      */
  344.     public void setConsumes(List<String> consumes) {
  345.         this.consumes = consumes;
  346.     }

  348.     /**
  349.      * Register a path parameter
  350.      *
  351.      * @param name           name of the parameter
  352.      * @param annotationName PathParam name
  353.      * @param javadoc        some documentation
  354.      * @param type           type of the parameter
  355.      */
  356.     public void addPathParameter(String name, String annotationName, String javadoc, Type type) {
  357.         Param param = new Param();
  358.         param.setName(name);
  359.         param.setInAnnotationName(annotationName);
  360.         param.setJavadoc(javadoc);
  361.         param.setType(type);

  363.         this.pathParameters.add(param);
  364.     }

  366.     /**
  367.      * Register a query parameter
  368.      *
  369.      * @param name           name of the parameter
  370.      * @param annotationName QueryParam name
  371.      * @param javadoc        some documentation
  372.      * @param type           type of the parameter
  373.      */
  374.     public void addQueryParameter(String name, String annotationName, String javadoc, Type type) {
  375.         Param param = new Param();
  376.         param.setName(name);
  377.         param.setInAnnotationName(annotationName);
  378.         param.setJavadoc(javadoc);
  379.         param.setType(type);

  381.         this.queryParameters.add(param);
  382.     }

  384.     /**
  385.      * Register a query parameter
  386.      *
  387.      * @param name           name of the parameter
  388.      * @param annotationName FormData name
  389.      * @param javadoc        some documentation
  390.      * @param type           type of the parameter
  391.      */
  392.     public void addFormParameter(String name, String annotationName, String javadoc, Type type) {
  393.         Optional<Param> findFirst = this.formParameters.stream()
  394.             .filter(p -> p.getInAnnotationName().equals(annotationName)).findFirst();
  395.         if (findFirst.isEmpty()) {
  396. //            Param param = findFirst.get();
  397. //            // hack: Files are injected with two disctinct parameter: one InputStream for bytes, one
  398. //            // FormDataBodyPart for metadata
  399. //            if (param.getType() instanceof Class
  400. //                && type instanceof Class
  401. //                && ((InputStream.class.isAssignableFrom((Class) type)
  402. //                && ContentDisposition.class.isAssignableFrom((Class) param.getType()))
  403. //                || (InputStream.class.isAssignableFrom((Class) type)
  404. //                && ContentDisposition.class.isAssignableFrom((Class) param.getType())))) {
  405. //                // Both ContentDisposition and InputStream exists: only keep InputStream
  406. //                param.setType(File.class);
  407. //            } else {
  408. //                Logger.warn("Duplicate Form Data");
  409. //            }
  410. //
  411. //        } else {
  412.             Param param = new Param();
  413.             param.setName(name);
  414.             param.setInAnnotationName(annotationName);
  415.             param.setJavadoc(javadoc);
  416.             param.setType(type);

  418.             // hack: MultiPartFile
  419.             if (FormDataBodyPart.class.isAssignableFrom((Class) type)
  420.                 || FormDataContentDisposition.class.isAssignableFrom((Class) type)
  421.                 || InputStream.class.isAssignableFrom((Class) type)) {
  422.                 param.setType(File.class);
  423.             }

  425.             this.formParameters.add(param);
  426.         }
  427.     }

  429.     /**
  430.      * Get all parameters. PathParams + queryParams + fromParam + body
  431.      *
  432.      * @return list of all non-null parameters
  433.      */
  434.     public List<Param> getAllParameters() {
  435.         List<Param> list = new ArrayList<>();
  436.         list.addAll(this.pathParameters);
  437.         list.addAll(this.queryParameters);
  438.         list.addAll(this.formParameters);

  440.         if (bodyParam != null) {
  441.             list.add(bodyParam);
  442.         }
  443.         return list;
  444.     }

  446.     /**
  447.      * Get URL parameters. PathParams + queryParams
  448.      *
  449.      * @return list of all non-null parameters
  450.      */
  451.     public List<Param> getUrlParameters() {
  452.         List<Param> list = new ArrayList<>();
  453.         list.addAll(this.pathParameters);
  454.         list.addAll(this.queryParameters);

  456.         return list;
  457.     }

  459.     @Override
  460.     public String toString() {
  461.         return MessageFormat.format("{0} {1}", this.getHttpMethod(), this.getFullPath());
  462.     }
  463. }
Created with JaCoCo 0.8.8.202204050719