All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jakarta.enterprise.inject.spi.ProcessBeanAttributes Maven / Gradle / Ivy

There is a newer version: 11.0.0-M4
Show newest version
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, 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 jakarta.enterprise.inject.spi;

import jakarta.enterprise.inject.New;
import jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator;

/**
 * 

* The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before * registering the {@link Bean} object. *

*

* No event is fired for {@link New} qualified beans. *

*

* Any observer of this event is permitted to wrap and/or replace the {@link BeanAttributes} by calling either {@link #setBeanAttributes(BeanAttributes)} or {@link #configureBeanAttributes()}. * If both methods are called within an observer notification an {@link IllegalStateException} is thrown. * The container must use the final value of this property, after all observers have been called, to manage instances of the bean. *

*

* If any observer method of a {@code ProcessBeanAttributes} event throws an exception, the exception is treated as a definition * error by the container. *

* * @author Pete Muir * @author Antoine Sabot-Durand * @param The class of the bean * @since 1.1 */ public interface ProcessBeanAttributes { /** * @return the {@link AnnotatedType} representing the managed bean class or session bean class, the {@link AnnotatedMethod} * representing the producer field, or the {@link AnnotatedField} representing the producer field * @throws IllegalStateException if called outside of the observer method invocation */ public Annotated getAnnotated(); /** * @return the {@link BeanAttributes} object that will be used by the container to manage instances of the bean * @throws IllegalStateException if called outside of the observer method invocation */ public BeanAttributes getBeanAttributes(); /** * Replaces the {@link BeanAttributes}. * * @param beanAttributes the new {@link BeanAttributes} to use * @throws IllegalStateException if called outside of the observer method invocation */ public void setBeanAttributes(BeanAttributes beanAttributes); /** * returns a {@link BeanAttributesConfigurator} initialized with the {@link BeanAttributes} processed by this event * to configure a new BeanAttributes that will replace the original one at the end of the observer invocation. * * Each call returns the same BeanAttributesConfigurator. * * @return a non reusable {@link BeanAttributesConfigurator} to configure the replacing BeanAttributes * @throws IllegalStateException if called outside of the observer method invocation * @since 2.0 */ public BeanAttributesConfigurator configureBeanAttributes(); /** * Registers a definition error with the container, causing the container to abort deployment after bean discovery is * complete. * * @param t the error to add * @throws IllegalStateException if called outside of the observer method invocation */ public void addDefinitionError(Throwable t); /** * Forces the container to ignore the bean. * @throws IllegalStateException if called outside of the observer method invocation */ public void veto(); /** *

Instructs the container to ignore all non-static, final methods with public, protected or default visibility * declared on any bean type of the specific bean during validation of injection points that require proxyable bean type.

* *

These method should never be invoked upon bean instances. Otherwise, unpredictable behavior results.

* * * @throws IllegalStateException if called outside of the observer method invocation * @since 2.0 */ public void ignoreFinalMethods(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy