io.jenkins.blueocean.rest.annotation

Annotation Type Capability

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Capability

Capability annotation should be used by plugins to declare it's capability For example:

 pacakge io.jenkins.example.test;
  @Capability("io.jenkins.example.test.ExampleTestReporter")
 public class MyTestReporterAction extends AbstractTestResultAction {
  ...
 }
 

 BlueOcean API would report this capability when queried using it's classes API as:

 GET /rest/classes/io.jenkins.example.test.MyTestReporter

 {
     "classes":["io.jenkins.example.test.MyTestReporter", "io.jenkins.example.test.ExampleTestReporter", "hudson.tasks.test.AbstractTestResultAction"]
 }

 

Author:

Vivek Pandey

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value Capability values must be a namespace qualified.

Element Detail

value

public abstract String[] value

Capability values must be a namespace qualified. Typically you would use the package name of the class where this annotation is declared as namespace qualifier.

Returns:

value of this annotation