/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual
* contributors by the @authors tag. See the copyright.txt in the
* distribution for a full listing of individual contributors.
*
* Licensed 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.jboss.weld.environment.se;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.enterprise.context.BeforeDestroyed;
import javax.enterprise.context.Destroyed;
import javax.enterprise.context.Initialized;
import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.event.Event;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.Vetoed;
import javax.enterprise.inject.se.SeContainer;
import javax.enterprise.inject.spi.BeanManager;
import org.jboss.weld.AbstractCDI;
import org.jboss.weld.Container;
import org.jboss.weld.ContainerState;
import org.jboss.weld.bean.builtin.BeanManagerProxy;
import org.jboss.weld.bootstrap.api.Bootstrap;
import org.jboss.weld.bootstrap.api.Singleton;
import org.jboss.weld.bootstrap.api.SingletonProvider;
import org.jboss.weld.bootstrap.spi.BeanDeploymentArchive;
import org.jboss.weld.bootstrap.spi.Deployment;
import org.jboss.weld.environment.ContainerInstance;
import org.jboss.weld.environment.deployment.WeldDeployment;
import org.jboss.weld.environment.se.events.ContainerBeforeShutdown;
import org.jboss.weld.environment.se.events.ContainerInitialized;
import org.jboss.weld.environment.se.events.ContainerShutdown;
import org.jboss.weld.environment.se.logging.WeldSELogger;
import org.jboss.weld.inject.WeldInstance;
import org.jboss.weld.manager.BeanManagerImpl;
import org.jboss.weld.util.collections.ImmutableList;
/**
* Represents a Weld SE container.
*
* <p>
* An new instance can be initialized using the Weld builder:
* </p>
*
* <pre>
* WeldContainer container = new Weld().initialize();
* </pre>
*
* <p>
* It's also possible to obtain the instance of a running container by id:
* </p>
*
* <pre>
* WeldContainer container = WeldContainer.instance("myCustomId");
* </pre>
*
* <p>
* {@link #shutdown()} must be always called to shutdown the container properly. AutoCloseable is implemented, so the container is automatically shut down when
* leaving the try-with-resources block:
* </p>
*
* <pre>
* try (WeldContainer container = new Weld().initialize()) {
* container.select(Foo.class).get();
* }
* </pre>
*
* <p>
* The container is also registered as a {@link javax.inject.Singleton} bean.
* </p>
*
* <p>
* Provides convenient access to beans, BeanManager and events, which is particularly helpful when bootstrapping an application in Java SE:
* </p>
*
* <pre>
* Foo foo = container.select(Foo.class).get();
* container.getBeanManager().fireEvent(new Bar())
* container.event().select(Bar.class).fire(new Bar());
* </pre>
*
* @author Peter Royle
* @author Martin Kouba
* @see Weld
*/
@Vetoed
public class WeldContainer extends AbstractCDI<Object> implements AutoCloseable, ContainerInstance, SeContainer {
private static final Singleton<WeldContainer> SINGLETON;
private static final List<String> RUNNING_CONTAINER_IDS;
private static final Object LOCK = new Object();
private static volatile ShutdownHook shutdownHook;
static {
SINGLETON = SingletonProvider.instance().create(WeldContainer.class);
RUNNING_CONTAINER_IDS = new CopyOnWriteArrayList<String>();
}
/**
* @param id
* @return the running container with the specified identifier or <code>null</code> if no such container exists
*/
public static WeldContainer instance(String id) {
try {
return SINGLETON.get(id);
} catch (IllegalStateException e) {
return null;
}
}
/**
*
* @return an immutable list of ids of running containers
*/
public static List<String> getRunningContainerIds() {
return ImmutableList.copyOf(RUNNING_CONTAINER_IDS);
}
/**
* Start the initialization.
*
* @param id
* @param manager
* @param bootstrap
* @return the initialized Weld container
*/
static WeldContainer startInitialization(String id, Deployment deployment, Bootstrap bootstrap) {
if (SINGLETON.isSet(id)) {
throw WeldSELogger.LOG.weldContainerAlreadyRunning(id);
}
WeldContainer weldContainer = new WeldContainer(id, deployment, bootstrap);
SINGLETON.set(id, weldContainer);
RUNNING_CONTAINER_IDS.add(id);
return weldContainer;
}
/**
* Finish the initialization.
*
* @param container
* @param isShutdownHookEnabled
*/
static void endInitialization(WeldContainer container, boolean isShutdownHookEnabled) {
container.complete();
// If needed, register one shutdown hook for all containers
if (shutdownHook == null && isShutdownHookEnabled) {
synchronized (LOCK) {
if (shutdownHook == null) {
shutdownHook = new ShutdownHook();
Runtime.getRuntime().addShutdownHook(shutdownHook);
}
}
}
container.fireContainerInitializedEvent();
}
/**
*
* @param containerId
*/
static void discard(String containerId) {
SINGLETON.clear(containerId);
RUNNING_CONTAINER_IDS.remove(containerId);
}
// This replicates org.jboss.weld.Container.contextId
private final String id;
private final Deployment deployment;
private final Bootstrap bootstrap;
private volatile WeldInstance<Object> instance;
private volatile Event<Object> event;
private volatile CreationalContext<?> creationalContext;
private volatile BeanManagerImpl beanManager;
/**
*
* @param id
* @param deployment
* @param bootstrap
*/
private WeldContainer(String id, Deployment deployment, Bootstrap bootstrap) {
super();
this.id = id;
this.deployment = deployment;
this.bootstrap = bootstrap;
}
private void complete() {
// Make sure the volatile fields are initialized
getInstance();
event();
}
private void fireContainerInitializedEvent() {
WeldSELogger.LOG.weldContainerInitialized(id);
beanManager().fireEvent(new ContainerInitialized(id), Initialized.Literal.APPLICATION);
}
/**
* Provides access to all beans within the application. Retained for backward compatibility - WeldContainer implements
* {@link javax.enterprise.inject.Instance}.
*
* @return the instance
* @deprecated Applications are encouraged to use methods for programmatic lookup directly.
*/
public Instance<Object> instance() {
checkState();
return getInstance();
}
/**
* Provides access to all events within the application. For example:
*
* <code>
* weldContainer.event().select(Bar.class).fire(new Bar());
* </code>
*
* @return the event
*/
public Event<Object> event() {
checkIsRunning();
if (event == null) {
synchronized (this) {
if (event == null) {
event = beanManager().event();
}
}
}
return event;
}
/**
* Weld containers must have a unique identifier assigned when there are multiple Weld instances running at once.
*
* @return the container id
*/
public String getId() {
return id;
}
/**
* Provides direct access to the BeanManager.
*/
public BeanManager getBeanManager() {
checkIsRunning();
return new BeanManagerProxy(beanManager());
}
/**
* Shutdown the container.
*
* @see Weld#initialize()
*/
public synchronized void shutdown() {
checkIsRunning();
try {
beanManager().fireEvent(new ContainerBeforeShutdown(id), BeforeDestroyed.Literal.APPLICATION);
} finally {
discard(id);
// Destroy all the dependent beans correctly
creationalContext.release();
beanManager().fireEvent(new ContainerShutdown(id), Destroyed.Literal.APPLICATION);
bootstrap.shutdown();
WeldSELogger.LOG.weldContainerShutdown(id);
}
}
/**
*
* @return <code>true</code> if the container was initialized completely and is not shut down yet, <code>false</code> otherwise
*/
public boolean isRunning() {
return SINGLETON.isSet(id) && instance != null;
}
@Override
public void close() {
shutdown();
}
@Override
protected WeldInstance<Object> getInstance() {
if (instance == null) {
synchronized (this) {
if (instance == null) {
creationalContext = beanManager().createCreationalContext(null);
instance = beanManager().getInstance(creationalContext);
}
}
}
return instance;
}
/**
* Shuts down all running containers.
*/
static class ShutdownHook extends Thread {
@Override
public void run() {
for (String id : getRunningContainerIds()) {
WeldContainer container = instance(id);
if (container != null) {
container.shutdown();
// At this time the logger service may not be available - print some basic info to the standard output
System.out.println(String.format("Weld SE container %s shut down by shutdown hook", id));
}
}
}
}
@Override
protected void checkState() {
checkDeploymentValidated();
checkIsRunning();
}
private void checkDeploymentValidated() {
ContainerState state = Container.instance(id).getState();
if (state.compareTo(ContainerState.VALIDATED) < 0) {
throw WeldSELogger.LOG.weldContainerDeploymentNotValidated(id);
}
}
private void checkIsRunning() {
if (!SINGLETON.isSet(id)) {
if (WeldSELogger.LOG.isTraceEnabled()) {
WeldSELogger.LOG.tracev("Spurious call to shutdown from: {0}", (Object[]) Thread.currentThread().getStackTrace());
}
throw WeldSELogger.LOG.weldContainerAlreadyShutDown(id);
}
}
private BeanManagerImpl beanManager() {
if (beanManager == null) {
synchronized (this) {
if (beanManager == null) {
beanManager = BeanManagerProxy.unwrap(bootstrap.getManager(getDeterminingBeanDeploymentArchive(deployment)));
}
}
}
return beanManager;
}
private BeanDeploymentArchive getDeterminingBeanDeploymentArchive(Deployment deployment) {
Collection<BeanDeploymentArchive> beanDeploymentArchives = deployment.getBeanDeploymentArchives();
if (beanDeploymentArchives.size() == 1) {
// Only one bean archive or isolation is disabled
return beanDeploymentArchives.iterator().next();
}
for (BeanDeploymentArchive beanDeploymentArchive : beanDeploymentArchives) {
if (WeldDeployment.SYNTHETIC_BDA_ID.equals(beanDeploymentArchive.getId())) {
// Synthetic bean archive takes precedence
return beanDeploymentArchive;
}
}
for (BeanDeploymentArchive beanDeploymentArchive : beanDeploymentArchives) {
if (!WeldDeployment.ADDITIONAL_BDA_ID.equals(beanDeploymentArchive.getId())) {
// Get the first non-additional bean deployment archive
return beanDeploymentArchive;
}
}
return deployment.loadBeanDeploymentArchive(WeldContainer.class);
}
}