org.apache.brooklyn.entity.network.bind

Class BindDnsServerImpl

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.entity.AbstractEntity

org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

org.apache.brooklyn.entity.network.bind.BindDnsServerImpl

All Implemented Interfaces:

DriverDependentEntity, Entity, EntityLocal, Rebindable, BrooklynObject, Configurable, Identifiable, EntityInternal, Startable, BrooklynObjectInternal, BindDnsServer, SoftwareProcess

public class BindDnsServerImpl
extends SoftwareProcessImpl
implements BindDnsServer

This sets up a BIND DNS server.

NOTE This entity has only been certified on CentOS, RHEL, Ubuntu and Debian operating systems.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BindDnsServerImpl.MemberTrackingPolicy

Nested classes/interfaces inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

SoftwareProcessImpl.ServiceNotUpDiagnosticsCollector, SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning

Nested classes/interfaces inherited from class org.apache.brooklyn.core.entity.AbstractEntity

AbstractEntity.BasicConfigurationSupport, AbstractEntity.BasicEnricherSupport, AbstractEntity.BasicGroupSupport, AbstractEntity.BasicPolicySupport, AbstractEntity.BasicSensorSupport, AbstractEntity.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.EntityInternal

EntityInternal.EnricherSupportInternal, EntityInternal.EntitySubscriptionSupportInternal, EntityInternal.FeedSupport, EntityInternal.GroupSupportInternal, EntityInternal.PolicySupportInternal, EntityInternal.SensorSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.entity.AbstractEntity

APPLICATION_ID, CATALOG_ID, CHILD_ADDED, CHILD_REMOVED, CONFIG_KEY_ADDED, CONFIG_KEY_REMOVED, DEFAULT_DISPLAY_NAME, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, ENTITY_ID, GROUP_ADDED, GROUP_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED

Fields inherited from interface org.apache.brooklyn.entity.network.bind.BindDnsServer

A_RECORDS, ADDRESS_MAPPINGS, ADDRESS_SENSOR, CNAME_RECORDS, DNS_PORT, DOMAIN_NAME, DOMAIN_ZONE_FILE_TEMPLATE, ENTITIES, ENTITY_FILTER, HOSTNAME_SENSOR, INTERFACE_CONFIG_TEMPLATE, MANAGEMENT_CIDR, NAMED_CONF_TEMPLATE, PTR_RECORDS, REPLACE_RESOLV_CONF, RESOLV_CONF_TEMPLATE, REVERSE_LOOKUP_CIDR, REVERSE_LOOKUP_DOMAIN, REVERSE_LOOKUP_NETWORK, REVERSE_ZONE_FILE_TEMPLATE, SERIAL, UPDATE_ROOT_ZONES_FILE

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INBOUND_PORTS_AUTO_INFER, INBOUND_PORTS_CONFIG_REGEX, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, OPEN_IPTABLES, PID_FILE, POST_CUSTOMIZE_COMMAND, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_CUSTOMIZE_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION, TEMPLATE_SUBSTITUTIONS

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Constructor Summary

Constructors

Constructor and Description
BindDnsServerImpl()

Method Summary

Modifier and Type	Method and Description
void	connectSensors() For binding to the running app (e.g.
void	disconnectSensors() For disconnecting from the running app.
<any>	getAddressMappings()
java.util.Map<java.lang.String,java.lang.String>	getAddressRecords()
<any>	getCanonicalNameRecords()
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getCnamesForTemplates()
java.lang.Integer	getDnsPort()
java.lang.String	getDomainName()
BindDnsServerDriver	getDriver()
java.lang.Class<?>	getDriverInterface()
DynamicGroup	getEntities()
<any>	getEntityFilter()
java.lang.String	getManagementCidr()
java.util.Map<java.lang.String,java.lang.String>	getPointerRecords()
java.lang.String	getReverseLookupDomain()
Cidr	getReverseLookupNetwork()
java.util.Map<java.lang.String,java.lang.String>	getReverseMappings()
long	getSerial() Increments the serial number sensor and returns it.
void	init() Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().
void	postRebind() Called after this entity is fully rebound (i.e.
void	postStart() Called after the rest of start has completed (after SoftwareProcessImpl.connectSensors() and SoftwareProcessImpl.waitForServiceUp())
void	update()

Methods inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

onManagementStarted, onManagementStarting, populateServiceNotUpDiagnostics, rebind, restart, start, stop, waitForEntityStart, waitForServiceUp, waitForServiceUp, waitForServiceUp, waitForServiceUp

Methods inherited from class org.apache.brooklyn.core.entity.AbstractEntity

addChild, addChild, addFeed, addLocations, addLocationsWithoutPublishing, clearLocations, clearParent, config, configure, configure, destroy, enrichers, equals, feeds, firstLocation, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getCreationTime, getDisplayName, getEffector, getEntityType, getExecutionContext, getIconUrl, getLocations, getManagementContext, getManagementSupport, getMutableEntityType, getParent, getProxy, getProxyIfAvailable, getRebindSupport, groups, hashCode, invalidateReferences, invoke, invoke, invoke, onManagementBecomingMaster, onManagementNoLongerMaster, onManagementStopped, policies, relations, removeChild, removeLocations, requestPersist, resetProxy, sensors, setConfigEvenIfOwned, setConfigEvenIfOwned, setDisplayName, setManagementContext, setParent, setProxy, subscriptions, toMetadataRecord, toString

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

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

BindDnsServerImpl

public BindDnsServerImpl()

Method Detail

init

public void init()

Description copied from class: AbstractEntity

Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().

Overrides:

init in class SoftwareProcessImpl

postRebind

public void postRebind()

Description copied from class: SoftwareProcessImpl

Called after this entity is fully rebound (i.e. it is fully managed).

getDriverInterface

public java.lang.Class<?> getDriverInterface()

Specified by:

getDriverInterface in interface DriverDependentEntity

getAddressMappings

public <any> getAddressMappings()

Specified by:

getAddressMappings in interface BindDnsServer

getReverseMappings

public java.util.Map<java.lang.String,java.lang.String> getReverseMappings()

Specified by:

getReverseMappings in interface BindDnsServer

Returns:

the IP to hostname mappings stored in this DNS server's conf file

getDriver

public BindDnsServerDriver getDriver()

Specified by:

getDriver in interface DriverDependentEntity

Overrides:

getDriver in class SoftwareProcessImpl

connectSensors

public void connectSensors()

Description copied from class: SoftwareProcessImpl

For binding to the running app (e.g. connecting sensors to registry). Will be called on start() and on rebind().

Implementations should be idempotent (ie tell whether sensors already connected), though the framework is pretty good about not calling when already connected. TODO improve the framework's feed system to detect duplicate additions

disconnectSensors

public void disconnectSensors()

Description copied from class: SoftwareProcessImpl

For disconnecting from the running app. Will be called on stop.

postStart

public void postStart()

Description copied from class: SoftwareProcessImpl

Called after the rest of start has completed (after SoftwareProcessImpl.connectSensors() and SoftwareProcessImpl.waitForServiceUp())

update

public void update()

getEntityFilter

public <any> getEntityFilter()

Specified by:

getEntityFilter in interface BindDnsServer

Returns:

the predicate used to filter entities for the Bind server to manage.

getManagementCidr

public java.lang.String getManagementCidr()

getDnsPort

public java.lang.Integer getDnsPort()

getDomainName

public java.lang.String getDomainName()

getSerial

public long getSerial()

Increments the serial number sensor and returns it. Increment is so that it is guaranteed to be valid for use in a modified domain.zone or reverse.zone file.

The side-effect is not entirely obvious by the method name but it makes it easier to use from the freemarker templates which call it!

getReverseLookupNetwork

public Cidr getReverseLookupNetwork()

getReverseLookupDomain

public java.lang.String getReverseLookupDomain()

getEntities

public DynamicGroup getEntities()

getAddressRecords

public java.util.Map<java.lang.String,java.lang.String> getAddressRecords()

getCanonicalNameRecords

public <any> getCanonicalNameRecords()

getCnamesForTemplates

public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getCnamesForTemplates()

getPointerRecords

public java.util.Map<java.lang.String,java.lang.String> getPointerRecords()