Package com.thoughtworks.go.plugin.api

Interface GoPlugin

All Known Implementing Classes:
AbstractGoPlugin
public interface GoPlugin
GoPlugin interface represents Go plugin. It is necessary to implement this interface for any plugin implementation to be recognized as a Go plugin

  • Method Details

    • initializeGoApplicationAccessor

      void initializeGoApplicationAccessor(GoApplicationAccessor goApplicationAccessor)
      Initializes an instance of GoApplicationAccessor. This method would be invoked before Go interacts with plugin to handle any GoPluginApiRequest. Instance of GoApplicationAccessor will allow plugin to communicate with Go.
      Parameters:
      goApplicationAccessor - An instance of GoApplicationAccessor

    • handle

      GoPluginApiResponse handle(GoPluginApiRequest requestMessage) throws UnhandledRequestTypeException
      Handles GoPluginApiRequest request submitted from Go to plugin implementation and returns result as GoPluginApiResponse
      Parameters:
      requestMessage - An instance of GoPluginApiRequest
      Returns:
      an instance of GoPluginApiResponse
      Throws:
      UnhandledRequestTypeException

    • pluginIdentifier

      GoPluginIdentifier pluginIdentifier()
      Provides an instance of GoPluginIdentifier, providing details about supported extension point and its versions
      Returns:
      an instance of GoPluginIdentifier