Package org.apache.nifi.documentation

Interface ServiceAPI

All Known Implementing Classes:
StandardServiceAPI
public interface ServiceAPI
Describes a Controller Service API that is provided by some implementation. Please note that while this class lives within the nifi-api, it is provided primarily as a means for documentation components within the NiFi NAR Maven Plugin. Its home is the nifi-api, however, because the API is needed in order to extract the relevant information and the NAR Maven Plugin cannot have a direct dependency on nifi-api (doing so would cause a circular dependency). By having this homed within the nifi-api, the Maven plugin is able to discover the class dynamically and invoke the one or two methods necessary to create the documentation. This is a new capability in 1.9.0 in preparation for the Extension Registry and therefore, you should NOTE WELL: At this time, while this class is part of nifi-api, it is still evolving and may change in a non-backward-compatible manner or even be removed from one incremental release to the next. Use at your own risk!

  • Method Details

    • getClassName

      String getClassName()
      Returns:
      the fully qualified class name of the interface implemented by the Controller Service

    • getGroupId

      String getGroupId()
      Returns:
      the Group ID of the bundle that provides the interface

    • getArtifactId

      String getArtifactId()
      Returns:
      the Artifact ID of the bundle that provides the interface

    • getVersion

      String getVersion()
      Returns:
      the Version of the bundle that provides the interface