org.apache.brooklyn.core.location.access

Class PortForwardManagerClient

java.lang.Object

org.apache.brooklyn.core.location.access.PortForwardManagerClient

All Implemented Interfaces:

Location, BrooklynObject, Configurable, Identifiable, PortForwardManager

Deprecated.

since 0.7.0; just use the PortForwardManager, or a direct reference to its impl PortForwardManagerImpl

@Deprecated
public class PortForwardManagerClient
extends java.lang.Object
implements PortForwardManager

Nested Class Summary

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

Field Summary

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

PORT_FORWARD_MANAGER_STARTING_PORT, SCOPE

Method Summary

Modifier and Type	Method and Description
int	acquirePublicPort(java.lang.String publicIpId) Deprecated. Reserves a unique public port on the given publicIpId.
void	addAssociationListener(PortForwardManager.AssociationListener listener, <any> filter) Deprecated. 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) Deprecated. 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) Deprecated. Records a location and private port against a public endpoint (ip and port), to support PortForwardManager.lookup(Location, int).
Configurable.ConfigurationSupport	config() Deprecated.
boolean	containsLocation(Location potentialDescendent) Deprecated. Answers true if this location equals or is an ancestor of the given location.
boolean	forgetPortMapping(PortMapping m) Deprecated. since 0.7.0; this method will be internal only
boolean	forgetPortMapping(java.lang.String publicIpId, int publicPort) Deprecated. Clears the given port mapping, returning true if there was a match.
boolean	forgetPortMappings(Location location) Deprecated. Clears the port mappings associated with the given location, returning true if there were any matches.
boolean	forgetPortMappings(java.lang.String publicIpId) Deprecated. Clears the port mappings associated with the given publicIpId, returning true if there were any matches.
static PortForwardManager	fromAttributeOnEntity(Entity entity, AttributeSensor<PortForwardManager> attributeOnEntity) Deprecated. creates an instance given an entity and AttributeSensor to retrieve the PortForwardManager
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
static PortForwardManager	fromSupplier(<any> 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
java.lang.String	getCatalogItemId() Deprecated. The catalog item ID this object was loaded from.
java.util.List<java.lang.String>	getCatalogItemIdSearchPath() Deprecated. An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit.
java.util.Collection<Location>	getChildren() Deprecated. Get the 'children' of this location.
<T> T	getConfig(ConfigKey.HasConfigKey<T> key) Deprecated. Convenience method for config().get(key)
<T> T	getConfig(ConfigKey<T> key) Deprecated. Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).
java.lang.String	getDisplayName() Deprecated. Get the name assigned to this location.
<T> T	getExtension(java.lang.Class<T> extensionType) Deprecated. Returns an extension of the given type.
java.lang.String	getId() Deprecated. A unique id for this location.
java.util.Collection<PortMapping>	getLocationPublicIpIds(Location l) Deprecated. since 0.7.0; this method will be internal only
Location	getParent() Deprecated. Get the 'parent' of this location.
PortMapping	getPortMappingWithPrivateSide(Location l, int privatePort) Deprecated. since 0.7.0; this method will be internal only
java.util.Collection<PortMapping>	getPortMappingWithPublicIpId(java.lang.String publicIpId) Deprecated. since 0.7.0; this method will be internal only
PortMapping	getPortMappingWithPublicSide(java.lang.String publicIpId, int publicPort) Deprecated. since 0.7.0; this method will be internal only
HostAndPort	getPublicHostAndPort(PortMapping m) Deprecated. since 0.7.0; this method will be internal only
java.lang.String	getScope() Deprecated.
boolean	hasExtension(java.lang.Class<?> extensionType) Deprecated. Whether this location has support for the given extension type.
HostAndPort	lookup(Location l, int privatePort) Deprecated. Returns the public ip hostname and public port for use contacting the given endpoint.
HostAndPort	lookup(java.lang.String publicIpId, int privatePort) Deprecated. Returns the public endpoint (host and port) for use contacting the given endpoint.
BrooklynObject.RelationSupport<Location>	relations() Deprecated. Relations specify a typed, directed connection between two entities.
void	removeAssociationListener(PortForwardManager.AssociationListener listener) Deprecated.
void	setParent(Location newParent) Deprecated. Set the 'parent' of this location.
BrooklynObject.SubscriptionSupport	subscriptions() Deprecated. Subscriptions are the mechanism for receiving notifications of sensor-events (e.g.
BrooklynObject.TagSupport	tags() Deprecated. Tags are arbitrary objects which can be attached to an entity for subsequent reference.
java.lang.String	toString() Deprecated.
java.lang.String	toVerboseString() Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

fromSupplier

public static PortForwardManager fromSupplier(<any> 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,
                      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 #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)

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 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:

#recordPublicIpHostname(String, String)

lookup

public 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 Location

Specified by:

getId in interface Identifiable

getScope

public java.lang.String getScope()

Deprecated.

Specified by:

getScope in interface PortForwardManager

addAssociationListener

public void addAssociationListener(PortForwardManager.AssociationListener listener,
                                   <any> 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 Location

Specified by:

toVerboseString in interface PortForwardManager

Returns:

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

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 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 Location

Specified by:

getDisplayName in interface BrooklynObject

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

getConfig

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

Deprecated.

Description copied from interface: Configurable

Convenience for calling Configurable.ConfigurationSupport.get(ConfigKey), via code like config().get(key).

Specified by:

getConfig in interface Configurable

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.

This should conform to OSGi specs for symbolic_name:version but weaker semantics are usually allowed so long as neither segment contains a : or whitespace.

Specified by:

getCatalogItemId in interface BrooklynObject

getCatalogItemIdSearchPath

public java.util.List<java.lang.String> getCatalogItemIdSearchPath()

Deprecated.

Description copied from interface: BrooklynObject

An immutable list of ids of catalog items that this item depends on in some way, with the item that directly defines it implicit, but other items it references explicit. Wrapping items are first in the list (i.e. wrapping items precede wrapped items), so for example, if the catalog is:

     items:
     - id: X
     - id: Y
       item: X
     - id: Z
       item: Y
 

the spec for Z will have getCatalogId() of Z and getCatalogItemIdSearchPath() of Y, X. (The self catalog ID is implicit at the head of the search path.)

Specified by:

getCatalogItemIdSearchPath 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

relations

public BrooklynObject.RelationSupport<Location> relations()

Deprecated.

Description copied from interface: BrooklynObject

Relations specify a typed, directed connection between two entities. Generic type is overridden in sub-interfaces.

Specified by:

relations in interface Location

Specified by:

relations in interface BrooklynObject

config

public Configurable.ConfigurationSupport config()

Deprecated.

Specified by:

config in interface Configurable

subscriptions

public BrooklynObject.SubscriptionSupport subscriptions()

Deprecated.

Description copied from interface: BrooklynObject

Subscriptions are the mechanism for receiving notifications of sensor-events (e.g. attribute-changed) from other entities.

Specified by:

subscriptions in interface BrooklynObject