org.apache.brooklyn.entity.software.base

Class InboundPortsUtils

java.lang.Object

org.apache.brooklyn.entity.software.base.InboundPortsUtils

public class InboundPortsUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InboundPortsUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<java.lang.Integer>	getRequiredOpenPorts(Entity entity, java.lang.Boolean portsAutoInfer, java.lang.String portRegex) Returns the required open inbound ports for an Entity.
static java.util.Collection<java.lang.Integer>	getRequiredOpenPorts(Entity entity, java.util.Set<ConfigKey<?>> extraConfigKeys, java.lang.Boolean portsAutoInfer, java.lang.String portRegex) Returns the required open inbound ports for an Entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

InboundPortsUtils

public InboundPortsUtils()

Method Detail

getRequiredOpenPorts

public static java.util.Collection<java.lang.Integer> getRequiredOpenPorts(Entity entity,
                                                                           java.lang.Boolean portsAutoInfer,
                                                                           java.lang.String portRegex)

Returns the required open inbound ports for an Entity. If portsAutoInfer is true then return the first value for each PortAttributeSensorAndConfigKey config key PortRange plus any ports defined with a config key matching the provided regex.

Parameters:

entity - the Entity

portsAutoInfer - if true then also return the first value for each PortAttributeSensorAndConfigKey config key PortRange plus any ports defined with a config keys matching the provided regex

portRegex - the regex to match config keys that define inbound ports

Returns:

a collection of port numbers

getRequiredOpenPorts

public static java.util.Collection<java.lang.Integer> getRequiredOpenPorts(Entity entity,
                                                                           java.util.Set<ConfigKey<?>> extraConfigKeys,
                                                                           java.lang.Boolean portsAutoInfer,
                                                                           java.lang.String portRegex)

Returns the required open inbound ports for an Entity. If portsAutoInfer is true then return the first value for each PortAttributeSensorAndConfigKey config key PortRange plus any ports defined with a config key matching the provided regex. This method also accepts an extra set of config keys in addition to those that are defined in the EntityType of the entity itself.

Parameters:

entity - the Entity

extraConfigKeys - extra set of config key to inspect for inbound ports

portsAutoInfer - if true then return the first value for each PortAttributeSensorAndConfigKey config key PortRange plus any ports defined with a config keys matching the provided regex

portRegex - the regex to match config keys that define inbound ports

Returns:

a collection of port numbers