Class PluginInfo

    • Field Detail

      • ES_PLUGIN_PROPERTIES

        public static final java.lang.String ES_PLUGIN_PROPERTIES
        See Also:
        Constant Field Values
      • ES_PLUGIN_POLICY

        public static final java.lang.String ES_PLUGIN_POLICY
        See Also:
        Constant Field Values
    • Constructor Detail

      • PluginInfo

        public PluginInfo​(java.lang.String name,
                          java.lang.String description,
                          java.lang.String version,
                          Version elasticsearchVersion,
                          java.lang.String javaVersion,
                          java.lang.String classname,
                          java.util.List<java.lang.String> extendedPlugins,
                          boolean hasNativeController)
        Construct plugin info.
        Parameters:
        name - the name of the plugin
        description - a description of the plugin
        version - an opaque version identifier for the plugin
        elasticsearchVersion - the version of Elasticsearch the plugin was built for
        javaVersion - the version of Java the plugin was built with
        classname - the entry point to the plugin
        extendedPlugins - other plugins this plugin extends through SPI
        hasNativeController - whether or not the plugin has a native controller
      • PluginInfo

        public PluginInfo​(StreamInput in)
                   throws java.io.IOException
        Construct plugin info from a stream.
        Parameters:
        in - the stream
        Throws:
        java.io.IOException - if an I/O exception occurred reading the plugin info from the stream
    • Method Detail

      • readFromProperties

        public static PluginInfo readFromProperties​(java.nio.file.Path path)
                                             throws java.io.IOException
        Reads the plugin descriptor file.
        Parameters:
        path - the path to the root directory for the plugin
        Returns:
        the plugin info
        Throws:
        java.io.IOException - if an I/O exception occurred reading the plugin descriptor
      • getName

        public java.lang.String getName()
        The name of the plugin.
        Returns:
        the plugin name
      • getDescription

        public java.lang.String getDescription()
        The description of the plugin.
        Returns:
        the plugin description
      • getClassname

        public java.lang.String getClassname()
        The entry point to the plugin.
        Returns:
        the entry point to the plugin
      • getExtendedPlugins

        public java.util.List<java.lang.String> getExtendedPlugins()
        Other plugins this plugin extends through SPI.
        Returns:
        the names of the plugins extended
      • getVersion

        public java.lang.String getVersion()
        The version of the plugin
        Returns:
        the version
      • getElasticsearchVersion

        public Version getElasticsearchVersion()
        The version of Elasticsearch the plugin was built for.
        Returns:
        an Elasticsearch version
      • getJavaVersion

        public java.lang.String getJavaVersion()
        The version of Java the plugin was built with.
        Returns:
        a java version string
      • hasNativeController

        public boolean hasNativeController()
        Whether or not the plugin has a native controller.
        Returns:
        true if the plugin has a native controller
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toString

        public java.lang.String toString​(java.lang.String prefix)