KarafContainerImpl (Apache Brooklyn)

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.osgi.karaf.KarafContainerImpl

All Implemented Interfaces:

DriverDependentEntity, Entity, EntityLocal, Rebindable, BrooklynObject, Configurable, Identifiable, EntityInternal, Startable, BrooklynObjectInternal, UsesJava, UsesJmx, KarafContainer, SoftwareProcess
```
public class KarafContainerImpl
extends SoftwareProcessImpl
implements KarafContainer
```
This sets up a Karaf OSGi container

Nested Class Summary
- 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.entity.java.UsesJmx
  UsesJmx.JmxAgentModes
- Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.EntityInternal
  EntityInternal.EnricherSupportInternal, 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
Modifier and Type	Field and Description
`static java.lang.String`	`KARAF_ADMIN`
`static java.lang.String`	`KARAF_FEATURES`
`static java.lang.String`	`OSGI_BUNDLE_STATE`
`static java.lang.String`	`OSGI_COMPENDIUM`
`static java.lang.String`	`OSGI_FRAMEWORK`

Fields inherited from class org.apache.brooklyn.core.entity.AbstractEntity
CHILD_ADDED, CHILD_REMOVED, CONFIG_KEY_ADDED, CONFIG_KEY_REMOVED, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, GROUP_ADDED, GROUP_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED

Fields inherited from interface org.apache.brooklyn.entity.osgi.karaf.KarafContainer
ARCHIVE_DIRECTORY_NAME_FORMAT, DOWNLOAD_URL, FILE_SCHEME, HTTP_SCHEME, INSTALL_BUNDLE, INSTALL_FEATURE, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_USER, KARAF_INSTALL_LOCATION, KARAF_INSTANCES, KARAF_JAVA_OPTS, KARAF_NAME, KARAF_PID, KARAF_RMI_REGISTRY_PORT, KARAF_RMI_SERVER_PORT, KARAF_ROOT, KARAF_SSH_PORT, KARAF_STATE, LIST_BUNDLES, MVN_SCHEME, NAMED_PROPERTY_FILES, RMI_REGISTRY_PORT, SUGGESTED_VERSION, UNINSTALL_BUNDLE, UPDATE_SERVICE_PROPERTIES, 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

Constructor Summary

Constructors
Constructor and Description

KarafContainerImpl()

Constructors
Constructor and Description
`KarafContainerImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`KarafDriver`	`getDriver()`
`java.lang.Class<KarafDriver>`	`getDriverInterface()`
`void`	`init()` Default entity initialization, just calls `AbstractEntity.initEnrichers()`.
`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 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, addEnricher, addEnricher, addFeed, addGroup, addLocations, addPolicy, addPolicy, clearLocations, clearParent, config, configure, configure, configure, configure, configure, configure, destroy, emit, emitInternal, enrichers, equals, feeds, firstLocation, getAllAttributes, getAllConfig, getAllConfigBag, getApplication, getApplicationId, getAttribute, getAttributeByNameParts, getChildren, getConfig, getConfig, getConfig, getConfig, getConfigMap, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEffector, getEnrichers, getEntityType, getExecutionContext, getFeedSupport, getGroups, getIconUrl, getLocalConfigBag, getLocations, getManagementContext, getManagementSupport, getMutableEntityType, getParent, getPolicies, getProxy, getProxyIfAvailable, getRebindSupport, groups, hashCode, invalidateReferences, invoke, invoke, invoke, modifyAttribute, onManagementBecomingMaster, onManagementNoLongerMaster, onManagementStopped, policies, refreshInheritedConfig, relations, removeAllEnrichers, removeAllPolicies, removeAttribute, removeChild, removeEnricher, removeGroup, removeLocations, removePolicy, requestPersist, resetProxy, sensors, setAttribute, setAttribute, setAttributeWithoutPublishing, setConfig, setConfig, setConfig, setConfig, setConfig, setConfig, setConfigEvenIfOwned, setConfigEvenIfOwned, setDisplayName, setManagementContext, setParent, setProxy, subscribe, subscribeToChildren, subscribeToMembers, subscriptions, toMetadataRecord, toString, unsubscribe, unsubscribe

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject
getCatalogItemId, getId, setCatalogItemId, 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, 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

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

- Field Detail
  - KARAF_ADMIN
```
public static final java.lang.String KARAF_ADMIN
```
    See Also:
    Constant Field Values
  - KARAF_FEATURES
```
public static final java.lang.String KARAF_FEATURES
```
    See Also:
    Constant Field Values
  - OSGI_BUNDLE_STATE
```
public static final java.lang.String OSGI_BUNDLE_STATE
```
    See Also:
    Constant Field Values
  - OSGI_FRAMEWORK
```
public static final java.lang.String OSGI_FRAMEWORK
```
    See Also:
    Constant Field Values
  - OSGI_COMPENDIUM
```
public static final java.lang.String OSGI_COMPENDIUM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - KarafContainerImpl
```
public KarafContainerImpl()
```
- Method Detail
  - getDriverInterface
```
public java.lang.Class<KarafDriver> getDriverInterface()
```
    Specified by:
    
    getDriverInterface in interface DriverDependentEntity
  - getDriver
```
public KarafDriver getDriver()
```
    Specified by:
    
    getDriver in interface DriverDependentEntity
    
    Overrides:
    
    getDriver in class SoftwareProcessImpl
  - init
```
public void init()
```
    Description copied from class: AbstractEntity
    
    Default entity initialization, just calls AbstractEntity.initEnrichers().
    
    Overrides:
    
    init in class SoftwareProcessImpl
  - updateServiceProperties
```
public void updateServiceProperties(java.lang.String serviceName,
                           java.util.Map<java.lang.String,java.lang.String> additionalVals)
```
    Specified by:
    
    updateServiceProperties in interface KarafContainer
  - installFeature
```
public void installFeature(java.lang.String featureName)
                    throws java.lang.Exception
```
    Specified by:
    
    installFeature in interface KarafContainer
    
    Throws:
    
    java.lang.Exception
  - listBundles
```
public java.util.Map<java.lang.Long,java.util.Map<java.lang.String,?>> listBundles()
```
    Specified by:
    
    listBundles in interface KarafContainer
  - installBundle
```
public long installBundle(java.lang.String bundle)
                   throws java.net.URISyntaxException
```
    throws URISyntaxException If bundle name is not a valid URI
    
    Specified by:
    
    installBundle in interface KarafContainer
    
    Throws:
    
    java.net.URISyntaxException
  - uninstallBundle
```
public void uninstallBundle(java.lang.Long bundleId)
```
    Specified by:
    
    uninstallBundle in interface KarafContainer

Class KarafContainerImpl

Nested Class Summary

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

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

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

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

Field Summary

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

Fields inherited from interface org.apache.brooklyn.entity.osgi.karaf.KarafContainer

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

KARAF_ADMIN

KARAF_FEATURES

OSGI_BUNDLE_STATE

OSGI_FRAMEWORK

OSGI_COMPENDIUM

Constructor Detail

KarafContainerImpl

Method Detail

getDriverInterface

getDriver

init

updateServiceProperties

installFeature

listBundles

installBundle

uninstallBundle