org.jenkinsci.plugins.remote_terminal_access.lease

Class LeaseContext

java.lang.Object

org.jenkinsci.plugins.remote_terminal_access.lease.LeaseContext

public class LeaseContext
extends Object

A lease of executors to a client (which may be outside Jenkins).

One instance is created per lease on the master to keep track of leases and what executors are assigned to them.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
String	id Unique identifier of the lease.
String	owner User name who created it.

Constructor Summary

Constructors

Constructor and Description
LeaseContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String alias, hudson.model.Label label, String displayName, long duration)
void	checkOwner()
void	end() Cancels all the in-progress tasks.
hudson.model.Executor	get(String alias) Gets the Executor that maps to the alias.
Set<String>	getAliases()
static LeaseContext	getById(String id)
void	remove(String alias) Removes a single alias.
void	waitForStart() Waits for all the active leases to get their executors assigned.

Methods inherited from class java.lang.Object

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

Field Detail

id

public final String id

Unique identifier of the lease.

owner

public final String owner

User name who created it. Used for access control.

Constructor Detail

LeaseContext

public LeaseContext()

Method Detail

getById

public static LeaseContext getById(String id)

checkOwner

public void checkOwner()
                throws hudson.AbortException

Throws:

hudson.AbortException

add

public void add(String alias,
       hudson.model.Label label,
       String displayName,
       long duration)

waitForStart

public void waitForStart()
                  throws ExecutionException,
                         InterruptedException

Waits for all the active leases to get their executors assigned.

Throws:

ExecutionException

InterruptedException

get

public hudson.model.Executor get(String alias)
                          throws InterruptedException,
                                 IOException

Gets the Executor that maps to the alias.

Throws:

InterruptedException

IOException

end

public void end()

Cancels all the in-progress tasks.

remove

public void remove(String alias)

Removes a single alias.

getAliases

public Set<String> getAliases()