org.hibernate.resource.beans.container.internal.ContainerManagedLifecycleStrategy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
There is a newer version: 7.0.0.Alpha1
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.resource.beans.container.internal;

import javax.enterprise.context.ContextNotActiveException;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.spi.BeanManager;

import org.hibernate.resource.beans.container.spi.BeanContainer;
import org.hibernate.resource.beans.container.spi.BeanLifecycleStrategy;
import org.hibernate.resource.beans.container.spi.ContainedBeanImplementor;
import org.hibernate.resource.beans.spi.BeanInstanceProducer;

import org.jboss.logging.Logger;

/**
 * A {@link BeanLifecycleStrategy} to use when CDI compliance is required
 * (i.e. when the bean lifecycle is to be managed by the CDI runtime, not the JPA runtime).
 *
 * The main characteristic of this strategy is that every create/destroy operation is delegated
 * to the CDI runtime.
 *
 * In particular, @Singleton-scoped or @ApplicationScoped beans are retrieved from the CDI context,
 * and are not duplicated, in contrast to {@link JpaCompliantLifecycleStrategy}.
 */
public class ContainerManagedLifecycleStrategy implements BeanLifecycleStrategy {
	private static final Logger log = Logger.getLogger( ContainerManagedLifecycleStrategy.class );

	public static final ContainerManagedLifecycleStrategy INSTANCE = new ContainerManagedLifecycleStrategy();

	private ContainerManagedLifecycleStrategy() {
		// private constructor, do not use
	}


	@Override
	public  ContainedBeanImplementor createBean(
			Class beanClass,
			BeanInstanceProducer fallbackProducer,
			BeanContainer beanContainer) {
		return new BeanImpl<>( beanClass, fallbackProducer, ( (CdiBasedBeanContainer) beanContainer ).getUsableBeanManager() );
	}

	@Override
	public  ContainedBeanImplementor createBean(
			String beanName,
			Class beanClass,
			BeanInstanceProducer fallbackProducer,
			BeanContainer beanContainer) {
		return new NamedBeanImpl<>( beanName, beanClass, fallbackProducer, ( (CdiBasedBeanContainer) beanContainer ).getUsableBeanManager() );
	}



	private static abstract class AbstractBeanImpl implements ContainedBeanImplementor {
		final Class beanType;

		BeanInstanceProducer fallbackProducer;
		BeanManager beanManager;

		Instance instance;
		B beanInstance;

		private AbstractBeanImpl(
				Class beanType,
				BeanInstanceProducer fallbackProducer,
				BeanManager beanManager) {
			this.beanType = beanType;
			this.fallbackProducer = fallbackProducer;
			this.beanManager = beanManager;
		}

		@Override
		public B getBeanInstance() {
			if ( beanInstance == null ) {
				initialize();
			}
			return beanInstance;
		}

		@Override
		public void initialize() {
			if ( beanInstance != null ) {
				return;
			}

			try {
				this.instance = resolveContainerInstance();
				this.beanInstance = this.instance.get();
			}
			catch (NotYetReadyException e) {
				throw e;
			}
			catch (Exception e) {
				log.debugf( "Error resolving CDI bean [%s] - using fallback" );
				this.beanInstance = produceFallbackInstance();
				this.instance = null;
			}

			this.beanManager = null;
		}

		protected abstract Instance resolveContainerInstance();

		@Override
		public void release() {
			if ( beanInstance == null ) {
				return;
			}

			try {
				if ( instance == null ) {
					// todo : BeanInstanceProducer#release?
					return;
				}

				instance.destroy( beanInstance );
			}
			catch (ContextNotActiveException e) {
				log.debugf(
						"Error destroying managed bean instance [%s] - the context is not active anymore."
								+ " The instance must have been destroyed already - ignoring.",
						instance,
						e
				);
			}
			finally {
				beanInstance = null;
				instance = null;
				beanManager = null;
				fallbackProducer = null;
			}
		}

		protected abstract B produceFallbackInstance();
	}

	private static class BeanImpl extends AbstractBeanImpl {
		private BeanImpl(
				Class beanType,
				BeanInstanceProducer fallbackProducer,
				BeanManager beanManager) {
			super( beanType, fallbackProducer, beanManager );
		}

		@Override
		@SuppressWarnings("unchecked")
		protected Instance resolveContainerInstance() {
			final Instance root;
			try {
				root = beanManager.createInstance();
			}
			catch (Exception e) {
				// this indicates that the BeanManager is not yet ready to use, which
				// should be consider an error
				throw new NotYetReadyException( e );
			}

			try {
				return root.select( beanType );
			}
			catch (Exception e) {
				throw new NoSuchBeanException( "Bean class not known to CDI : " + beanType.getName(), e );
			}
		}

		@Override
		protected B produceFallbackInstance() {
			return fallbackProducer.produceBeanInstance( beanType );
		}
	}

	private static class NamedBeanImpl extends AbstractBeanImpl {
		private final String beanName;

		private NamedBeanImpl(
				String beanName,
				Class beanType,
				BeanInstanceProducer fallbackProducer,
				BeanManager beanManager) {
			super( beanType, fallbackProducer, beanManager );
			this.beanName = beanName;
		}

		@Override
		@SuppressWarnings("unchecked")
		protected Instance resolveContainerInstance() {
			final Instance root;
			try {
				root = beanManager.createInstance();
			}
			catch (Exception e) {
				// this indicates that the BeanManager is not yet ready to use, which
				// should be consider an error
				throw new NotYetReadyException( e );
			}

			try {
				return root.select( beanType, new NamedBeanQualifier( beanName ) );
			}
			catch (Exception e) {
				throw new NoSuchBeanException( "Bean class not known to CDI : " + beanType.getName(), e );
			}
		}

		@Override
		protected B produceFallbackInstance() {
			return fallbackProducer.produceBeanInstance( beanName, beanType );
		}
	}
}