You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2011/12/28 09:59:13 UTC
[1/2] git commit: DELTASPIKE-21 add dynamic ProjectStage
Updated Branches:
refs/heads/master 0c1a76b89 -> a70177a7e
DELTASPIKE-21 add dynamic ProjectStage
Project: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/commit/a70177a7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/tree/a70177a7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/diff/a70177a7
Branch: refs/heads/master
Commit: a70177a7e6046fcb4768dd51e71f9c7f4d6624c2
Parents: b0c9571
Author: Mark Struberg <st...@apache.org>
Authored: Wed Dec 28 09:56:43 2011 +0100
Committer: Mark Struberg <st...@apache.org>
Committed: Wed Dec 28 09:56:43 2011 +0100
----------------------------------------------------------------------
.../core/api/projectstage/ProjectStage.java | 277 +++++++++++++++
.../core/api/projectstage/ProjectStageHolder.java | 28 ++
2 files changed, 305 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/a70177a7/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStage.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStage.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStage.java
new file mode 100644
index 0000000..85bae53
--- /dev/null
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStage.java
@@ -0,0 +1,277 @@
+/*
+ * 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.deltaspike.core.api.projectstage;
+
+
+import javax.enterprise.inject.Typed;
+import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.ServiceLoader;
+import java.util.logging.Logger;
+
+/**
+ * <p>This class is the base of all ProjectStages. A ProjectStage
+ * identifies the environment the application currently runs in.
+ * It provides the same functionality as the JSF-2 ProjectStage
+ * but has a few additional benefits:
+ * <ul>
+ * <li>it also works for JSF-1.0, JSF-1.1 and JSF-1.2 applications</li>
+ * <li>it also works in pure backends and unit tests without any faces-api</li>
+ * <li>it is dynamic. Everyone can add own ProjectStages!</p>
+ * </ul>
+ * </p>
+ *
+ * <p>Technically this is kind of a 'dynamic enum'.</p>
+ * <p>The following ProjectStages are provided by default</p>
+ * <ul>
+ * <li>UnitTest</li>
+ * <li>Development</li>
+ * <li>SystemTest</li>
+ * <li>IntegrationTest</li>
+ * <li>Staging</li>
+ * <li>Production</li>
+ * </ul>
+ *
+ * <p>The following resolution mechanism is used to determine the current ProjectStage:
+ * <ul>
+ * <li>TODO specify!</li>
+ * </ul>
+ * </p>
+ *
+ * <p>Adding a new ProjectStage is done via the
+ * {@link java.util.ServiceLoader} mechanism. A class deriving from {@link ProjectStage}
+ * must be provided and used for creating a single static instance of it.
+ *
+ * <p>Custom ProjectStages can be implemented by writing anonymous ProjectStage
+ * members into a registered {@link ProjectStageHolder} as shown in the following
+ * sample:</p>
+ * <pre>
+ * package org.apache.myfaces.extensions.cdi.test.api.projectstage;
+ * public class MyProjectStages implements ProjectStageHolder {
+ * public static final class MyOwnProjectStage extends ProjectStage {};
+ * public static final MyOwnProjectStage MyOwnProjectStage = new MyOwnProjectStage();
+ *
+ * public static final class MyOtherProjectStage extends ProjectStage {};
+ * public static final MyOtherProjectStage MyOtherProjectStage = new MyOtherProjectStage();
+ * }
+ * </pre>
+ * <p>For activating those projectstages, you have to register this ProjectStageHolder class
+ * to get picked up via the java.util.ServiceLoader mechanism. Simply create a file
+ * <pre>
+ * META-INF/services/org.apache.myfaces.extensions.cdi.core.api.projectstage.ProjectStageHolder
+ * </pre>
+ * which contains the fully qualified class name of custom ProjectStageHolder implementation:
+ * <pre>
+ * # this class now gets picked up by java.util.ServiceLoader
+ * org.apache.myfaces.extensions.cdi.core.test.api.projectstage.MyProjectStages
+ * </pre>
+ * </p>
+ * <p>You can use your own ProjectStages exactly the same way as all the ones provided
+ * by the system:
+ * <pre>
+ * ProjectStage myOwnPs = ProjectStage.valueOf("MyOwnProjectStage");
+ if (myOwnPs.equals(MyOwnProjectStage.MyOwnProjectStage)) ...
+ * </pre>
+ *
+ */
+@Typed()
+public abstract class ProjectStage implements Serializable
+{
+ private static final long serialVersionUID = -1210639662598734888L;
+
+ /**
+ * This map contains a static map with all registered projectStages.
+ *
+ * We don't need to use a ConcurrentHashMap because writing to it will
+ * only be performed in the static initializer block which is guaranteed
+ * to be atomic by the VM spec.
+ */
+ private static Map<String, ProjectStage> projectStages = new HashMap<String, ProjectStage>();
+
+ /**
+ * All the registered ProjectStage values.
+ * We don't need to make this volatile because of the classloader guarantees of
+ * the VM.
+ */
+ private static ProjectStage[] values = null;
+
+ /**
+ * logger for the ProjectStage
+ */
+ private static final Logger LOG = Logger.getLogger(ProjectStage.class.getName());
+
+
+ /**
+ * The static initializer block will register all custom ProjectStages
+ * by simply touching their classes due loding it with the
+ * {@link java.util.ServiceLoader}.
+ */
+ static
+ {
+ ServiceLoader<ProjectStageHolder> projectStageHolders = ServiceLoader.load(ProjectStageHolder.class);
+ for (ProjectStageHolder projectStageHolder : projectStageHolders)
+ {
+ LOG.fine("registering ProjectStages from ProjectStageHolder " + projectStageHolder.getClass().getName());
+ }
+ }
+
+
+ /** the name of the ProjectStage*/
+ private String psName;
+
+ /**
+ * The protected constructor will register the given ProjectStage via its name.
+ * The name is returned by the {@link #toString()} method of the ProjectStage.
+ */
+ protected ProjectStage()
+ {
+ String projectStageClassName = this.getClass().getSimpleName();
+ psName = projectStageClassName;
+
+ if (!projectStages.containsKey(projectStageClassName))
+ {
+ projectStages.put(projectStageClassName, this);
+ }
+ else
+ {
+ throw new IllegalArgumentException("ProjectStage with name " + projectStageClassName + " already exists!");
+ }
+
+ // we cannot do this in the static block since it's not really deterministic
+ // when all ProjectStages got resolved.
+ values = projectStages.values().toArray(new ProjectStage[ projectStages.size() ]);
+ }
+
+ /**
+ * @param projectStageClassName the name of the ProjectStage
+ * @return the ProjectStage which is identified by it's name
+ */
+ public static ProjectStage valueOf(String projectStageClassName)
+ {
+ return projectStages.get(projectStageClassName);
+ }
+
+ /**
+ * Exposes all registered {@link ProjectStage} implementations
+ * @return provided and custom project-stage implementations
+ */
+ public static ProjectStage[] values()
+ {
+ return values;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String toString()
+ {
+ return psName;
+ }
+
+ // CHECKSTYLE:OFF
+
+ /**
+ * Project-stage for unit-tests
+ */
+ @Typed()
+ public static final class UnitTest extends ProjectStage
+ {
+ private static final long serialVersionUID = -7910349894182034559L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final UnitTest UnitTest = new UnitTest();
+
+ /**
+ * Project-stage for development
+ */
+ @Typed()
+ public static final class Development extends ProjectStage
+ {
+ private static final long serialVersionUID = 1977308277341527250L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final Development Development = new Development();
+
+ /**
+ * Project-stage for system-tests
+ */
+ @Typed()
+ public static final class SystemTest extends ProjectStage
+ {
+ private static final long serialVersionUID = -7444003351466372539L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final SystemTest SystemTest = new SystemTest();
+
+ /**
+ * Project-stage for integration-tests
+ */
+ @Typed()
+ public static final class IntegrationTest extends ProjectStage
+ {
+ private static final long serialVersionUID = 2034474361615347127L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final IntegrationTest IntegrationTest = new IntegrationTest();
+
+ /**
+ * Project-stage for staging
+ */
+ @Typed()
+ public static final class Staging extends ProjectStage
+ {
+ private static final long serialVersionUID = -8426149532860809553L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final Staging Staging = new Staging();
+
+ /**
+ * Default project-stage for production
+ */
+ @Typed()
+ public static final class Production extends ProjectStage
+ {
+ private static final long serialVersionUID = -4030601958667812084L;
+ }
+
+ /**
+ * Type-safe {@link ProjectStage}
+ */
+ public static final Production Production = new Production();
+
+ // CHECKSTYLE:ON
+
+}
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/a70177a7/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
new file mode 100644
index 0000000..9435acf
--- /dev/null
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
@@ -0,0 +1,28 @@
+/*
+ * 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.deltaspike.core.api.projectstage;
+
+/**
+ * This is a marker interface for custom project
+ * stage holders. A project stage holder is a class which
+ * contains 1 or many {@link ProjectStage}s.
+ */
+public interface ProjectStageHolder
+{
+}