org.jboss.weld.injection.spi.JpaInjectionServices Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weld-se Show documentation
There is a newer version: 3.0.0.Alpha1
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc., 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.injection.spi;

import javax.enterprise.inject.spi.InjectionPoint;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;

import org.jboss.weld.bootstrap.api.Service;

/**
 * A container should implement this interface to allow the Weld RI to resolve JPA persistence units and discover entities
 *
 * {@link JpaInjectionServices} is a per-module service.
 *
 * @author Pete Muir
 * @author Jozef Hartinger
 *
 */
public interface JpaInjectionServices extends Service {

    /**
     * Register a persistence context injection point. The implementation validates the injection point. If the validation
     * passes, an instance of {@link ResourceReferenceFactory} is returned which may be used at runtime for creating instances
     * of the resource.
     *
     * @param injectionPoint the injection point metadata
     * @return factory for obtaining {@link EntityManager} instances
     * @throws IllegalArgumentException if the injection point is not annotated with
     * @PersistenceContext, if the injection point is a method that doesn't follow JavaBean conventions or if the injection
     * @throws IllegalStateException if no suitable persistence units can be resolved
     */
    ResourceReferenceFactory registerPersistenceContextInjectionPoint(InjectionPoint injectionPoint);

    /**
     * Register a persistence unit injection point. The implementation validates the injection point. If the validation passes,
     * an instance of {@link ResourceReferenceFactory} is returned which may be used at runtime for creating instances of the
     * resource.
     *
     * @param injectionPoint the injection point metadata
     * @return factory for obtaining {@link EntityManagerFactory} instances
     * @throws IllegalArgumentException if the injection point is not annotated with
     * @PersistenceUnit, or, if the injection point is a method that doesn't follow JavaBean conventions
     * @throws IllegalStateException if no suitable persistence units can be resolved
     */
    ResourceReferenceFactory registerPersistenceUnitInjectionPoint(InjectionPoint injectionPoint);

    /**
     * Resolve the value for the given @PersistenceContext injection point
     *
     * @deprecated Instead of calling this method at runtime, Weld should register every persistence context injection point at
     *             bootstrap using {@link #registerPersistenceContextInjectionPoint(InjectionPoint)} and use the returned
     *             factory for producing injectable instances at runtime.
     *
     * @param injectionPoint the injection point metadata
     * @return an instance of the entity manager
     * @throws IllegalArgumentException if the injection point is not annotated with
     * @PersistenceContext, or, if the injection point is a method that doesn't follow JavaBean conventions
     * @throws IllegalStateException if no suitable persistence units can be resolved for injection
     */
    @Deprecated
    EntityManager resolvePersistenceContext(InjectionPoint injectionPoint);

    /**
     * Resolve the value for the given @PersistenceUnit injection point
     *
     * @deprecated Instead of calling this method at runtime, Weld should register every persistence unit injection point at
     *             bootstrap using {@link #registerPersistenceUnitInjectionPoint(InjectionPoint)} and use the returned factory
     *             for producing injectable instances at runtime.
     *
     * @param injectionPoint the injection point metadata
     * @return an instance of the entity manager
     * @throws IllegalArgumentException if the injection point is not annotated with
     * @PersistenceUnit, or, if the injection point is a method that doesn't follow JavaBean conventions
     * @throws IllegalStateException if no suitable persistence units can be resolved for injection
     */
    @Deprecated
    EntityManagerFactory resolvePersistenceUnit(InjectionPoint injectionPoint);

}