org.fabric3.spi.host

Interface PortAllocator

public interface PortAllocator

Responsible for allocating ports for use by a binding transport or other extension. A runtime can be configured with a range of ports, which serves as a pool for transports to obtain an open port using allocate(String, String). If the runtime is not configured with a port range, services requiring sockets should use #{link #reserve} to reserve a port.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_ALLOCATED

Method Summary

Modifier and Type	Method and Description
Port	allocate(java.lang.String name, java.lang.String type) Allocates a port for the given transport.
int	getAllocatedPortNumber(java.lang.String name) Returns the port number associated with the name.
java.util.Set<java.lang.String>	getPortTypes() Returns a list of allocated port types.
boolean	isPoolEnabled() True if the allocator is configured to pool.
void	release(int port) Releases the given port and makes it available for re-allocation.
void	release(java.lang.String name) Releases a port for the given transport and makes it available for re-allocation.
void	releaseAll(java.lang.String type) Releases a port for the given transport and makes it available for re-allocation.
Port	reserve(java.lang.String name, java.lang.String type, int port) Requests a specific port number to be reserved.

Field Detail

NOT_ALLOCATED

static final int NOT_ALLOCATED

See Also:

Constant Field Values

Method Detail

isPoolEnabled

boolean isPoolEnabled()

True if the allocator is configured to pool.

Returns:

true if the allocator is configured to pool

allocate

Port allocate(java.lang.String name,
              java.lang.String type)
       throws org.fabric3.api.host.Fabric3Exception

Allocates a port for the given transport.

Parameters:

name - the port name. Used when a transport uses a port per endpoint

type - the transport type, e.g. HTTP, HTTPS, FTP, TCP

Returns:

the allocated port

Throws:

org.fabric3.api.host.Fabric3Exception - if there was an error allocating a port

reserve

Port reserve(java.lang.String name,
             java.lang.String type,
             int port)
      throws org.fabric3.api.host.Fabric3Exception

Requests a specific port number to be reserved. This may be outside the configured port range. If so, the allocator will check availability and track the port as being allocated if available.

Parameters:

name - the port name. Used when a transport uses a port per endpoint

type - the transport type, e.g. HTTP, HTTPS, FTP, TCP

port - the requested port number

Returns:

returns the port

Throws:

org.fabric3.api.host.Fabric3Exception - if there was an error reserving the port

getAllocatedPortNumber

int getAllocatedPortNumber(java.lang.String name)

Returns the port number associated with the name.

Parameters:

name - the port name

Returns:

the allocated port number or NOT_ALLOCATED if a port has not been allocated

getPortTypes

java.util.Set<java.lang.String> getPortTypes()

Returns a list of allocated port types.

Returns:

a list of allocated port types

release

void release(int port)

Releases the given port and makes it available for re-allocation.

Parameters:

port - the port

release

void release(java.lang.String name)

Releases a port for the given transport and makes it available for re-allocation.

Parameters:

name - the port name

releaseAll

void releaseAll(java.lang.String type)

Releases a port for the given transport and makes it available for re-allocation.

Parameters:

type - the transport type