Interface ToolClient
-
- All Known Implementing Classes:
AbstractToolClient
,ETClient
,ETComRegisterClient
,TSClient
public interface ToolClient
Client interface defining tool start up and tear down controls.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
restart(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener)
Restarts a tool.boolean
start(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener)
Starts a tool.boolean
stop(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener)
Stops a tool.
-
-
-
Method Detail
-
start
boolean start(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
Starts a tool.- Parameters:
checkProcesses
- specifies whether to check open processes after tear downworkspace
- the workspacelauncher
- the launcherlistener
- the listener- Returns:
true
if successful,false
otherwise- Throws:
IOException
- signals that an I/O exception has occurredInterruptedException
- if the build gets interrupted
-
stop
boolean stop(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
Stops a tool.- Parameters:
checkProcesses
- specifies whether to check open processes after tear downworkspace
- the workspacelauncher
- the launcherlistener
- the listener- Returns:
true
if successful,false
otherwise- Throws:
IOException
- signals that an I/O exception has occurredInterruptedException
- if the build gets interrupted
-
restart
boolean restart(boolean checkProcesses, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException, InterruptedException
Restarts a tool.- Parameters:
checkProcesses
- specifies whether to check open processes after tear downworkspace
- the workspacelauncher
- the launcherlistener
- the listener- Returns:
true
if successful,false
otherwise- Throws:
IOException
- signals that an I/O exception has occurredInterruptedException
- if the build gets interrupted
-
-