org.apache.brooklyn.core.location.access

Class PortForwardManagerImpl

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.core.location.access.PortForwardManagerImpl

All Implemented Interfaces:

Location, Rebindable, BrooklynObject, Configurable, Identifiable, PortForwardManager, HasHostGeoInfo, LocationInternal, BrooklynObjectInternal

Direct Known Subclasses:

PortForwardManagerAuthority

public class PortForwardManagerImpl
extends AbstractLocation
implements PortForwardManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.location.AbstractLocation

AbstractLocation.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.location.access.PortForwardManager

PortForwardManager.AssociationListener, PortForwardManager.AssociationMetadata

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.location.AbstractLocation

PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface org.apache.brooklyn.core.location.access.PortForwardManager

PORT_FORWARD_MANAGER_STARTING_PORT, SCOPE

Fields inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors

Constructor and Description
PortForwardManagerImpl()

Method Summary

Modifier and Type	Method and Description
int	acquirePublicPort(java.lang.String publicIpId) Reserves a unique public port on the given publicIpId.
void	addAssociationListener(PortForwardManager.AssociationListener listener, <any> filter) Registers a listener, which will be notified each time a new port mapping is associated.
void	associate(java.lang.String publicIpId, HostAndPort publicEndpoint, int privatePort) Records a mapping for publicIpId:privatePort to a public endpoint, such that it can subsequently be looked up using PortForwardManager.lookup(String, int).
void	associate(java.lang.String publicIpId, HostAndPort publicEndpoint, Location l, int privatePort) Records a location and private port against a public endpoint (ip and port), to support PortForwardManager.lookup(Location, int).
boolean	forgetPortMapping(PortMapping m) Deprecated.
boolean	forgetPortMapping(java.lang.String publicIpId, int publicPort) Clears the given port mapping, returning true if there was a match.
boolean	forgetPortMappings(Location l) Clears the port mappings associated with the given location, returning true if there were any matches.
boolean	forgetPortMappings(java.lang.String publicIpId) Clears the port mappings associated with the given publicIpId, returning true if there were any matches.
java.util.Collection<PortMapping>	getLocationPublicIpIds(Location l) returns the subset of port mappings associated with a given location
java.util.Map<java.lang.String,java.lang.Integer>	getPortCounters()
java.util.List<PortMapping>	getPortMappings()
PortMapping	getPortMappingWithPrivateSide(Location l, int privatePort) Returns the mapping to a given private port, or null if none.
java.util.Collection<PortMapping>	getPortMappingWithPublicIpId(java.lang.String publicIpId) Returns the subset of port mappings associated with a given public IP ID.
PortMapping	getPortMappingWithPublicSide(java.lang.String publicIpId, int publicPort) Returns the port mapping for a given publicIpId and public port.
HostAndPort	getPublicHostAndPort(PortMapping m) Returns the public host and port for use accessing the given mapping.
RebindSupport<LocationMemento>	getRebindSupport() Users are strongly discouraged from calling or overriding this method.
java.lang.String	getScope()
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
HostAndPort	lookup(Location l, int privatePort) Returns the public ip hostname and public port for use contacting the given endpoint.
HostAndPort	lookup(java.lang.String publicIpId, int privatePort) Returns the public endpoint (host and port) for use contacting the given endpoint.
void	removeAssociationListener(PortForwardManager.AssociationListener listener)
java.lang.String	toVerboseString()

Methods inherited from class org.apache.brooklyn.core.location.AbstractLocation

addChild, addExtension, config, configure, containsLocation, equals, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocationTypeInternal, getParent, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, rebind, relations, removeChild, setDisplayName, setHostGeoInfo, setManagementContext, setParent, setParent, subscriptions, toMetadataRecord, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, getManagementContext, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.location.Location

containsLocation, getChildren, getConfig, getDisplayName, getExtension, getId, getParent, hasExtension, relations, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

getManagementContext

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

PortForwardManagerImpl

public PortForwardManagerImpl()

Method Detail

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractLocation

getRebindSupport

public RebindSupport<LocationMemento> getRebindSupport()

Description copied from interface: LocationInternal

Users are strongly discouraged from calling or overriding this method. It is for internal calls only, relating to persisting/rebinding entities. This method may change (or be removed) in a future release without notice.

Specified by:

getRebindSupport in interface Rebindable

Specified by:

getRebindSupport in interface LocationInternal

Specified by:

getRebindSupport in interface BrooklynObjectInternal

Overrides:

getRebindSupport in class AbstractLocation

acquirePublicPort

public int acquirePublicPort(java.lang.String publicIpId)

Description copied from interface: PortForwardManager

Reserves a unique public port on the given publicIpId.

Often followed by PortForwardManager.associate(String, HostAndPort, int) or PortForwardManager.associate(String, HostAndPort, Location, int) to enable PortForwardManager.lookup(String, int) or PortForwardManager.lookup(Location, int) respectively.

Specified by:

acquirePublicPort in interface PortForwardManager

associate

public void associate(java.lang.String publicIpId,
                      HostAndPort publicEndpoint,
                      Location l,
                      int privatePort)

Description copied from interface: PortForwardManager

Records a location and private port against a public endpoint (ip and port), to support PortForwardManager.lookup(Location, int).

Superfluous if #acquirePublicPort(String, Location, int) was used, but strongly recommended if #acquirePublicPortExplicit(String, int) was used e.g. if the location is not known ahead of time.

Specified by:

associate in interface PortForwardManager

associate

public void associate(java.lang.String publicIpId,
                      HostAndPort publicEndpoint,
                      int privatePort)

Description copied from interface: PortForwardManager

Records a mapping for publicIpId:privatePort to a public endpoint, such that it can subsequently be looked up using PortForwardManager.lookup(String, int).

Specified by:

associate in interface PortForwardManager

lookup

public HostAndPort lookup(Location l,
                          int privatePort)

Description copied from interface: PortForwardManager

Returns the public ip hostname and public port for use contacting the given endpoint.

Will return null if:

• No publicPort is associated with this location and private port.
• No publicIpId is associated with this location and private port.
• No publicIpHostname is recorded against the associated publicIpId.

Conceivably this may have to be access-location specific.

Specified by:

lookup in interface PortForwardManager

See Also:

#recordPublicIpHostname(String, String)

lookup

public HostAndPort lookup(java.lang.String publicIpId,
                          int privatePort)

Description copied from interface: PortForwardManager

Returns the public endpoint (host and port) for use contacting the given endpoint. Expects a previous call to PortForwardManager.associate(String, HostAndPort, int), to register the endpoint. Will return null if there has not been a public endpoint associated with this pairing.

Specified by:

lookup in interface PortForwardManager

forgetPortMapping

public boolean forgetPortMapping(java.lang.String publicIpId,
                                 int publicPort)

Description copied from interface: PortForwardManager

Clears the given port mapping, returning true if there was a match.

Specified by:

forgetPortMapping in interface PortForwardManager

forgetPortMappings

public boolean forgetPortMappings(Location l)

Description copied from interface: PortForwardManager

Clears the port mappings associated with the given location, returning true if there were any matches.

Specified by:

forgetPortMappings in interface PortForwardManager

forgetPortMappings

public boolean forgetPortMappings(java.lang.String publicIpId)

Description copied from interface: PortForwardManager

Clears the port mappings associated with the given publicIpId, returning true if there were any matches.

Specified by:

forgetPortMappings in interface PortForwardManager

toVerboseString

public java.lang.String toVerboseString()

Specified by:

toVerboseString in interface Location

Specified by:

toVerboseString in interface PortForwardManager

Overrides:

toVerboseString in class AbstractLocation

Returns:

meta-data about the location (usually a long line, or a small number of lines).

getScope

public java.lang.String getScope()

Specified by:

getScope in interface PortForwardManager

addAssociationListener

public void addAssociationListener(PortForwardManager.AssociationListener listener,
                                   <any> filter)

Description copied from interface: PortForwardManager

Registers a listener, which will be notified each time a new port mapping is associated. See PortForwardManager.associate(String, HostAndPort, int) and PortForwardManager.associate(String, HostAndPort, Location, int).

Specified by:

addAssociationListener in interface PortForwardManager

removeAssociationListener

public void removeAssociationListener(PortForwardManager.AssociationListener listener)

Specified by:

removeAssociationListener in interface PortForwardManager

getPortMappings

public java.util.List<PortMapping> getPortMappings()

getPortCounters

public java.util.Map<java.lang.String,java.lang.Integer> getPortCounters()

forgetPortMapping

@Deprecated
public boolean forgetPortMapping(PortMapping m)

Deprecated.

Specified by:

forgetPortMapping in interface PortForwardManager

See Also:

#forgetPortMapping(String, int)} and {@link #forgetPortMappings(Location)}

getPublicHostAndPort

public HostAndPort getPublicHostAndPort(PortMapping m)

Description copied from interface: PortForwardManager

Returns the public host and port for use accessing the given mapping.

Conceivably this may have to be access-location specific.

Specified by:

getPublicHostAndPort in interface PortForwardManager

getPortMappingWithPublicSide

public PortMapping getPortMappingWithPublicSide(java.lang.String publicIpId,
                                                int publicPort)

Description copied from interface: PortForwardManager

Returns the port mapping for a given publicIpId and public port.

Specified by:

getPortMappingWithPublicSide in interface PortForwardManager

getPortMappingWithPublicIpId

public java.util.Collection<PortMapping> getPortMappingWithPublicIpId(java.lang.String publicIpId)

Description copied from interface: PortForwardManager

Returns the subset of port mappings associated with a given public IP ID.

Specified by:

getPortMappingWithPublicIpId in interface PortForwardManager

getLocationPublicIpIds

public java.util.Collection<PortMapping> getLocationPublicIpIds(Location l)

returns the subset of port mappings associated with a given location

Specified by:

getLocationPublicIpIds in interface PortForwardManager

getPortMappingWithPrivateSide

public PortMapping getPortMappingWithPrivateSide(Location l,
                                                 int privatePort)

Description copied from interface: PortForwardManager

Returns the mapping to a given private port, or null if none.

Specified by:

getPortMappingWithPrivateSide in interface PortForwardManager