Method Detail

• fromSupplier

  public static PortForwardManager fromSupplier(com.google.common.base.Supplier<PortForwardManager> supplier)

  Deprecated. 
  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)

  Deprecated. 
  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)

  Deprecated. 
  creates an instance given an entity and AttributeSensor to retrieve the PortForwardManager

• acquirePublicPort

  public int acquirePublicPort(java.lang.String publicIpId)

  Deprecated. 
  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)

  Deprecated. 
  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)

  Deprecated. 
  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)

  Deprecated. 
  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)

  Deprecated. 
  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)

  Deprecated. 
  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 location)

  Deprecated. 
  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)

  Deprecated. 
  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

• getId

  public java.lang.String getId()

  Deprecated. 
  Description copied from interface: Location
  A unique id for this location.

  Specified by:

  getId in interface Identifiable

  Specified by:

  getId in interface Location

• getScope

  public java.lang.String getScope()

  Deprecated. 

  Specified by:

  getScope in interface PortForwardManager

• addAssociationListener

  public void addAssociationListener(PortForwardManager.AssociationListener listener,
                            com.google.common.base.Predicate<? super PortForwardManager.AssociationMetadata> filter)

  Deprecated. 
  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)

  Deprecated. 

  Specified by:

  removeAssociationListener in interface PortForwardManager

• toVerboseString

  public java.lang.String toVerboseString()

  Deprecated. 

  Specified by:

  toVerboseString in interface PortForwardManager

  Specified by:

  toVerboseString in interface Location

  Returns:

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

• acquirePublicPort

  @Deprecated
  public int acquirePublicPort(java.lang.String publicIpId,
                                 Location l,
                                 int privatePort)

  Deprecated. since 0.7.0; use acquirePublicPort(String), and then use associate(String, HostAndPort, int) or associate(String, HostAndPort, Location, int)
  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

• acquirePublicPortExplicit

  @Deprecated
  public PortMapping acquirePublicPortExplicit(java.lang.String publicIpId,
                                                 int publicPort)

  Deprecated. since 0.7.0; use associate(String, HostAndPort, int) or associate(String, HostAndPort, Location, int)
  Returns old mapping if it existed, null if it is new.

  Specified by:

  acquirePublicPortExplicit in interface PortForwardManager

• associate

  @Deprecated
  public void associate(java.lang.String publicIpId,
                          int publicPort,
                          Location l,
                          int privatePort)

  Deprecated. Use associate(String, HostAndPort, Location, int)
  Records a location and private port against a publicIp and public port, to support 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

• recordPublicIpHostname

  @Deprecated
  public void recordPublicIpHostname(java.lang.String publicIpId,
                                       java.lang.String hostnameOrPublicIpAddress)

  Deprecated. Use associate(String, HostAndPort, int) or associate(String, HostAndPort, Location, int)
  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. Use lookup(String, int) or lookup(Location, int)
  Returns a recorded public hostname or address.

  Specified by:

  getPublicIpHostname in interface PortForwardManager

• forgetPublicIpHostname

  @Deprecated
  public boolean forgetPublicIpHostname(java.lang.String publicIpId)

  Deprecated. Use forgetPortMapping(String, int) or #forgetPortMapping(Location, int)
  Clears a previous call to recordPublicIpHostname(String, String).

  Specified by:

  forgetPublicIpHostname in interface PortForwardManager

• isClient

  @Deprecated
  public boolean isClient()

  Deprecated. 
  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

• getPortMappingWithPublicSide

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

  Deprecated. since 0.7.0; this method will be internal only
  Returns the port mapping for a given publicIpId and public port.

  Specified by:

  getPortMappingWithPublicSide in interface PortForwardManager

• getPortMappingWithPublicIpId

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

  Deprecated. since 0.7.0; this method will be internal only
  Returns the subset of port mappings associated with a given public IP ID.

  Specified by:

  getPortMappingWithPublicIpId in interface PortForwardManager

• forgetPortMapping

  @Deprecated
  public boolean forgetPortMapping(PortMapping m)

  Deprecated. since 0.7.0; this method will be internal only

  Specified by:

  forgetPortMapping in interface PortForwardManager

  See Also:

  forgetPortMapping(String, int)

• getPublicHostAndPort

  @Deprecated
  public com.google.common.net.HostAndPort getPublicHostAndPort(PortMapping m)

  Deprecated. since 0.7.0; this method will be internal only
  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

• getLocationPublicIpIds

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

  Deprecated. since 0.7.0; this method will be internal only
  Returns the subset of port mappings associated with a given location.

  Specified by:

  getLocationPublicIpIds in interface PortForwardManager

• getPortMappingWithPrivateSide

  @Deprecated
  public PortMapping getPortMappingWithPrivateSide(Location l,
                                                     int privatePort)

  Deprecated. since 0.7.0; this method will be internal only
  Returns the mapping to a given private port, or null if none.

  Specified by:

  getPortMappingWithPrivateSide in interface PortForwardManager

• toString

  public java.lang.String toString()

  Deprecated. 

  Overrides:

  toString in class java.lang.Object

• getDisplayName

  public java.lang.String getDisplayName()

  Deprecated. 
  Description copied from interface: Location
  Get the name assigned to this location.

  Specified by:

  getDisplayName in interface BrooklynObject

  Specified by:

  getDisplayName in interface Location

  Returns:

  the name assigned to the location.

• getParent

  public Location getParent()

  Deprecated. 
  Description copied from interface: Location
  Get the 'parent' of this location. Locations are organized into a tree hierarchy, and this method will return a reference to the parent of this location, or null if this location is the tree root.

  Specified by:

  getParent in interface Location

  Returns:

  a reference to the parent of this location, or null if this location is the tree root.

• getChildren

  public java.util.Collection<Location> getChildren()

  Deprecated. 
  Description copied from interface: Location
  Get the 'children' of this location. Locations are organized into a tree hierarchy, and this method will return a collection containing the children of this location. This collection is an unmodifiable view of the data.

  Specified by:

  getChildren in interface Location

  Returns:

  a collection containing the children of this location.

• setParent

  public void setParent(Location newParent)

  Deprecated. 
  Description copied from interface: Location
  Set the 'parent' of this location. If this location was previously a child of a different location, it is removed from the other location first. It is valid to pass in null to indicate that the location should be disconnected from its parent. Adds this location as a child of the new parent (see getChildLocations()).

  Specified by:

  setParent in interface Location

  Parameters:

  newParent - the new parent location object, or null to clear the parent reference.

• containsLocation

  public boolean containsLocation(Location potentialDescendent)

  Deprecated. 
  Description copied from interface: Location
  Answers true if this location equals or is an ancestor of the given location.

  Specified by:

  containsLocation in interface Location

• getConfig

  public <T> T getConfig(ConfigKey<T> key)

  Deprecated. 
  Description copied from interface: Location
  Returns configuration set at this location or inherited or default. Convenience method for config().get(key)

  Specified by:

  getConfig in interface Location

• getConfig

  public <T> T getConfig(ConfigKey.HasConfigKey<T> key)

  Deprecated. 
  Description copied from interface: Location
  Convenience method for config().get(key)

  Specified by:

  getConfig in interface Location

  See Also:

  #getConfig(ConfigKey)}

• hasConfig

  public boolean hasConfig(ConfigKey<?> key,
                  boolean includeInherited)

  Deprecated. 
  Description copied from interface: Location
  True iff the indication config key is set, either inherited (second argument true) or locally-only (second argument false).

  Specified by:

  hasConfig in interface Location

• getAllConfig

  public java.util.Map<java.lang.String,java.lang.Object> getAllConfig(boolean includeInherited)

  Deprecated. 
  Description copied from interface: Location
  Returns all config set, either inherited (argument true) or locally-only (argument false).

  Specified by:

  getAllConfig in interface Location

• hasExtension

  public boolean hasExtension(java.lang.Class<?> extensionType)

  Deprecated. 
  Description copied from interface: Location
  Whether this location has support for the given extension type. See additional comments in Location.getExtension(Class).

  Specified by:

  hasExtension in interface Location

• getExtension

  public <T> T getExtension(java.lang.Class<T> extensionType)

  Deprecated. 
  Description copied from interface: Location
  Returns an extension of the given type. Note that the type must be an exact match for how the extension was registered (e.g. getExtension(Object.class) will not match anything, even though registered extension extend Object.

  This will not look at extensions of Location.getParent().

  Specified by:

  getExtension in interface Location

• getCatalogItemId

  public java.lang.String getCatalogItemId()

  Deprecated. 
  Description copied from interface: BrooklynObject
  The catalog item ID this object was loaded from.

  This can be used to understand the appropriate classloading context, such as for versioning purposes, as well as meta-information such as branding (maybe you can even get an icon) and potentially things like resource lifecycle (if a software version is being sunsetted).

  In some cases this may be set heuristically from context and so may not be accurate. Callers can set an explicit catalog item ID if inferencing is not correct.

  Specified by:

  getCatalogItemId in interface BrooklynObject

• tags

  public BrooklynObject.TagSupport tags()

  Deprecated. 
  Description copied from interface: BrooklynObject
  Tags are arbitrary objects which can be attached to an entity for subsequent reference. They must not be null (as ImmutableMap may be used under the covers; also there is little point!); and they should be amenable to our persistence (on-disk serialization) and our JSON serialization in the REST API.

  Specified by:

  tags in interface BrooklynObject

• getTagSupport

  public BrooklynObject.TagSupport getTagSupport()

  Deprecated. 

  Specified by:

  getTagSupport in interface BrooklynObject

• setConfig

  public <T> T setConfig(ConfigKey<T> key,
                T val)

  Deprecated. 

  Specified by:

  setConfig in interface Configurable

  Returns:

  the old value, or null if there was not one

• config

  public Configurable.ConfigurationSupport config()

  Deprecated. 

  Specified by:

  config in interface Configurable