org.apache.brooklyn.entity.java.VanillaJavaApp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of brooklyn-software-base Show documentation
Base classes for Brooklyn software process entities
There is a newer version: 1.1.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.brooklyn.entity.java;

import java.util.List;
import java.util.Map;

import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.sensor.Sensors;
import org.apache.brooklyn.entity.software.base.SoftwareProcess;
import org.apache.brooklyn.util.collections.MutableList;
import org.apache.brooklyn.util.core.flags.SetFromFlag;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;

@ImplementedBy(VanillaJavaAppImpl.class)
public interface VanillaJavaApp extends SoftwareProcess, UsesJava, UsesJmx, UsesJavaMXBeans {

    // TODO Make jmxPollPeriod @SetFromFlag easier to use: currently a confusion over long and TimeDuration, and 
    // no ability to set default value (can't just set field because config vals read/set in super-constructor :-(

    @SetFromFlag("args")
    ConfigKey ARGS = ConfigKeys.newConfigKey(List.class,
            "vanillaJavaApp.args", "Arguments for launching the java app", Lists.newArrayList());
    
    @SetFromFlag(value="main", nullable=false)
    ConfigKey MAIN_CLASS = ConfigKeys.newStringConfigKey("vanillaJavaApp.mainClass", "class to launch");

    @SetFromFlag("classpath")
    ConfigKey CLASSPATH = ConfigKeys.newConfigKey(List.class,
            "vanillaJavaApp.classpath", "classpath to use, as list of URL entries; " +
            "these URLs are copied to lib/ and expanded in the case of tar/tgz/zip",
            Lists.newArrayList());

    AttributeSensor CLASSPATH_FILES = Sensors.newSensor(List.class,
            "vanillaJavaApp.classpathFiles", "classpath used, list of files");

    @SetFromFlag("jvmXArgs")
    ConfigKey JVM_XARGS = ConfigKeys.newConfigKey(List.class,
            "vanillaJavaApp.jvmXArgs", "JVM -X args for the java app (e.g. memory)", 
            MutableList.of("-Xms128m", "-Xmx512m", "-XX:MaxPermSize=512m"));

    @SetFromFlag("jvmDefines")
    ConfigKey JVM_DEFINES = ConfigKeys.newConfigKey(Map.class,
            "vanillaJavaApp.jvmDefines", "JVM system property definitions for the app",
            Maps.newLinkedHashMap());

    public String getMainClass();
    public List getClasspath();
    public List getClasspathFiles();
    public Map getJvmDefines();
    public List getJvmXArgs();
    public String getRunDir();

    public void kill();

}