KarafContainer (Apache Brooklyn)

All Superinterfaces:

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

All Known Implementing Classes:

KarafContainerImpl
```
public interface KarafContainer
extends SoftwareProcess, UsesJava, UsesJmx
```
This sets up a Karaf OSGi container

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.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.entity.java.UsesJmx
  UsesJmx.JmxAgentModes

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.String>`	`ARCHIVE_DIRECTORY_NAME_FORMAT`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`DOWNLOAD_URL`
`static java.lang.String`	`FILE_SCHEME`
`static java.lang.String`	`HTTP_SCHEME`
`static MethodEffector<java.lang.Long>`	`INSTALL_BUNDLE`
`static MethodEffector<java.lang.Void>`	`INSTALL_FEATURE`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`JMX_CONTEXT`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`JMX_PASSWORD`
`static PortAttributeSensorAndConfigKey`	`JMX_PORT`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`JMX_USER`
`static AttributeSensor<java.lang.String>`	`KARAF_INSTALL_LOCATION`
`static AttributeSensor<java.util.Map>`	`KARAF_INSTANCES`
`static AttributeSensor<java.lang.String>`	`KARAF_JAVA_OPTS`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`KARAF_NAME`
`static AttributeSensor<java.lang.Integer>`	`KARAF_PID`
`static AttributeSensor<java.lang.Integer>`	`KARAF_RMI_REGISTRY_PORT`
`static AttributeSensor<java.lang.Integer>`	`KARAF_RMI_SERVER_PORT`
`static AttributeSensor<java.lang.Boolean>`	`KARAF_ROOT`
`static AttributeSensor<java.lang.Integer>`	`KARAF_SSH_PORT`
`static AttributeSensor<java.lang.String>`	`KARAF_STATE`
`static MethodEffector<java.util.Map<java.lang.Long,java.util.Map<java.lang.String,?>>>`	`LIST_BUNDLES`
`static java.lang.String`	`MVN_SCHEME`
`static MapConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`NAMED_PROPERTY_FILES`
`static PortAttributeSensorAndConfigKey`	`RMI_REGISTRY_PORT`
`static ConfigKey<java.lang.String>`	`SUGGESTED_VERSION`
`static MethodEffector<java.lang.Void>`	`UNINSTALL_BUNDLE`
`static MethodEffector<java.lang.Void>`	`UPDATE_SERVICE_PROPERTIES`
`static java.lang.String`	`WRAP_SCHEME`

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, 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, START_TIMEOUT, 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.java.UsesJmx
DEFAULT_JMX_PORT, JMX_AGENT_LOCAL_PATH, JMX_AGENT_MODE, JMX_PORT_LEGACY, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, USE_JMX

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

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`installBundle(java.lang.String bundle)` throws URISyntaxException If bundle name is not a valid URI
`void`	`installFeature(java.lang.String featureName)`
`java.util.Map<java.lang.Long,java.util.Map<java.lang.String,?>>`	`listBundles()`
`void`	`uninstallBundle(java.lang.Long bundleId)`
`void`	`updateServiceProperties(java.lang.String serviceName, java.util.Map<java.lang.String,java.lang.String> additionalVals)`

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

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 inherited from interface org.apache.brooklyn.core.entity.trait.Startable
restart, start, stop

Field Detail

WRAP_SCHEME

static final java.lang.String WRAP_SCHEME

See Also:: Constant Field Values

FILE_SCHEME

static final java.lang.String FILE_SCHEME

See Also:: Constant Field Values

MVN_SCHEME

static final java.lang.String MVN_SCHEME

See Also:: Constant Field Values

HTTP_SCHEME

static final java.lang.String HTTP_SCHEME

See Also:: Constant Field Values

LIST_BUNDLES

static final MethodEffector<java.util.Map<java.lang.Long,java.util.Map<java.lang.String,?>>> LIST_BUNDLES

INSTALL_BUNDLE

static final MethodEffector<java.lang.Long> INSTALL_BUNDLE

UNINSTALL_BUNDLE

static final MethodEffector<java.lang.Void> UNINSTALL_BUNDLE

INSTALL_FEATURE

static final MethodEffector<java.lang.Void> INSTALL_FEATURE

UPDATE_SERVICE_PROPERTIES

static final MethodEffector<java.lang.Void> UPDATE_SERVICE_PROPERTIES

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

ARCHIVE_DIRECTORY_NAME_FORMAT

static final ConfigKey<java.lang.String> ARCHIVE_DIRECTORY_NAME_FORMAT

DOWNLOAD_URL

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> DOWNLOAD_URL

KARAF_NAME

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> KARAF_NAME

NAMED_PROPERTY_FILES

static final MapConfigKey<java.util.Map<java.lang.String,java.lang.String>> NAMED_PROPERTY_FILES

JMX_USER

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> JMX_USER

JMX_PASSWORD

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> JMX_PASSWORD

JMX_PORT

static final PortAttributeSensorAndConfigKey JMX_PORT

RMI_REGISTRY_PORT

static final PortAttributeSensorAndConfigKey RMI_REGISTRY_PORT

JMX_CONTEXT

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> JMX_CONTEXT

KARAF_INSTANCES

static final AttributeSensor<java.util.Map> KARAF_INSTANCES

KARAF_ROOT

static final AttributeSensor<java.lang.Boolean> KARAF_ROOT

KARAF_JAVA_OPTS

static final AttributeSensor<java.lang.String> KARAF_JAVA_OPTS

KARAF_INSTALL_LOCATION

static final AttributeSensor<java.lang.String> KARAF_INSTALL_LOCATION

KARAF_PID

static final AttributeSensor<java.lang.Integer> KARAF_PID

KARAF_SSH_PORT

static final AttributeSensor<java.lang.Integer> KARAF_SSH_PORT

KARAF_RMI_REGISTRY_PORT

static final AttributeSensor<java.lang.Integer> KARAF_RMI_REGISTRY_PORT

KARAF_RMI_SERVER_PORT

static final AttributeSensor<java.lang.Integer> KARAF_RMI_SERVER_PORT

KARAF_STATE

static final AttributeSensor<java.lang.String> KARAF_STATE

Method Detail

updateServiceProperties

void updateServiceProperties(java.lang.String serviceName,
                           java.util.Map<java.lang.String,java.lang.String> additionalVals)

installFeature

void installFeature(java.lang.String featureName)
                    throws java.lang.Exception

Throws:: java.lang.Exception

listBundles

java.util.Map<java.lang.Long,java.util.Map<java.lang.String,?>> listBundles()

installBundle
```
long installBundle(java.lang.String bundle)
                   throws java.net.URISyntaxException
```
throws URISyntaxException If bundle name is not a valid URI

Throws:

java.net.URISyntaxException

uninstallBundle

void uninstallBundle(java.lang.Long bundleId)

Interface KarafContainer

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.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.core.entity.trait.Startable

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.java.UsesJmx

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

Method Summary

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

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

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

Field Detail

WRAP_SCHEME

FILE_SCHEME

MVN_SCHEME

HTTP_SCHEME

LIST_BUNDLES

INSTALL_BUNDLE

UNINSTALL_BUNDLE

INSTALL_FEATURE

UPDATE_SERVICE_PROPERTIES

SUGGESTED_VERSION

ARCHIVE_DIRECTORY_NAME_FORMAT

DOWNLOAD_URL

KARAF_NAME

NAMED_PROPERTY_FILES

JMX_USER

JMX_PASSWORD

JMX_PORT

RMI_REGISTRY_PORT

JMX_CONTEXT

KARAF_INSTANCES

KARAF_ROOT

KARAF_JAVA_OPTS

KARAF_INSTALL_LOCATION

KARAF_PID

KARAF_SSH_PORT

KARAF_RMI_REGISTRY_PORT

KARAF_RMI_SERVER_PORT

KARAF_STATE

Method Detail

updateServiceProperties

installFeature

listBundles

installBundle

uninstallBundle