Glassfish example source code file (ProcessEnvironment.java)

This example Glassfish source code file (ProcessEnvironment.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

acc, embedded, embedded, other, other, processenvironment, processenvironment, processtype, processtype, server, service

The Glassfish ProcessEnvironment.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.api.admin;

import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.annotations.Scoped;
import org.jvnet.hk2.component.Singleton;

/**
 * Process environment allow access to information related to the execution or process.
 * This is a bit tricky to rely of @Contract/@Service service lookup for this API since
 * different implementations (server, clients, etc..) can be present of the classpath.
 *
 * @author Jerome Dochez
 */
@Service
@Scoped(Singleton.class)
public class ProcessEnvironment {

    /**
     * Default initialization is unkown process environment
     */
    public ProcessEnvironment() {
        type = ProcessType.Other;
    }

    /**
     * Enumeration of the supported process types
     * Server is the application server
     * ACC is the application client
     * Other is a standalone java.
     */
    public enum ProcessType { Server, ACC, Embedded, Other ; 

        public boolean isServer() {
            return this==Server || this==Embedded;
        }

        public boolean isStandaloneServer() {
            return this==Server;
        }

        public boolean isEmbedded() {
            return this==Embedded;
        }
    }

    /**
     * Determine and return the modes in which the code is behaving, 
     * like application server or application client modes.
     * @return the process type
     */
    public ProcessType getProcessType() {
        return type;
    }

    /**
     * Creates a process environemnt for the inten
     * @param type of the execution environemnt
     */
    public ProcessEnvironment(ProcessType type) {
        this.type = type;
    }

    final private ProcessType type;

}