Brooklyn

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

brooklyn.entity.java.UsesJava
  brooklyn.entity.trait.Startable
      brooklyn.entity.osgi.karaf.KarafContainer
          brooklyn.entity.rebind.Rebindable
              brooklyn.entity.Entity
                  brooklyn.entity.basic.SoftwareProcess
                      brooklyn.entity.java.UsesJmx
                          brooklyn.entity.trait.Identifiable
All Superinterfaces:
UsesJava, Startable, Rebindable, Entity, SoftwareProcess, UsesJmx, Identifiable

@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 MethodEffector INSTALL_BUNDLE

static MethodEffector 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 MethodEffector LIST_BUNDLES

static java.lang.String MVN_SCHEME

static MapConfigKey NAMED_PROPERTY_FILES

static PortAttributeSensorAndConfigKey RMI_PORT

static PortAttributeSensorAndConfigKey RMI_REGISTRY_PORT

static PortAttributeSensorAndConfigKey RMI_SERVER_PORT

static ConfigKey SUGGESTED_VERSION

static MethodEffector UNINSTALL_BUNDLE

static MethodEffector 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, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR, SUGGESTED_VERSION
 
Fields inherited from interface UsesJava
CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS
 
Fields inherited from interface UsesJmx
DEFAULT_JMX_PORT, JMX_AGENT_MODE, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, JMX_USER, RMI_REGISTRY_PORT, RMI_SERVER_PORT, USE_JMX
 
Fields inherited from interface UsesJava
CHECK_JAVA_HOSTNAME_BUG, 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

public static final BasicAttributeSensorAndConfigKey DOWNLOAD_URL = new BasicAttributeSensorAndConfigKey(
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 MethodEffector INSTALL_BUNDLE


INSTALL_FEATURE

public static final MethodEffector INSTALL_FEATURE


JMX_CONTEXT

UsesJmx.JMX_CONTEXT, "karaf-"+KARAF_NAME.getConfigKey().getDefaultValue());
public static final BasicAttributeSensorAndConfigKey JMX_CONTEXT


JMX_PASSWORD

UsesJmx.JMX_PASSWORD, "karaf");
public static final BasicAttributeSensorAndConfigKey JMX_PASSWORD


JMX_PORT

UsesJmx.JMX_PORT, "44444+");
public static final PortAttributeSensorAndConfigKey JMX_PORT


JMX_USER

UsesJmx.JMX_USER, "karaf");
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

public static final BasicAttributeSensorAndConfigKey KARAF_NAME = new BasicAttributeSensorAndConfigKey(
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 MethodEffector LIST_BUNDLES


MVN_SCHEME

public static final java.lang.String MVN_SCHEME


NAMED_PROPERTY_FILES

public static final MapConfigKey NAMED_PROPERTY_FILES


RMI_PORT

public static final PortAttributeSensorAndConfigKey RMI_PORT


RMI_REGISTRY_PORT

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


RMI_SERVER_PORT

public static final PortAttributeSensorAndConfigKey RMI_SERVER_PORT = RMI_REGISTRY_PORT;
    /* @deprecated since 0.4 use RMI_REGISTRY_PORT */
@Deprecated
public static final PortAttributeSensorAndConfigKey RMI_SERVER_PORT


SUGGESTED_VERSION

public static final ConfigKey SUGGESTED_VERSION = ConfigKeys.newConfigKeyWithDefault(
public static final ConfigKey SUGGESTED_VERSION


UNINSTALL_BUNDLE

public static final MethodEffector UNINSTALL_BUNDLE


UPDATE_SERVICE_PROPERTIES

public static final MethodEffector UPDATE_SERVICE_PROPERTIES


WRAP_SCHEME

public static final java.lang.String WRAP_SCHEME


 
Method Detail

installBundle

@EffectorParam(name="bundle", description="URI of bundle to be deployed") String bundle) throws URISyntaxException;
public long installBundle(r(description="Undeploys the bundle with the given id") java.lang.String bundle)
throws URISyntaxException If bundle name is not a valid URI


installFeature

@EffectorParam(name="featureName", description="Name of the feature - see org.apache.karaf:type=features#installFeature()") final String featureName)
public void installFeature( java.lang.String featureName)


listBundles

public java.util.Map listBundles()


uninstallBundle

@EffectorParam(name="bundleId", description="Id of the bundle") Long bundleId);
}
public void uninstallBundle( java.lang.Long bundleId)


updateServiceProperties

@EffectorParam(name="serviceName", description="Name of the OSGi service") String serviceName,
public void updateServiceProperties( java.lang.String serviceName, java.util.Map additionalVals)


 

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