Index (Remote Terminal Access plugin 1.4 API)

A C D E F G H I K L M N O P R S T U W _

A

AbstractRemoteSshCommand - Class in org.jenkinsci.plugins.remote_terminal_access.ssh
AbstractRemoteSshCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand
AbstractTunnelCommand - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: SSH command that tunnels another SSH session for the purpose of adding contextual data around it.
AbstractTunnelCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand
ACCESS - Static variable in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
add(String, Label, String, long) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext
aliases - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseEndCommand
associate(DiagnoseCommand) - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
attachContext() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseAddCommand
attachContext() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand

C

checkAbortPermission() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
checkOwner() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext
clear() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile: Deletes the existing lease file.
CommandFactoryImpl - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Adds the lease related SSH commands
CommandFactoryImpl() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.CommandFactoryImpl
CommandFactoryImpl - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: Adds an SSH related command.
CommandFactoryImpl() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.CommandFactoryImpl
commands(List<String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher
configure(ProcessWithPtyLauncher) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseSshCommand
configure(AbstractBuild, TaskListener) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher: Configures the launcher to launch the process in the workspace of an in-progress build with the same set of environment variables.
configure(ProcessWithPtyLauncher) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand: Configures how/where the process is launched.
configure(ProcessWithPtyLauncher) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseCommand
create(SshCommandFactory.CommandLine) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.CommandFactoryImpl
create(SshCommandFactory.CommandLine) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.CommandFactoryImpl
create(Class<T>, T, Map<String, Object>) - Static method in class org.jenkinsci.plugins.remote_terminal_access.ssh.InterceptingProxy
createExecutable() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
createFor(Run) - Method in class org.jenkinsci.plugins.remote_terminal_access.TransientBuildActionFactoryImpl

D

destroy() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
destroy() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
DiagnoseCommand - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: SSH command that connects to the workspace of the job.
DiagnoseCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseCommand
DiagnoseTunnelCommand - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: Command implementation that tunnels another SSH session in its stdin/stdout.
DiagnoseTunnelCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseTunnelCommand
die(String) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand
doKill() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction: Interrupts the all pending SSH commands and terminate them all.
doRestartSession() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction: Relaunches a terminal session, even if one is live.
doStartSession() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction: Starts a new terminal session if non exists.
doU(StaplerRequest, StaplerResponse) - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction: Handles ajaxterm update.
duration - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand

E

end() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: Cancels all the in-progress tasks.
envs(Map<String, String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher: Overrides on top of what the build gets.
exitValue() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
exitValue() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty

F

FlushStreamCopyThread - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: StreamCopyThread variant that flushes the output stream.
FlushStreamCopyThread(String, InputStream, OutputStream, boolean) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.FlushStreamCopyThread
FlushStreamCopyThread(String, InputStream, OutputStream) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.FlushStreamCopyThread

G

get(String) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: Gets the Executor that maps to the alias.
get() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile: Gets the current lease context if one is available.
getAliases() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext
getAssignedLabel() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getById(String) - Static method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext
getCauseOfBlockage() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getCommandFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseTunnelCommand
getCommandFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand
getCommandFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseTunnelCommand
getDisplayName() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getDisplayName() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
getErrorPrintStream() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand: When the terminal is allocated, I discovered that the linux SSH client (at least) sends the terminal mode ONLCR to 1, and expects us to send back CR+LF instead of just NL.
getErrorStream() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
getErrorStream() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
getEstimatedDuration() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getFileSystemFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand: Override this method to add sftp support
getFor(AbstractBuild<?, ?>) - Static method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
getFullDisplayName() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getIconFileName() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
getInputStream() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
getInputStream() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
getLastBuiltOn() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getName() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getOutputStream() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
getOutputStream() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
getOwnerTask() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getResourceList() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getSameNodeConstraint() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getShellFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseTunnelCommand
getShellFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand
getShellFactory() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseTunnelCommand
getShortDescription() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseAddCommand
getShortDescription() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseEndCommand
getShortDescription() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand
getSubTasks() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getUrl() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
getUrlName() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
getWhyBlocked() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask

H

hasAbortPermission() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
hasSession() - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction

I

id - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: Unique identifier of the lease.
InterceptingProxy - Class in org.jenkinsci.plugins.remote_terminal_access.ssh: Created a proxied interface whose methods are selectively overridden.
InterceptingProxy() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ssh.InterceptingProxy
IProcess - Interface in org.jenkinsci.plugins.remote_terminal_access: Remoting interface for ProcessWithPty
isAlive() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseCommand
isBuildBlocked() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
isConcurrentBuild() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask

K

kill(int) - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
kill(int) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty

L

launch(String) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher
LEASE_FILE - Static variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile
LeaseAddCommand - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Adds additional slaves to the current lease.
LeaseAddCommand() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseAddCommand
LeaseBuildAction - Class in org.jenkinsci.plugins.remote_terminal_access.lease: keeps tracks of leases made during a build.
LeaseBuildAction() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseBuildAction
LeaseBuildAction.RunListenerImpl - Class in org.jenkinsci.plugins.remote_terminal_access.lease: When the build ends, release all the leases.
LeaseBuildAction.RunListenerImpl() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseBuildAction.RunListenerImpl
LeaseContext - Class in org.jenkinsci.plugins.remote_terminal_access.lease: A lease of executors to a client (which may be outside Jenkins).
LeaseContext() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext
LeaseContextMap - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Singleton that remembers active lease contexts.
LeaseContextMap() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContextMap
LeasedTask - Class in org.jenkinsci.plugins.remote_terminal_access.lease: TODO: share with distfork
LeasedTask(Label, String, long, Runnable) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeasedTask
LeaseEndCommand - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Finishes the lease in progress.
LeaseEndCommand() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseEndCommand
LeaseFile - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Remembers the in-scope session in the current directory.
LeaseFile(Channel) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile
leases - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand
LeaseSshCommand - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Executes the specified command in the node where the given lease is running.
LeaseSshCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseSshCommand
LeaseStartCommand - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Lease executors.
LeaseStartCommand() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand
LeaseTunnelCommand - Class in org.jenkinsci.plugins.remote_terminal_access.lease: Tunnels another SSH session that connects to the "lease-ssh" command.
LeaseTunnelCommand(SshCommandFactory.CommandLine) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseTunnelCommand

M

main(List<String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseSshCommand
main(List<String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand
main(List<String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseCommand
Messages - Class in org.jenkinsci.plugins.remote_terminal_access
Messages() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.Messages

N

name - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand

O

onCompleted(Run, TaskListener) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseBuildAction.RunListenerImpl
optCurrentlyBuilding() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand: If the command is currently running inside a build, return it.
org.jenkinsci.plugins.remote_terminal_access - package org.jenkinsci.plugins.remote_terminal_access
org.jenkinsci.plugins.remote_terminal_access.lease - package org.jenkinsci.plugins.remote_terminal_access.lease
org.jenkinsci.plugins.remote_terminal_access.ssh - package org.jenkinsci.plugins.remote_terminal_access.ssh
owner - Variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: User name who created it.

P

PERMISSIONS - Static variable in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
proc - Variable in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand
ProcessWithFakePty - Class in org.jenkinsci.plugins.remote_terminal_access
ProcessWithPtyLauncher - Class in org.jenkinsci.plugins.remote_terminal_access: Launches a ProcessWithPty on a machine & directory that's running a AbstractBuild.
ProcessWithPtyLauncher() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher

R

RemotableProcess - Class in org.jenkinsci.plugins.remote_terminal_access: IProcess implementation that acts accordingly when remoted via Channel
RemotableProcess(ProcessWithPty) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.RemotableProcess
remove(String) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: Removes a single alias.
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseEndCommand
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseStartCommand
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseTunnelCommand
run(List<String>) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand: Runs the specified commands and pumps the stdin/stdout/stderr between AbstractRemoteSshCommand.proc and the SSH client.
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand: Turn the connection over into another nested SSH session.
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.DiagnoseTunnelCommand
run() - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.FlushStreamCopyThread
RunListenerImpl - Class in org.jenkinsci.plugins.remote_terminal_access
RunListenerImpl() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.RunListenerImpl

S

set(LeaseContext) - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile: Generates ".jenkins.lease" file and the equivalent ssh_config file.
setUpEnvironment(AbstractBuild, Launcher, BuildListener) - Method in class org.jenkinsci.plugins.remote_terminal_access.RunListenerImpl
setWindowSize(int, int) - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
setWindowSize(int, int) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
shell() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher
SSHCONFIG_FILE - Static variable in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseFile
start(Environment) - Method in class org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand: Pass along the signal from the client to the child process.

T

tearDown(AbstractBuild, BuildListener) - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
TerminalSessionAction - Class in org.jenkinsci.plugins.remote_terminal_access: Action that attach to AbstractBuild to show the "interactive terminal" option in the UI.
TerminalSessionAction(AbstractBuild, Launcher, BuildListener) - Constructor for class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction
TerminalSessionAction_AccessPermission_Description() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Start/access the interactive terminal.
TerminalSessionAction_DisplayName() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Interactive Terminal
TerminalSessionAction_KillNow() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: kill now
TerminalSessionAction_LinkedText() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: the interactive terminal
TerminalSessionAction_Permissions_Title() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Interactive Terminal
TerminalSessionAction_WaitingForSsh(Object, Object) - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Waiting for {0} SSH interactive terminal session(s) to exit ({1})
TerminalSessionAction_WaitingForTerminal(Object) - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Waiting for {0} to exit
TransientBuildActionFactoryImpl - Class in org.jenkinsci.plugins.remote_terminal_access
TransientBuildActionFactoryImpl() - Constructor for class org.jenkinsci.plugins.remote_terminal_access.TransientBuildActionFactoryImpl

U

unassociate(DiagnoseCommand) - Method in class org.jenkinsci.plugins.remote_terminal_access.TerminalSessionAction

W

waitFor() - Method in interface org.jenkinsci.plugins.remote_terminal_access.IProcess
waitFor() - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithFakePty
waitForStart() - Method in class org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext: Waits for all the active leases to get their executors assigned.
ws(FilePath) - Method in class org.jenkinsci.plugins.remote_terminal_access.ProcessWithPtyLauncher

_

_TerminalSessionAction_AccessPermission_Description() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Start/access the interactive terminal.
_TerminalSessionAction_DisplayName() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Interactive Terminal
_TerminalSessionAction_KillNow() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: kill now
_TerminalSessionAction_LinkedText() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: the interactive terminal
_TerminalSessionAction_Permissions_Title() - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Interactive Terminal
_TerminalSessionAction_WaitingForSsh(Object, Object) - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Waiting for {0} SSH interactive terminal session(s) to exit ({1})
_TerminalSessionAction_WaitingForTerminal(Object) - Static method in class org.jenkinsci.plugins.remote_terminal_access.Messages: Waiting for {0} to exit

A C D E F G H I K L M N O P R S T U W _