Package org.opensearch.plugins

Class PluginHelper

  • public class PluginHelper
extends java.lang.Object
    A helper class for the plugin-cli tasks.

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.nio.file.Path verifyIfPluginExists​(java.nio.file.Path pluginPath, java.lang.String pluginName)
      Verify if a plugin exists with any folder name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PluginHelper

        public PluginHelper()

    • Method Detail

      • verifyIfPluginExists

        public static java.nio.file.Path verifyIfPluginExists​(java.nio.file.Path pluginPath,
                                                      java.lang.String pluginName)
                                               throws java.io.IOException
        Verify if a plugin exists with any folder name.
        Parameters:
        pluginPath - the path for the plugins directory.
        pluginName - the name of the concerned plugin.
        Returns:
        the path of the folder if the plugin exists.
        Throws:
        java.io.IOException - if any I/O exception occurs while performing a file operation