Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

brooklyn.entity.osgi.karaf
[Java] Interface KarafContainer

brooklyn.entity.Entity
  brooklyn.entity.java.UsesJava
      brooklyn.entity.basic.SoftwareProcess
          brooklyn.entity.trait.Startable
              brooklyn.entity.osgi.karaf.KarafContainer
                  brooklyn.entity.java.UsesJmx
                      brooklyn.entity.rebind.Rebindable
All Superinterfaces:
Entity, UsesJava, SoftwareProcess, Startable, UsesJmx, Rebindable
@Catalog(name="Karaf", description="Apache Karaf is a small OSGi based runtime which provides a lightweight container onto which various components and applications can be deployed.", iconUrl="classpath:///karaf-logo.png")
@ImplementedBy(KarafContainerImpl.class)
public interface KarafContainer
extends SoftwareProcess, UsesJava, UsesJmx

This sets up a Karaf OSGi container

Field Summary
static BasicAttributeSensorAndConfigKey DOWNLOAD_URL

static java.lang.String FILE_SCHEME

static java.lang.String HTTP_SCHEME

static Effector INSTALL_BUNDLE

static Effector INSTALL_FEATURE

static BasicAttributeSensorAndConfigKey JMX_CONTEXT

static BasicAttributeSensorAndConfigKey JMX_PASSWORD

static PortAttributeSensorAndConfigKey JMX_PORT

static BasicAttributeSensorAndConfigKey JMX_USER

static BasicAttributeSensor KARAF_INSTALL_LOCATION

static BasicAttributeSensor KARAF_INSTANCES

static BasicAttributeSensor KARAF_JAVA_OPTS

static BasicAttributeSensorAndConfigKey KARAF_NAME

static BasicAttributeSensor KARAF_PID

static BasicAttributeSensor KARAF_RMI_REGISTRY_PORT

static BasicAttributeSensor KARAF_RMI_SERVER_PORT

static BasicAttributeSensor KARAF_ROOT

static BasicAttributeSensor KARAF_SSH_PORT

static BasicAttributeSensor KARAF_STATE

static Effector LIST_BUNDLES

static java.lang.String MVN_SCHEME

static MapConfigKey NAMED_PROPERTY_FILES

static PortAttributeSensorAndConfigKey RMI_PORT

static PortAttributeSensorAndConfigKey RMI_SERVER_PORT

static BasicConfigKey SUGGESTED_VERSION

static Effector UNINSTALL_BUNDLE

static Effector UPDATE_SERVICE_PROPERTIES

static java.lang.String WRAP_SCHEME

 
Fields inherited from interface SoftwareProcess
ADDRESS, CUSTOMIZE_LATCH, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, HOSTNAME, INSTALL_LATCH, LAUNCH_LATCH, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, SERVICE_STATE, SHELL_ENVIRONMENT, START_LATCH, START_TIMEOUT, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR, SUGGESTED_VERSION
 
Fields inherited from interface UsesJava
JAVA_OPTIONS, JAVA_OPTS, JAVA_SYSPROPS
 
Fields inherited from interface UsesJmx
DEFAULT_JMX_PORT, JMX_CONTEXT, JMX_PORT, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, RMI_PORT, RMI_REGISTRY_PORT, RMI_SERVER_PORT, USE_JMX
 
Fields inherited from interface UsesJava
JAVA_OPTIONS, JAVA_OPTS, JAVA_SYSPROPS
 
Method Summary
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 listBundles()

void uninstallBundle(java.lang.Long bundleId)

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

 

Field Detail

DOWNLOAD_URL

@SetFromFlag("downloadUrl")
public static final BasicAttributeSensorAndConfigKey DOWNLOAD_URL

FILE_SCHEME

public static final java.lang.String FILE_SCHEME

HTTP_SCHEME

public static final java.lang.String HTTP_SCHEME

INSTALL_BUNDLE

public static final Effector INSTALL_BUNDLE

INSTALL_FEATURE

public static final Effector INSTALL_FEATURE

JMX_CONTEXT

@SetFromFlag("jmxContext")
public static final BasicAttributeSensorAndConfigKey JMX_CONTEXT

JMX_PASSWORD

@SetFromFlag("jmxPassword")
public static final BasicAttributeSensorAndConfigKey JMX_PASSWORD

JMX_PORT

@SetFromFlag("jmxPort")
public static final PortAttributeSensorAndConfigKey JMX_PORT

JMX_USER

@SetFromFlag("jmxUser")
public static final BasicAttributeSensorAndConfigKey JMX_USER

KARAF_INSTALL_LOCATION

public static final BasicAttributeSensor KARAF_INSTALL_LOCATION

KARAF_INSTANCES

public static final BasicAttributeSensor KARAF_INSTANCES

KARAF_JAVA_OPTS

public static final BasicAttributeSensor KARAF_JAVA_OPTS

KARAF_NAME

@SetFromFlag("karafName")
public static final BasicAttributeSensorAndConfigKey KARAF_NAME

KARAF_PID

public static final BasicAttributeSensor KARAF_PID

KARAF_RMI_REGISTRY_PORT

public static final BasicAttributeSensor KARAF_RMI_REGISTRY_PORT

KARAF_RMI_SERVER_PORT

public static final BasicAttributeSensor KARAF_RMI_SERVER_PORT

KARAF_ROOT

public static final BasicAttributeSensor KARAF_ROOT

KARAF_SSH_PORT

public static final BasicAttributeSensor KARAF_SSH_PORT

KARAF_STATE

public static final BasicAttributeSensor KARAF_STATE

LIST_BUNDLES

public static final Effector LIST_BUNDLES

MVN_SCHEME

public static final java.lang.String MVN_SCHEME

NAMED_PROPERTY_FILES

public static final MapConfigKey NAMED_PROPERTY_FILES

RMI_PORT

@Deprecated // since 0.4 use RMI_SERVER_PORT
public static final PortAttributeSensorAndConfigKey RMI_PORT

RMI_SERVER_PORT

@SetFromFlag("rmiServerPort")
public static final PortAttributeSensorAndConfigKey RMI_SERVER_PORT

SUGGESTED_VERSION

@SetFromFlag("version")
public static final BasicConfigKey SUGGESTED_VERSION

UNINSTALL_BUNDLE

public static final Effector UNINSTALL_BUNDLE

UPDATE_SERVICE_PROPERTIES

public static final Effector UPDATE_SERVICE_PROPERTIES

WRAP_SCHEME

public static final java.lang.String WRAP_SCHEME

 
Method Detail

installBundle

@Description("Deploys the given bundle, returning the bundle id - see osgi.core:type=framework#installBundle()")
public long installBundle(@NamedParameter("bundle") @Description("URI of bundle to be deployed") java.lang.String bundle)
throws URISyntaxException If bundle name is not a valid URI

installFeature

@Description("Installs the given OSGi feature")
public void installFeature(@NamedParameter("featureName") @Description("Name of the feature - see org.apache.karaf:type=features#installFeature()") java.lang.String featureName)

listBundles

@Description("Lists all the karaf bundles")
public java.util.Map listBundles()

uninstallBundle

@Description("Undeploys the bundle with the given id")
public void uninstallBundle(@NamedParameter("bundleId") @Description("Id of the bundle") java.lang.Long bundleId)

updateServiceProperties

@Description("Updates the OSGi Service's properties, adding (and overriding) the given key-value pairs")
public void updateServiceProperties(@NamedParameter("serviceName") @Description("Name of the OSGi service") java.lang.String serviceName, java.util.Map additionalVals)

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.