org.jenkinsci.plugins.remote_terminal_access

Class TerminalSessionAction

java.lang.Object

hudson.model.Environment

org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.ModelObject

public class TerminalSessionAction
extends hudson.model.Environment
implements hudson.model.Action

Action that attach to AbstractBuild to show the "interactive terminal" option in the UI. Also an Environment to make the build hang while the terminal is active.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.security.Permission	ACCESS
static hudson.security.PermissionGroup	PERMISSIONS

Constructor Summary

Constructors

Constructor and Description
TerminalSessionAction(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	associate(DiagnoseCommand cmd)
org.kohsuke.stapler.HttpResponse	doKill() Interrupts the all pending SSH commands and terminate them all.
org.kohsuke.stapler.HttpResponse	doRestartSession() Relaunches a terminal session, even if one is live.
org.kohsuke.stapler.HttpResponse	doStartSession() Starts a new terminal session if non exists.
void	doU(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Handles ajaxterm update.
String	getDisplayName()
static TerminalSessionAction	getFor(hudson.model.AbstractBuild<?,?> build)
String	getIconFileName()
String	getUrlName()
boolean	hasSession()
boolean	tearDown(hudson.model.AbstractBuild build, hudson.model.BuildListener listener)
void	unassociate(DiagnoseCommand cmd)

Methods inherited from class hudson.model.Environment

buildEnvVars, create

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSIONS

public static final hudson.security.PermissionGroup PERMISSIONS

ACCESS

public static final hudson.security.Permission ACCESS

Constructor Detail

TerminalSessionAction

public TerminalSessionAction(hudson.model.AbstractBuild build,
                     hudson.Launcher launcher,
                     hudson.model.BuildListener listener)

Method Detail

tearDown

public boolean tearDown(hudson.model.AbstractBuild build,
               hudson.model.BuildListener listener)
                 throws IOException,
                        InterruptedException

Overrides:

tearDown in class hudson.model.Environment

Throws:

IOException

InterruptedException

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

hasSession

public boolean hasSession()

doStartSession

public org.kohsuke.stapler.HttpResponse doStartSession()
                                                throws IOException,
                                                       InterruptedException

Starts a new terminal session if non exists.

Throws:

IOException

InterruptedException

doRestartSession

public org.kohsuke.stapler.HttpResponse doRestartSession()
                                                  throws IOException,
                                                         InterruptedException

Relaunches a terminal session, even if one is live.

Throws:

IOException

InterruptedException

doU

public void doU(org.kohsuke.stapler.StaplerRequest req,
       org.kohsuke.stapler.StaplerResponse rsp)
         throws IOException,
                InterruptedException

Handles ajaxterm update.

Throws:

IOException

InterruptedException

associate

public void associate(DiagnoseCommand cmd)

unassociate

public void unassociate(DiagnoseCommand cmd)

doKill

public org.kohsuke.stapler.HttpResponse doKill()

Interrupts the all pending SSH commands and terminate them all.

getFor

public static TerminalSessionAction getFor(hudson.model.AbstractBuild<?,?> build)