javax.faces.application.ProjectStage Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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.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 javax.faces.application;
/**
* This class enables a feature similar to
* the RAILS_ENV
feature of the Ruby on Rails web
* framework. The constants in this class represent the current state
* of the running application in a typical product development
* lifecycle. The value of this state may be queried at any time after
* application startup by calling {@link
* Application#getProjectStage}.
* @since 2.0
*/
public enum ProjectStage {
/**
*
* This value indicates the currently running application is right
* now, at this moment, being developed. This value will usually be
* set during iterative development.
*/
Development,
/**
*
* This value indicates the currently running application is
* undergoing unit testing.
*
*/
UnitTest,
/**
*
* This value indicates the currently running application is
* undergoing system testing.
*
*/
SystemTest,
/**
*
* This value indicates the currently running application is
* deployed in production.
*
*/
Production;
/**
*
* The value of this constant is the value of the
* param-name
for setting the current value to be
* returned by {@link Application#getProjectStage}.
*
*/
public static final String PROJECT_STAGE_PARAM_NAME =
"javax.faces.PROJECT_STAGE";
/**
*
* The value of this constant is the name used for JNDI lookups
* for setting the current value to be returned by
* {@link Application#getProjectStage}.
*
*/
public static final String PROJECT_STAGE_JNDI_NAME =
"java:comp/env/jsf/ProjectStage";
}