Package com.thoughtworks.go.plugin.api
Interface GoPlugin
-
- All Known Implementing Classes:
AbstractGoPlugin
public interface GoPluginGoPlugin interface represents Go plugin. It is necessary to implement this interface for any plugin implementation to be recognized as a Go plugin
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GoPluginApiResponsehandle(GoPluginApiRequest requestMessage)Handles GoPluginApiRequest request submitted from Go to plugin implementation and returns result as GoPluginApiResponsevoidinitializeGoApplicationAccessor(GoApplicationAccessor goApplicationAccessor)Initializes an instance of GoApplicationAccessor.GoPluginIdentifierpluginIdentifier()Provides an instance of GoPluginIdentifier, providing details about supported extension point and its versions
-
-
-
Method Detail
-
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
-
-