org.apache.deltaspike.jpa.api.transaction.TransactionScoped Maven / Gradle / Ivy
/*
* 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.jpa.api.transaction;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.enterprise.context.NormalScope;
/**
* A @TransactionScoped contextual instance will be unique for a given
* transaction controlled by {@link Transactional}. The context will get started when the outermost
* {@link Transactional} method gets invoked and will get closed when
* the call chain leaves the outermost {@link Transactional} method.
*
* The classic use-case is for producing JPA EntityManagers.
*
* @Dependent
* public class EntityManagerProducer
* {
* private @PersistenceContext(unitName = "test") EntityManager entityManager;
*
* public @Produces @TransactionScoped EntityManager createEntityManager()
* {
* return entityManager;
* }
*
* public void closeEntityManager(@Disposes EntityManager em)
* {
* if (em.isOpen()) //this check is optional -not needed if #close doesn't get called by the transactional bean
* {
* em.close();
* }
* }
* }
*
*
* or
*
*
* @Dependent
* public class EntityManagerProducer
* {
* private @PersistenceUnit(unitName = "test") EntityManagerFactory entityManagerFactory;
*
* public @Produces @TransactionScoped EntityManager createEntityManager()
* {
* return entityManagerFactory.createEntityManager();
* }
*
* public void closeEntityManager(@Disposes EntityManager em)
* {
* if (em.isOpen()) //this check is optional -not needed if #close doesn't get called by the transactional bean
* {
* em.close();
* }
* }
* }
*
*
*
*
* Furthermore, it's possible to use different persistence-units with (simple) qualifiers
* (for the producer- and dispose-methods and therefore also at the injection-points).
*
*
*
* It's also possible to use @Transactional and @TransactionScoped in an application-server.
* Therefore it's only needed to configure one of the
* {@link org.apache.deltaspike.jpa.spi.transaction.TransactionStrategy}s which support JTA.
*
*
* @see Transactional
*/
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@NormalScope(passivating = false)
public @interface TransactionScoped
{
}