Package org.jvnet.hudson.plugins.port_allocator

Class PooledPortType

java.lang.Object

org.jvnet.hudson.plugins.port_allocator.PortType

org.jvnet.hudson.plugins.port_allocator.PooledPortType

All Implemented Interfaces:

ExtensionPoint, Describable<PortType>, Serializable

public class PooledPortType
extends PortType

Port type for representing a pool of ports used concurrently by parallel jobs

Author:

pepov

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PooledPortType.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jvnet.hudson.plugins.port_allocator.PortType

name

Constructor Summary

Constructors

Constructor	Description
PooledPortType(String name)

Method Summary

Modifier and Type	Method	Description
Port	allocate(AbstractBuild<?,?> build, PortAllocationManager manager, int prefPort, Launcher launcher, BuildListener buildListener)	Try to allocate one free port from the given pool.
PooledPortType.DescriptorImpl	getDescriptor()

Methods inherited from class org.jvnet.hudson.plugins.port_allocator.PortType

getFixedPort, isFixedPort

Methods inherited from class java.lang.Object

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

Constructor Details

PooledPortType

@DataBoundConstructor
public PooledPortType(String name)

Method Details

allocate

public Port allocate(AbstractBuild<?,?> build,
 PortAllocationManager manager,
 int prefPort,
 Launcher launcher,
 BuildListener buildListener)
              throws IOException,
InterruptedException

Try to allocate one free port from the given pool. Wait for a short period if no free port is available, then try again.

Specified by:

allocate in class PortType

Parameters:

build - the build that will use the allocated port

manager - can be used to assign a new TCP port number

prefPort - port number allocated to this type the last time

launcher - launcher used to perform operations for the build

buildListener - listener that receives information about the build

Throws:

IOException

InterruptedException

getDescriptor

public PooledPortType.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<PortType>

Specified by:

getDescriptor in class PortType