org.apache.brooklyn.location.jclouds

Class BasicJcloudsLocationCustomizer

java.lang.Object

org.apache.brooklyn.core.objs.BasicConfigurableObject

org.apache.brooklyn.location.jclouds.BasicJcloudsLocationCustomizer

All Implemented Interfaces:

EntityInitializer, Configurable, Identifiable, HasBrooklynManagementContext, ManagementContextInjectable, JcloudsLocationCustomizer

Direct Known Subclasses:

AbstractEbsVolumeCustomizer, ChildEntityCustomizer, InboundPortsJcloudsLocationCustomizer, JcloudsLocationSecurityGroupCustomizer, SharedLocationSecurityGroupCustomizer, SoftLayerSameVlanLocationCustomizer, SudoTtyFixingCustomizer

public class BasicJcloudsLocationCustomizer
extends BasicConfigurableObject
implements JcloudsLocationCustomizer, EntityInitializer

A default no-op location customizer, which can be extended to override the appropriate methods.

When the class is used as an EntityInitializer it inserts itself into the entity's JcloudsLocationConfig.JCLOUDS_LOCATION_CUSTOMIZERS under the BrooklynConfigKeys.PROVISIONING_PROPERTIES key.

Nested Class Summary

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	apply(EntityLocal entity) Applies initialization logic to a just-built entity.
void	customize(JcloudsLocation location, org.jclouds.compute.ComputeService computeService, JcloudsMachineLocation machine) Override to configure the given machine once it has been created and started by Jclouds.
void	customize(JcloudsLocation location, org.jclouds.compute.ComputeService computeService, org.jclouds.compute.domain.Template template) Override to configure a subclass of this with the built template, or to configure the built template's TemplateOptions.
void	customize(JcloudsLocation location, org.jclouds.compute.ComputeService computeService, org.jclouds.compute.domain.TemplateBuilder templateBuilder) Override to configure templateBuilder before it is built and immutable.
void	customize(JcloudsLocation location, org.jclouds.compute.ComputeService computeService, org.jclouds.compute.options.TemplateOptions templateOptions) Override to configure the TemplateOptions that will be used by JcloudsLocation to obtain machines.
void	customize(JcloudsLocation location, org.jclouds.compute.domain.NodeMetadata node, ConfigBag setup) Override to configure the NodeMetadata, and ConfigBag that will be used when connecting to the machine.
void	postRelease(JcloudsMachineLocation machine) Override to handle machine-related cleanup after Jclouds is called to release (destroy) the machine.
void	postReleaseOnObtainError(JcloudsLocation jcloudsLocation, JcloudsMachineLocation machineLocation, java.lang.Exception cause) Override to handle cleanup after failure to obtain a machine.
void	preRelease(JcloudsMachineLocation machine) Override to handle machine-related cleanup before Jclouds is called to release (destroy) the machine.
void	preReleaseOnObtainError(JcloudsLocation jcloudsLocation, JcloudsMachineLocation machineLocation, java.lang.Exception cause) Override to handle cleanup after failure to obtain a machine.

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, toString, wait, wait, wait

Constructor Detail

BasicJcloudsLocationCustomizer

public BasicJcloudsLocationCustomizer()

BasicJcloudsLocationCustomizer

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

BasicJcloudsLocationCustomizer

public BasicJcloudsLocationCustomizer(ConfigBag params)

Method Detail

apply

public void apply(EntityLocal entity)

Description copied from interface: EntityInitializer

Applies initialization logic to a just-built entity. Invoked immediately after the "init" call on the AbstractEntity constructed.

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)

customize

public void customize(JcloudsLocation location,
                      org.jclouds.compute.ComputeService computeService,
                      org.jclouds.compute.domain.TemplateBuilder templateBuilder)

Description copied from interface: JcloudsLocationCustomizer

Override to configure templateBuilder before it is built and immutable.

Specified by:

customize in interface JcloudsLocationCustomizer

customize

public void customize(JcloudsLocation location,
                      org.jclouds.compute.ComputeService computeService,
                      org.jclouds.compute.domain.Template template)

Description copied from interface: JcloudsLocationCustomizer

Override to configure a subclass of this with the built template, or to configure the built template's TemplateOptions.

This method will be called before JcloudsLocationCustomizer.customize(JcloudsLocation, ComputeService, TemplateOptions).

Specified by:

customize in interface JcloudsLocationCustomizer

customize

public void customize(JcloudsLocation location,
                      org.jclouds.compute.ComputeService computeService,
                      org.jclouds.compute.options.TemplateOptions templateOptions)

Description copied from interface: JcloudsLocationCustomizer

Override to configure the TemplateOptions that will be used by JcloudsLocation to obtain machines.

Specified by:

customize in interface JcloudsLocationCustomizer

customize

public void customize(JcloudsLocation location,
                      org.jclouds.compute.domain.NodeMetadata node,
                      ConfigBag setup)

Description copied from interface: JcloudsLocationCustomizer

Override to configure the NodeMetadata, and ConfigBag that will be used when connecting to the machine.

Specified by:

customize in interface JcloudsLocationCustomizer

customize

public void customize(JcloudsLocation location,
                      org.jclouds.compute.ComputeService computeService,
                      JcloudsMachineLocation machine)

Description copied from interface: JcloudsLocationCustomizer

Override to configure the given machine once it has been created and started by Jclouds.

If CloudLocationConfig.WAIT_FOR_SSHABLE is true the machine is guaranteed to be SSHable when this method is called.

Specified by:

customize in interface JcloudsLocationCustomizer

preRelease

public void preRelease(JcloudsMachineLocation machine)

Description copied from interface: JcloudsLocationCustomizer

Override to handle machine-related cleanup before Jclouds is called to release (destroy) the machine.

Specified by:

preRelease in interface JcloudsLocationCustomizer

postRelease

public void postRelease(JcloudsMachineLocation machine)

Description copied from interface: JcloudsLocationCustomizer

Override to handle machine-related cleanup after Jclouds is called to release (destroy) the machine.

Specified by:

postRelease in interface JcloudsLocationCustomizer

preReleaseOnObtainError

public void preReleaseOnObtainError(JcloudsLocation jcloudsLocation,
                                    @Nullable
                                    JcloudsMachineLocation machineLocation,
                                    java.lang.Exception cause)

Description copied from interface: JcloudsLocationCustomizer

Override to handle cleanup after failure to obtain a machine. Could be called as a result of an InterruptedException in which case return as quickly as possible.

Specified by:

preReleaseOnObtainError in interface JcloudsLocationCustomizer

postReleaseOnObtainError

public void postReleaseOnObtainError(JcloudsLocation jcloudsLocation,
                                     @Nullable
                                     JcloudsMachineLocation machineLocation,
                                     java.lang.Exception cause)

Description copied from interface: JcloudsLocationCustomizer

Override to handle cleanup after failure to obtain a machine. Called after releasing the locations' underlying node. Could be called as a result of an InterruptedException in which case return as quickly as possible.

Will be skipped if CloudLocationConfig.DESTROY_ON_FAILURE is set to false.

Specified by:

postReleaseOnObtainError in interface JcloudsLocationCustomizer