org.pentaho.platform.settings

Class ServerPort

java.lang.Object

org.pentaho.platform.settings.ServerPort

Direct Known Subclasses:

KarafInstancePort

public class ServerPort
extends Object

This immutable class contains information on variable port that is assigned by this class. This class will use the PortAssigner to assign a port from the defined range, when the assignPort() is called. The port will be considered reserved for the duration of JVM, unless the releasePort() is called.

Author:

tkafalas

Constructor Summary

Constructors

Constructor and Description
ServerPort(String id, String friendlyName, Integer startPort, Integer endPort)
ServerPort(String id, String friendlyName, Integer startPort, Integer endPort, String serviceName)

Method Summary

Methods

Modifier and Type	Method and Description
Integer	assignPort() Assigns a port number from the range defined.
Integer	getEndPort()
String	getFriendlyName()
String	getId()
String	getServiceName()
Integer	getStartPort()
Integer	getValue()
void	releasePort() Free's up the port resource for re-use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPort

public ServerPort(String id,
          String friendlyName,
          Integer startPort,
          Integer endPort)

Parameters:

id - A unique Id associated with this port

friendlyName - A friendly descriptive name associated with this port

startPort - The first port number in a range of available ports. If null an unused port ill be assigned.

endPort - The last port number in a range of available ports. If null and the startPort then there is no upper boundary.

ServerPort

public ServerPort(String id,
          String friendlyName,
          Integer startPort,
          Integer endPort,
          String serviceName)

Parameters:

id - A unique Id associated with this port

friendlyName - A friendly descriptive name associated with this port

startPort - The first port number in a range of available ports. If null an unused port ill be assigned.

endPort - The last port number in a range of available ports. If null and the startPort then there is no upper boundary.

serviceName - The serviceName associated with this port

Method Detail

getId

public String getId()

getValue

public Integer getValue()

getFriendlyName

public String getFriendlyName()

getStartPort

public Integer getStartPort()

getEndPort

public Integer getEndPort()

getServiceName

public String getServiceName()

assignPort

public Integer assignPort()
                   throws IllegalStateException

Assigns a port number from the range defined. If no port number is available from the defined range an arbitrary free port will be assigned. It is illegal to assign a port number if the ServerPort has not been registered with the ServerPortRegistry.

Returns:

The port number allocated.

Throws:

IllegalStateException - If the port cannot be obtained or the object has not been registered with the ServerPortRegistry.

releasePort

public void releasePort()

Free's up the port resource for re-use. Call this method when the port can be reused.