KafkaBroker (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, Kafka, MessageBroker, SoftwareProcess, Startable, UsesJava, UsesJmx

All Known Implementing Classes:

KafkaBrokerImpl
```
public interface KafkaBroker
extends SoftwareProcess, MessageBroker, UsesJmx, Kafka
```
An Entity that represents a single Kafka broker instance.

Nested Class Summary
- 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.core.entity.trait.Startable
  Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody
- 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.entity.java.UsesJmx
  UsesJmx.JmxAgentModes

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeSensor<java.lang.Integer>`	`BROKER_ID`
`static AttributeSensor<java.lang.Long>`	`BYTES_RECEIVED`
`static AttributeSensor<java.lang.Long>`	`BYTES_SENT`
`static AttributeSensor<java.lang.Long>`	`FETCH_REQUEST_COUNT`
`static PortAttributeSensorAndConfigKey`	`INTERNAL_JMX_PORT`
`static ConfigKey<java.lang.String>`	`KAFKA_BROKER_CONFIG_TEMPLATE` Location of the configuration file template to be copied to the server.
`static PortAttributeSensorAndConfigKey`	`KAFKA_PORT`
`static AttributeSensor<java.lang.Double>`	`MAX_FETCH_TIME`
`static AttributeSensor<java.lang.Double>`	`MAX_PRODUCE_TIME`
`static AttributeSensor<java.lang.Long>`	`PRODUCE_REQUEST_COUNT`
`static ConfigKey<Duration>`	`START_TIMEOUT`
`static ConfigKey<java.lang.String>`	`SUGGESTED_VERSION`
`static AttributeSensor<java.lang.Long>`	`TOTAL_FETCH_TIME`
`static AttributeSensor<java.lang.Long>`	`TOTAL_PRODUCE_TIME`
`static ConfigKey<ZooKeeperNode>`	`ZOOKEEPER`

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, 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_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, STOP_IPTABLES, SUBNET_ADDRESS, SUBNET_HOSTNAME

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable
RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.entity.messaging.MessageBroker
BROKER_URL

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJmx
DEFAULT_JMX_PORT, JMX_AGENT_LOCAL_PATH, JMX_AGENT_MODE, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_PORT_LEGACY, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, JMX_USER, RMI_REGISTRY_PORT, USE_JMX

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava
CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS, JAVA_VERSION_REQUIRED

Fields inherited from interface org.apache.brooklyn.entity.messaging.kafka.Kafka
ARCHIVE_DIRECTORY_NAME_FORMAT, DOWNLOAD_URL

Method Summary

Methods
Modifier and Type Method and Description

java.lang.Integer getBrokerId()

java.lang.Integer getKafkaPort()

ZooKeeperNode getZookeeper()
- Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
  populateServiceNotUpDiagnostics
- Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable
  restart, start, stop
- Methods inherited from interface org.apache.brooklyn.entity.messaging.MessageBroker
  setBrokerUrl
- Methods inherited from interface org.apache.brooklyn.api.entity.Entity
  addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, groups, invoke, policies, relations, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setDisplayName, setParent
- Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
  getCatalogItemId, subscriptions, tags
- Methods inherited from interface org.apache.brooklyn.api.objs.Configurable
  config, getConfig, setConfig

Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getBrokerId()`
`java.lang.Integer`	`getKafkaPort()`
`ZooKeeperNode`	`getZookeeper()`

Field Detail

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

KAFKA_PORT

static final PortAttributeSensorAndConfigKey KAFKA_PORT

KAFKA_BROKER_CONFIG_TEMPLATE
```
static final ConfigKey<java.lang.String> KAFKA_BROKER_CONFIG_TEMPLATE
```
Location of the configuration file template to be copied to the server.

ZOOKEEPER

static final ConfigKey<ZooKeeperNode> ZOOKEEPER

INTERNAL_JMX_PORT

static final PortAttributeSensorAndConfigKey INTERNAL_JMX_PORT

BROKER_ID

static final AttributeSensor<java.lang.Integer> BROKER_ID

FETCH_REQUEST_COUNT

static final AttributeSensor<java.lang.Long> FETCH_REQUEST_COUNT

TOTAL_FETCH_TIME

static final AttributeSensor<java.lang.Long> TOTAL_FETCH_TIME

MAX_FETCH_TIME

static final AttributeSensor<java.lang.Double> MAX_FETCH_TIME

PRODUCE_REQUEST_COUNT

static final AttributeSensor<java.lang.Long> PRODUCE_REQUEST_COUNT

TOTAL_PRODUCE_TIME

static final AttributeSensor<java.lang.Long> TOTAL_PRODUCE_TIME

MAX_PRODUCE_TIME

static final AttributeSensor<java.lang.Double> MAX_PRODUCE_TIME

BYTES_RECEIVED

static final AttributeSensor<java.lang.Long> BYTES_RECEIVED

BYTES_SENT

static final AttributeSensor<java.lang.Long> BYTES_SENT

Method Detail

getKafkaPort
```
java.lang.Integer getKafkaPort()
```

getBrokerId
```
java.lang.Integer getBrokerId()
```

getZookeeper
```
ZooKeeperNode getZookeeper()
```

Interface KafkaBroker

Nested Class Summary

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

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

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

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

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

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.java.UsesJmx

Field Summary

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

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

Fields inherited from interface org.apache.brooklyn.entity.messaging.MessageBroker

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJmx

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava

Fields inherited from interface org.apache.brooklyn.entity.messaging.kafka.Kafka

Method Summary

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

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

Methods inherited from interface org.apache.brooklyn.entity.messaging.MessageBroker

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

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

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

Field Detail

START_TIMEOUT

SUGGESTED_VERSION

KAFKA_PORT

KAFKA_BROKER_CONFIG_TEMPLATE

ZOOKEEPER

INTERNAL_JMX_PORT

BROKER_ID

FETCH_REQUEST_COUNT

TOTAL_FETCH_TIME

MAX_FETCH_TIME

PRODUCE_REQUEST_COUNT

TOTAL_PRODUCE_TIME

MAX_PRODUCE_TIME

BYTES_RECEIVED

BYTES_SENT

Method Detail

getKafkaPort

getBrokerId

getZookeeper