/*
* 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.myfaces.extensions.cdi.core.impl.projectstage;
import org.apache.myfaces.extensions.cdi.core.api.Aggregatable;
import org.apache.myfaces.extensions.cdi.core.api.projectstage.ProjectStage;
import org.apache.myfaces.extensions.cdi.core.api.projectstage.TestStage;
import org.apache.myfaces.extensions.cdi.core.api.provider.BeanManagerProvider;
import org.apache.myfaces.extensions.cdi.core.impl.util.CodiUtils;
import javax.enterprise.context.Dependent;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Default;
import javax.enterprise.inject.Produces;
import java.io.Serializable;
import java.util.logging.Logger;
/**
* <p>Produces {@link ProjectStage} configurations.</p>
*
* <p>The producer will try to detect the currently active ProjectStage on startup
* and use that for all generated fields.</p>
* <p>In case a JSF runtime is not available (e.g. in unit tests) we do all the
* determining ourself (but in the same way as MyFaces does it!)</p>
*
* <p>Usage:</p>
* Simply inject the current ProjectStage into any bean:
* <pre>
* public class MyBean {
* private @Inject ProjectStage projectStage;
*
* public void fn() {
* if(projectStage == ProjectStage.Production) {
* // do some prodution stuff...
* }
* }
* }
* </pre>
*
*/
@ApplicationScoped
public class ProjectStageProducer implements Serializable
{
private static final long serialVersionUID = -2987762608635612074L;
protected static final Logger LOG = Logger.getLogger(ProjectStageProducer.class.getName());
/**
* ProjectStageProducers must only be created by subclassing producers
*/
protected ProjectStageProducer()
{
}
/**
* The detected ProjectStage
*/
private static ProjectStage projectStage;
/**
* for the singleton factory
*/
private static volatile ProjectStageProducer projectStageProducer;
/**
* We can only produce @Dependent scopes since an enum is final.
* @return current ProjectStage
*/
@Produces
@Dependent
@Default
public ProjectStage getProjectStage()
{
if(projectStage == null)
{
//triggers initialization
getInstance();
}
return projectStage;
}
//just for testing
protected void reset()
{
projectStage = null;
projectStageProducer = null;
}
/**
* <p>This factory method should only get used if there is absolutly no way
* to get the current {@link ProjectStage} via @Inject.</p>
*
* <p></p>
*
* @return the ProjectStageProducer instance.
*/
public static ProjectStageProducer getInstance()
{
if (projectStageProducer == null)
{
lazyInit();
}
if(projectStage == null)
{
projectStageProducer.initProjectStage();
}
return projectStageProducer;
}
private static synchronized void lazyInit()
{
// switch into paranoia mode
if (projectStageProducer != null)
{
return;
}
ProjectStageProducer defaultProjectStageProducer = new ProjectStageProducer();
projectStageProducer = CodiUtils.lookupFromEnvironment(ProjectStageProducer.class,
new Aggregatable<ProjectStageProducer>()
{
private ProjectStageProducer specializedCodiProjectStageProducer;
private ProjectStageProducer customConfiguredProjectStageProducer;
/**
* {@inheritDoc}
*/
public void add(ProjectStageProducer projectStageProducer)
{
if(projectStageProducer.getClass().getName().startsWith("org.apache.myfaces."))
{
specializedCodiProjectStageProducer = projectStageProducer;
}
else
{
customConfiguredProjectStageProducer = projectStageProducer;
}
}
/**
* {@inheritDoc}
*/
public ProjectStageProducer create()
{
if(customConfiguredProjectStageProducer != null)
{
return this.customConfiguredProjectStageProducer;
}
if(specializedCodiProjectStageProducer != null)
{
return this.specializedCodiProjectStageProducer;
}
return null;
}
}, defaultProjectStageProducer);
if (projectStageProducer == null)
{
// if we still didn't find a customised ProjectStageProducer,
// then we take the default one.
projectStageProducer = defaultProjectStageProducer;
}
projectStageProducer.initProjectStage();
}
/**
* This function can be used to manually set the ProjectStage for the application.
* This is e.g. useful in unit tests.
* @param ps the ProjectStage to set
*/
public static void setProjectStage(ProjectStage ps)
{
projectStage = ps;
}
/**
* Resolves the project-stage configured for codi
* @return the resolved {@link ProjectStage} or <code>null</code> if none defined.
*/
protected ProjectStage resolveProjectStage()
{
String stageName = CodiUtils.lookupFromEnvironment("ProjectStage", String.class);
if (stageName != null)
{
return ProjectStage.valueOf(stageName);
}
return null;
}
protected void initProjectStage()
{
// switch into paranoia mode
synchronized (ProjectStageProducer.class)
{
if(projectStage == null)
{
projectStage = resolveProjectStage();
if(projectStage == null)
{
projectStage = ProjectStage.Production;
}
if (TestStage.class.isAssignableFrom(projectStage.getClass()))
{
new BeanManagerProvider()
{
@Override
public void setTestMode()
{
super.setTestMode();
}
}.setTestMode();
}
LOG.info("Computed the following CODI ProjectStage: " + projectStage);
}
}
}
}