org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes Maven / Gradle / Ivy

Go to download
/*
 * 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.launcher.config;

import java.io.File;
import java.util.concurrent.atomic.AtomicBoolean;

import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.BasicConfigKey;
import org.apache.brooklyn.util.os.Os;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Deprecated /** @deprecated since 0.7.0; see BrooklynVersion;
* and anyway this was not really used, and if it were, it would be needed in core; autodetection is pretty good */
public class BrooklynDevelopmentModes {

    private static final Logger log = LoggerFactory.getLogger(BrooklynDevelopmentModes.class);
    
    public static final ConfigKey BROOKLYN_DEV_MODE = new BasicConfigKey(
            BrooklynDevelopmentMode.class, "brooklyn.developmentMode", "whether to run in development mode " +
                    "(default is to autodetect based on classpath)", BrooklynDevelopmentMode.AUTO);

    private static AtomicBoolean loggedMode = new AtomicBoolean(false); 
    
    public static enum BrooklynDevelopmentMode {
        TRUE(true), FALSE(false), AUTO(null);

        private final Boolean enabled;
        
        BrooklynDevelopmentMode(Boolean enabled) {
            this.enabled = enabled;
        }
        
        public boolean isEnabled() {
            boolean enabled = computeEnabled();
            if (!loggedMode.getAndSet(true)) {
                // log on first invocation
                String reason = (this.enabled==null ? "autodetected" : "forced");
                if (enabled) {
                    log.info("Brooklyn running in development mode ("+reason+")");
                } else {
                    log.debug("Brooklyn not running in development mode ("+reason+")");
                }
            }
            return enabled;
        }
        
        protected boolean computeEnabled() {
            if (enabled!=null) return enabled;
            return getAutodectectedDevelopmentMode();
        }
    }
    
    private static Boolean developmentMode = null;
    
    public static boolean getAutodectectedDevelopmentMode() {
        if (developmentMode!=null) return developmentMode;
        developmentMode = computeAutodectectedDevelopmentMode();
        return developmentMode;
    }
    
    private static final String segment = "/core/target/classes";
    
    private static boolean computeAutodectectedDevelopmentMode() {
        String cp = System.getProperty("java.class.path");
        String platformSegment = Os.nativePath(segment);
        if (cp==null) return false;
        if (cp.endsWith(platformSegment) || cp.contains(platformSegment+File.pathSeparator)) {
            log.debug("Brooklyn developmentMode autodetected (based on presence of '"+segment+"' in classpath)");
            return true;
        }
        return false;
    }
    
}