org.apache.brooklyn.location.jclouds

Class DefaultConnectivityResolver

java.lang.Object

org.apache.brooklyn.core.objs.BasicConfigurableObject

org.apache.brooklyn.location.jclouds.DefaultConnectivityResolver

All Implemented Interfaces:

EntityInitializer, Configurable, Identifiable, HasBrooklynManagementContext, ManagementContextInjectable, ConnectivityResolver

public class DefaultConnectivityResolver
extends BasicConfigurableObject
implements ConnectivityResolver, EntityInitializer

DefaultConnectivityResolver provides the default implementation of ConnectivityResolver. It exposes options to have JcloudsLocation prefer to contact VMs on private addresses and can be injected on a per-entity basis. For example:

 services:
 - type: server
   location: the-same-private-network-as-brooklyn
   brooklyn.initializers:
   - type: org.apache.brooklyn.location.jclouds.DefaultConnectivityResolver
     brooklyn.config:
       mode: ONLY_PRIVATE
 - type: server
   location: another-cloud
   # implicit use of PREFER_PUBLIC.
 

Would result in the first entity being managed on the instance's private address (and deployment failing if this was not possible) and the second being managed on its public address. Graceful fallback is possible by replacing ONLY_PRIVATE with PREFER_PRIVATE. There are PUBLIC variants of each of these.

DefaultConnectivityResolver is the default location network info customizer used by JcloudsLocation when JcloudsLocationConfig.CONNECTIVITY_RESOLVER is unset.

When used as an EntityInitializer the instance inserts itself into the entity's provisioning properties under the JcloudsLocationConfig.CONNECTIVITY_RESOLVER subkey.

This class is annotated @Beta and is likely to change in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultConnectivityResolver.NetworkMode

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.BasicConfigurableObject

BasicConfigurableObject.BasicConfigurationSupport

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

Configurable.ConfigurationSupport

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.Boolean>	CHECK_CREDENTIALS
static ConfigKey<DefaultConnectivityResolver.NetworkMode>	NETWORK_MODE
static ConfigKey<java.lang.Boolean>	PUBLISH_NETWORKS

Fields inherited from interface org.apache.brooklyn.location.jclouds.ConnectivityResolver

PRIVATE_ADDRESSES, PUBLIC_ADDRESSES

Constructor Summary

Constructors

Constructor and Description
DefaultConnectivityResolver()
DefaultConnectivityResolver(ConfigBag params)
DefaultConnectivityResolver(java.util.Map<?,?> params)

Method Summary

Modifier and Type	Method and Description
void	apply(EntityLocal entity) Sets the instance as the value of JcloudsLocationConfig.CONNECTIVITY_RESOLVER in entity's provisioning properties.
ManagementAddressResolveResult	resolve(JcloudsLocation location, org.jclouds.compute.domain.NodeMetadata node, ConfigBag config, ConnectivityResolverOptions options) Combines the given resolve options with the customiser's configuration to determine the best address and credential pair for management.
java.lang.String	toString()

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

config, getBrooklynManagementContext, getConfig, getId, setManagementContext

Methods inherited from class java.lang.Object

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

Field Detail

NETWORK_MODE

public static final ConfigKey<DefaultConnectivityResolver.NetworkMode> NETWORK_MODE

CHECK_CREDENTIALS

public static final ConfigKey<java.lang.Boolean> CHECK_CREDENTIALS

PUBLISH_NETWORKS

public static final ConfigKey<java.lang.Boolean> PUBLISH_NETWORKS

Constructor Detail

DefaultConnectivityResolver

public DefaultConnectivityResolver()

DefaultConnectivityResolver

public DefaultConnectivityResolver(java.util.Map<?,?> params)

DefaultConnectivityResolver

public DefaultConnectivityResolver(ConfigBag params)

Method Detail

apply

public void apply(EntityLocal entity)

Sets the instance as the value of JcloudsLocationConfig.CONNECTIVITY_RESOLVER in entity's provisioning properties.

Specified by:

apply in interface EntityInitializer

Parameters:

entity - guaranteed to be the actual implementation instance, thus guaranteed to be castable to EntityInternal which is often desired, or to the type at hand (it is not even a proxy)

resolve

public ManagementAddressResolveResult resolve(JcloudsLocation location,
                                              org.jclouds.compute.domain.NodeMetadata node,
                                              ConfigBag config,
                                              ConnectivityResolverOptions options)

Combines the given resolve options with the customiser's configuration to determine the best address and credential pair for management. In particular, if the resolve options allow it will check that the credential is actually valid for the address.

Specified by:

resolve in interface ConnectivityResolver

Parameters:

location - The caller

node - The node the caller has created

config - The configuration the caller used to create the node

options - Additional options the caller has chosen when creating the node

Returns:

The HostAndPort and LoginCredentials to use when connecting to the node.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object