PortForwardManagerClient (Apache Brooklyn)

java.lang.Object
- brooklyn.location.access.PortForwardManagerClient

All Implemented Interfaces:: PortForwardManager

public class PortForwardManagerClient
extends java.lang.Object
implements PortForwardManager

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)` Reserves a unique public port for the purpose of forwarding to the given target, associated with a given location for subsequent lookup purpose.
`PortMapping`	`acquirePublicPortExplicit(java.lang.String publicIpId, int port)` Returns old mapping if it existed, null if it is new.
`void`	`associate(java.lang.String publicIpId, int publicPort, Location l, int privatePort)` Records a location and private port against a publicIp and public port, to support `PortForwardManager.lookup(Location, int)`.
`boolean`	`forgetPortMapping(PortMapping m)`
`PortMapping`	`forgetPortMapping(java.lang.String publicIpId, int publicPort)` Clears the given port mapping, returning the mapping if there was one.
`boolean`	`forgetPublicIpHostname(java.lang.String publicIpId)` Clears a previous call to `PortForwardManager.recordPublicIpHostname(String, String)`.
`static PortForwardManager`	`fromAttributeOnEntity(Entity entity, AttributeSensor<PortForwardManager> attributeOnEntity)` creates an instance given an entity and `AttributeSensor` to retrieve the PortForwardManager
`static PortForwardManager`	`fromMethodOnEntity(Entity entity, java.lang.String getterMethodOnEntity)` creates an instance given an entity and an interface method it implements to retrieve the PortForwardManager
`static PortForwardManager`	`fromSupplier(com.google.common.base.Supplier<PortForwardManager> supplier)` creates an instance given a supplier; the supplier should be brooklyn-persistable, that is to say references should be in terms of entities/locations which can retrieve an authoritative source even under cloning
`java.util.Collection<PortMapping>`	`getLocationPublicIpIds(Location l)` Returns the subset of port mappings associated with a given location.
`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)` Returns a recorded public hostname or address.
`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.
`void`	`recordPublicIpHostname(java.lang.String publicIpId, java.lang.String hostnameOrPublicIpAddress)` Records a public hostname or address to be associated with the given publicIpId for lookup purposes.

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

- Method Detail
  - fromSupplier
```
public static PortForwardManager fromSupplier(com.google.common.base.Supplier<PortForwardManager> supplier)
```
    creates an instance given a supplier; the supplier should be brooklyn-persistable, that is to say references should be in terms of entities/locations which can retrieve an authoritative source even under cloning
  - fromMethodOnEntity
```
public static PortForwardManager fromMethodOnEntity(Entity entity,
                                    java.lang.String getterMethodOnEntity)
```
    creates an instance given an entity and an interface method it implements to retrieve the PortForwardManager
  - fromAttributeOnEntity
```
public static PortForwardManager fromAttributeOnEntity(Entity entity,
                                       AttributeSensor<PortForwardManager> attributeOnEntity)
```
    creates an instance given an entity and AttributeSensor to retrieve the PortForwardManager
  - 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, int, Location, int) to enable PortForwardManager.lookup(Location, int).
    
    Specified by:
    
    acquirePublicPort in interface PortForwardManager
  - acquirePublicPortExplicit
```
public PortMapping acquirePublicPortExplicit(java.lang.String publicIpId,
                                    int port)
```
    Description copied from interface: PortForwardManager
    
    Returns old mapping if it existed, null if it is new.
    
    Specified by:
    
    acquirePublicPortExplicit 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
  - forgetPortMapping
```
public PortMapping forgetPortMapping(java.lang.String publicIpId,
                            int publicPort)
```
    Description copied from interface: PortForwardManager
    
    Clears the given port mapping, returning the mapping if there was one.
    
    Specified by:
    
    forgetPortMapping in interface PortForwardManager
  - forgetPortMapping
```
public boolean forgetPortMapping(PortMapping m)
```
    Specified by:
    
    forgetPortMapping in interface PortForwardManager
    
    See Also:
    PortForwardManager.forgetPortMapping(String, int)
  - recordPublicIpHostname
```
public void recordPublicIpHostname(java.lang.String publicIpId,
                          java.lang.String hostnameOrPublicIpAddress)
```
    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
```
public java.lang.String getPublicIpHostname(java.lang.String publicIpId)
```
    Description copied from interface: PortForwardManager
    
    Returns a recorded public hostname or address.
    
    Specified by:
    
    getPublicIpHostname in interface PortForwardManager
  - forgetPublicIpHostname
```
public boolean forgetPublicIpHostname(java.lang.String publicIpId)
```
    Description copied from interface: PortForwardManager
    
    Clears a previous call to PortForwardManager.recordPublicIpHostname(String, String).
    
    Specified by:
    
    forgetPublicIpHostname 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
  - acquirePublicPort
```
public int acquirePublicPort(java.lang.String publicIpId,
                    Location l,
                    int privatePort)
```
    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
  - 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)
  - associate
```
public void associate(java.lang.String publicIpId,
             int publicPort,
             Location l,
             int privatePort)
```
    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
  - getLocationPublicIpIds
```
public java.util.Collection<PortMapping> getLocationPublicIpIds(Location l)
```
    Description copied from interface: PortForwardManager
    
    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
  - 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

Class PortForwardManagerClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fromSupplier

fromMethodOnEntity

fromAttributeOnEntity

acquirePublicPort

acquirePublicPortExplicit

getPortMappingWithPublicSide

getPortMappingWithPublicIpId

forgetPortMapping

forgetPortMapping

recordPublicIpHostname

getPublicIpHostname

forgetPublicIpHostname

getPublicHostAndPort

acquirePublicPort

lookup

associate

getLocationPublicIpIds

getPortMappingWithPrivateSide

isClient