KarafContainerImpl (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.entity.basic.AbstractEntity
  - - brooklyn.entity.basic.SoftwareProcessImpl
    - - brooklyn.entity.osgi.karaf.KarafContainerImpl

All Implemented Interfaces:

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

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.entity.basic.SoftwareProcess
  SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Startable
  Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody
- Nested classes/interfaces inherited from interface brooklyn.entity.java.UsesJmx
  UsesJmx.JmxAgentModes
- Nested classes/interfaces inherited from interface brooklyn.entity.basic.EntityInternal
  EntityInternal.FeedSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

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 brooklyn.entity.basic.AbstractEntity
CHILD_ADDED, CHILD_REMOVED, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED

Fields inherited from interface brooklyn.entity.osgi.karaf.KarafContainer
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 brooklyn.entity.basic.SoftwareProcess
ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, PID_FILE, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, 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, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR

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

Fields inherited from interface 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 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 brooklyn.entity.basic.SoftwareProcessImpl
checkModifiable, getLocalHostname, onManagementStarted, onManagementStarting, rebind, restart, start, stop, waitForEntityStart, waitForServiceUp, waitForServiceUp, waitForServiceUp, waitForServiceUp

Methods inherited from class brooklyn.entity.basic.AbstractEntity
addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addLocations, addPolicy, addPolicy, addTag, clearLocations, clearParent, config, configure, configure, configure, configure, configure, containsTag, destroy, emit, emitInternal, 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, getSubscriptionContext, getTags, hashCode, invalidateReferences, invoke, invoke, invoke, modifyAttribute, onManagementBecomingMaster, onManagementNoLongerMaster, onManagementStopped, refreshInheritedConfig, removeAllEnrichers, removeAllPolicies, removeAttribute, removeChild, removeEnricher, removeGroup, removeLocations, removePolicy, removeTag, requestPersist, resetProxy, setAttribute, setAttribute, setAttributeWithoutPublishing, setConfig, setConfig, setConfig, setConfig, setConfig, setConfig, setConfigEvenIfOwned, setConfigEvenIfOwned, setDisplayName, setManagementContext, setParent, setProxy, subscribe, subscribeToChildren, subscribeToMembers, toMetadataRecord, toString, unsubscribe, unsubscribe

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getTagSupport, setCatalogItemId, tags

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.entity.Entity
addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, addTag, clearParent, containsTag, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getTags, invoke, removeChild, removeEnricher, removeGroup, removePolicy, removeTag, setParent

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.entity.trait.Startable
restart, start, stop

Methods inherited from interface brooklyn.basic.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 interface brooklyn.entity.basic.SoftwareProcess

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

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

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

Nested classes/interfaces inherited from interface brooklyn.entity.basic.EntityInternal

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Fields inherited from class brooklyn.entity.basic.AbstractEntity

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

Fields inherited from interface brooklyn.entity.basic.SoftwareProcess

Fields inherited from interface brooklyn.entity.trait.Startable

Fields inherited from interface brooklyn.entity.java.UsesJmx

Fields inherited from interface brooklyn.entity.java.UsesJava

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.basic.SoftwareProcessImpl

Methods inherited from class brooklyn.entity.basic.AbstractEntity

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.Entity

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.entity.trait.Startable

Methods inherited from interface brooklyn.basic.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