PortForwardManagerImpl (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.location.basic.AbstractLocation
  - - brooklyn.location.access.PortForwardManagerImpl

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, PortForwardManager, LocationInternal, HasHostGeoInfo, Location, java.io.Serializable

Direct Known Subclasses:

PortForwardManagerAuthority
```
public class PortForwardManagerImpl
extends AbstractLocation
implements PortForwardManager
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.location.access.PortForwardManager
  PortForwardManager.AssociationListener, PortForwardManager.AssociationMetadata
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary
- Fields inherited from class brooklyn.location.basic.AbstractLocation
  LOG, PARENT_LOCATION, TEMPORARY_LOCATION
- Fields inherited from interface brooklyn.location.access.PortForwardManager
  PORT_FORWARD_MANAGER_STARTING_PORT, SCOPE
- Fields inherited from interface brooklyn.location.basic.LocationInternal
  FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors
Constructor and Description

PortForwardManagerImpl()

Constructors
Constructor and Description
`PortForwardManagerImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`acquirePublicPort(java.lang.String publicIpId)` Reserves a unique public port on the given publicIpId.
`int`	`acquirePublicPort(java.lang.String publicIpId, Location l, int privatePort)` Deprecated.
`PortMapping`	`acquirePublicPortExplicit(java.lang.String publicIpId, int port)` Deprecated.
`void`	`addAssociationListener(PortForwardManager.AssociationListener listener, com.google.common.base.Predicate<? super PortForwardManager.AssociationMetadata> filter)` Registers a listener, which will be notified each time a new port mapping is associated.
`void`	`associate(java.lang.String publicIpId, com.google.common.net.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, com.google.common.net.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)`.
`void`	`associate(java.lang.String publicIpId, int publicPort, Location l, int privatePort)` Deprecated.
`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.
`boolean`	`forgetPublicIpHostname(java.lang.String publicIpId)` Deprecated.
`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.
`com.google.common.net.HostAndPort`	`getPublicHostAndPort(PortMapping m)` Returns the public host and port for use accessing the given mapping.
`java.lang.String`	`getPublicIpHostname(java.lang.String publicIpId)` Deprecated.
`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.
`boolean`	`isClient()` Returns true if this implementation is a client which is immutable/safe for serialization i.e.
`com.google.common.net.HostAndPort`	`lookup(Location l, int privatePort)` Returns the public ip hostname and public port for use contacting the given endpoint.
`com.google.common.net.HostAndPort`	`lookup(java.lang.String publicIpId, int privatePort)` Returns the public endpoint (host and port) for use contacting the given endpoint.
`void`	`recordPublicIpHostname(java.lang.String publicIpId, java.lang.String hostnameOrPublicIpAddress)` Deprecated.
`void`	`removeAssociationListener(PortForwardManager.AssociationListener listener)`
`java.lang.String`	`toVerboseString()`

Methods inherited from class brooklyn.location.basic.AbstractLocation
addChild, addExtension, config, configure, containsLocation, equals, getAllConfig, getAllConfigBag, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocalConfigBag, getParent, getRawLocalConfigBag, hasConfig, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, removeChild, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, toMetadataRecord, toString

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, rebind, setCatalogItemId, tags

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.location.Location
containsLocation, getAllConfig, getChildren, getConfig, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, setParent

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.location.basic.LocationInternal
getManagementContext

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- 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 AbstractBrooklynObject
  - 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 BrooklynObjectInternal
    
    Specified by:
    
    getRebindSupport in interface Rebindable
    
    Specified by:
    
    getRebindSupport in interface LocationInternal
    
    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,
             com.google.common.net.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 PortForwardManager.acquirePublicPort(String, Location, int) was used, but strongly recommended if PortForwardManager.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,
             com.google.common.net.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 com.google.common.net.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:
    PortForwardManager.recordPublicIpHostname(String, String)
  - lookup
```
public com.google.common.net.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 PortForwardManager
    
    Specified by:
    
    toVerboseString in interface Location
    
    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
  - isClient
```
public boolean isClient()
```
    Description copied from interface: PortForwardManager
    
    Returns true if this implementation is a client which is immutable/safe for serialization i.e. it delegates to something on an entity or location elsewhere.
    
    Specified by:
    
    isClient in interface PortForwardManager
  - addAssociationListener
```
public void addAssociationListener(PortForwardManager.AssociationListener listener,
                          com.google.common.base.Predicate<? super PortForwardManager.AssociationMetadata> 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()
```
  - acquirePublicPortExplicit
```
@Deprecated
public PortMapping acquirePublicPortExplicit(java.lang.String publicIpId,
                                               int port)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Returns old mapping if it existed, null if it is new.
    
    Specified by:
    
    acquirePublicPortExplicit in interface PortForwardManager
  - forgetPortMapping
```
@Deprecated
public boolean forgetPortMapping(PortMapping m)
```
    Deprecated.
    
    Specified by:
    
    forgetPortMapping in interface PortForwardManager
    
    See Also:
    #forgetPortMapping(String, int)} and {@link #forgetPortMappings(Location)}
  - recordPublicIpHostname
```
@Deprecated
public void recordPublicIpHostname(java.lang.String publicIpId,
                                     java.lang.String hostnameOrPublicIpAddress)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Records a public hostname or address to be associated with the given publicIpId for lookup purposes.
    Conceivably this may have to be access-location specific.
    
    Specified by:
    
    recordPublicIpHostname in interface PortForwardManager
  - getPublicIpHostname
```
@Deprecated
public java.lang.String getPublicIpHostname(java.lang.String publicIpId)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Returns a recorded public hostname or address.
    
    Specified by:
    
    getPublicIpHostname in interface PortForwardManager
  - forgetPublicIpHostname
```
@Deprecated
public boolean forgetPublicIpHostname(java.lang.String publicIpId)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Clears a previous call to PortForwardManager.recordPublicIpHostname(String, String).
    
    Specified by:
    
    forgetPublicIpHostname in interface PortForwardManager
  - acquirePublicPort
```
@Deprecated
public int acquirePublicPort(java.lang.String publicIpId,
                               Location l,
                               int privatePort)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Reserves a unique public port for the purpose of forwarding to the given target, associated with a given location for subsequent lookup purpose.
    If already allocated, returns the previously allocated.
    
    Specified by:
    
    acquirePublicPort in interface PortForwardManager
  - associate
```
@Deprecated
public void associate(java.lang.String publicIpId,
                        int publicPort,
                        Location l,
                        int privatePort)
```
    Deprecated.
    
    Description copied from interface: PortForwardManager
    
    Records a location and private port against a publicIp and public port, to support PortForwardManager.lookup(Location, int).
    Superfluous if PortForwardManager.acquirePublicPort(String, Location, int) was used, but strongly recommended if PortForwardManager.acquirePublicPortExplicit(String, int) was used e.g. if the location is not known ahead of time.
    
    Specified by:
    
    associate in interface PortForwardManager
  - getPublicHostAndPort
```
public com.google.common.net.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

Class PortForwardManagerImpl

Nested Class Summary

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

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Fields inherited from class brooklyn.location.basic.AbstractLocation

Fields inherited from interface brooklyn.location.access.PortForwardManager

Fields inherited from interface brooklyn.location.basic.LocationInternal

Constructor Summary

Method Summary

Methods inherited from class brooklyn.location.basic.AbstractLocation

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.location.Location

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.location.basic.LocationInternal

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Constructor Detail

PortForwardManagerImpl

Method Detail

init

getRebindSupport

acquirePublicPort

associate

associate

lookup

lookup

forgetPortMapping

forgetPortMappings

forgetPortMappings

toVerboseString

getScope

isClient

addAssociationListener

removeAssociationListener

getPortMappings

getPortCounters

acquirePublicPortExplicit

forgetPortMapping

recordPublicIpHostname

getPublicIpHostname

forgetPublicIpHostname

acquirePublicPort

associate

getPublicHostAndPort

getPortMappingWithPublicSide

getPortMappingWithPublicIpId

getLocationPublicIpIds

getPortMappingWithPrivateSide