[SOLR-13787] An annotation based system to write v2 only APIs

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 8.3, 9.0
• Assignee: Noble Paul
• Reporter: Noble Paul
• Created: 24/Sep/19 06:09
• Updated: 12/May/22 00:26
• Resolved: 06/Oct/19 22:49

Description

example v2 API may look as follows

@V2EndPoint(method = POST, path = "/cluster/package", permission = PermissionNameProvider.Name.ALL)
public static class ApiTest {
  @Command(name = "add")
  public void add(SolrQueryRequest req, SolrQueryResponse rsp, AddVersion addVersion) {

  }

  @Command(name = "delete")
  public void del(SolrQueryRequest req, SolrQueryResponse rsp, List<String> names) {

  }



}

public static class AddVersion {
  @JsonProperty(value = "package", required = true)
  public String pkg;
  @JsonProperty(value = "version", required = true)
  public String version;
  @JsonProperty(value = "files", required = true)
  public List<String> files;
}

This expects you to already hava a POJO annotated with jackson annotations

 

The annotations are:

 

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface EndPoint {
/**The suoported http methods*/
  SolrRequest.METHOD[] method();

/**supported paths*/
  String[] path();

  PermissionNameProvider.Name permission();
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Command {
   /**if this is not a json command , leave it empty.
   * Keep in mind that you cannot have duplicates.
   * Only one method per name
   *
   */
  String name() default "";

}

Issue Links

• is depended upon by: SOLR-13662 Package manager CLI
• is depended upon by: SOLR-13661 A package management system for Solr
• links to: GitHub Pull Request #928