org.apache.brooklyn.api.entity

Interface EntityInitializer

All Known Implementing Classes:

AbstractAddSensorFeed, AbstractEbsVolumeCustomizer, AddChildrenEffector, AddEffector, AddMachineMetrics, AddSensor, BasicJcloudsLocationCustomizer, ChildEntityCustomizer, CompositeEffector, CreatePasswordSensor, DefaultConnectivityResolver, DurationSinceSensor, EbsVolumeCustomizers.WithExistingSnapshot, EbsVolumeCustomizers.WithExistingVolume, EbsVolumeCustomizers.WithNewVolume, ElectPrimaryEffector, EntityInitializers.AddTags, FunctionSensor, HttpCommandEffector, HttpRequestSensor, InboundPortsJcloudsLocationCustomizer, JcloudsLocationSecurityGroupCustomizer, JmxAttributeSensor, MaxConcurrencySensor, ProxyEffector, SharedLocationSecurityGroupCustomizer, SimpleEffectorInitializer, SoftLayerSameVlanLocationCustomizer, SshCommandEffector, SshCommandSensor, StaticSensor, SudoTtyFixingCustomizer, WindowsPerformanceCounterSensors, WinRmCommandSensor

public interface EntityInitializer

Instances of this class supply logic which can be used to initialize entities. These can be added to an EntitySpec programmatically, or declared as part of YAML recipes in a brooklyn.initializers section. In the case of the latter, implementing classes should define a no-arg constructor or a Map constructor so that YAML parameters can be supplied.

Note that initializers are only invoked on first creation; they are not called during a rebind. Instead, the typical pattern is that initializers will create EntityAdjunct instances such as Policy and Feed which will be attached during rebind.

Method Summary

Modifier and Type	Method and Description
void	apply(EntityLocal entity) Applies initialization logic to a just-built entity.

Method Detail

apply

void apply(EntityLocal entity)

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

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)