org.eclipse.hudson.WebAppController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2011 Sonatype, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *
 *  Jason Dillon 
 *
 *******************************************************************************/ 

package org.eclipse.hudson;

import javax.servlet.ServletContext;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Handles management of the Stapler root "app" object.
 *
 * @author Jason Dillon
 * @since 2.1.0
 */
public class WebAppController {

    private static final Logger log = Logger.getLogger(WebAppController.class.getName());
    private static final String APP = "app";
    private InstallStrategy installStrategy;
    private ServletContext context;

    // Sync everything, this class should not be used often, and needs to ensure consistent state
    public synchronized ServletContext getContext() {
        if (context == null) {
            throw new IllegalStateException();
        }
        return context;
    }

    public synchronized void setContext(final ServletContext context) {
        if (context == null) {
            throw new NullPointerException();
        }
        if (this.context != null) {
            throw new IllegalStateException();
        }
        if (log.isLoggable(Level.FINE)) {
            log.fine("Context initialized: " + context);
        }
        this.context = context;
    }

    public synchronized InstallStrategy getInstallStrategy() {
        return installStrategy;
    }

    public synchronized void setInstallStrategy(final InstallStrategy strategy) {
        if (strategy == null) {
            throw new NullPointerException();
        }
        if (this.installStrategy != null) {
            throw new IllegalStateException();
        }
        if (log.isLoggable(Level.FINE)) {
            log.fine("Strategy initialized: " + strategy);
        }
        this.installStrategy = strategy;
    }

    public synchronized void install(final Object app) {
        if (app == null) {
            throw new NullPointerException();
        }

        if (log.isLoggable(Level.FINE)) {
            log.fine("Attempting to install app: " + app);
        }
        if (getInstallStrategy().isAllowed(app)) {
            getContext().setAttribute(APP, app);
        } else {
            log.warning("Strategy denied install");
        }
    }

    public synchronized Object current() {
        return getContext().getAttribute(APP);
    }

    /**
     * Strategy to control which object is installed.
     */
    public static interface InstallStrategy {

        boolean isAllowed(Object app);
    }

    /**
     * Always install the given object.
     */
    public static class DefaultInstallStrategy
            implements InstallStrategy {

        @Override
        public boolean isAllowed(final Object app) {
            return true;
        }
    }
    //
    // Instance access (since there is no DI setup at this point).
    //
    private static final WebAppController INSTANCE = new WebAppController();

    public static WebAppController get() {
        return INSTANCE;
    }
}