org.jboss.weld.bean.AbstractProducerBean Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weld-osgi-bundle Show documentation
Show all versions of weld-osgi-bundle Show documentation
Weld runtime packaged as an OSGi bundle
/*
* JBoss, Home of Professional Open Source
* Copyright 2008, 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.bean;
import static org.jboss.weld.logging.Category.BEAN;
import static org.jboss.weld.logging.LoggerFactory.loggerFactory;
import static org.jboss.weld.logging.messages.BeanMessage.NON_SERIALIZABLE_CONSTRUCTOR_PARAM_INJECTION_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.NON_SERIALIZABLE_FIELD_INJECTION_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.NON_SERIALIZABLE_INITIALIZER_PARAM_INJECTION_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.NON_SERIALIZABLE_PRODUCER_PARAM_INJECTION_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.NON_SERIALIZABLE_PRODUCT_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.NULL_NOT_ALLOWED_FROM_PRODUCER;
import static org.jboss.weld.logging.messages.BeanMessage.ONLY_ONE_SCOPE_ALLOWED;
import static org.jboss.weld.logging.messages.BeanMessage.PRODUCER_CAST_ERROR;
import static org.jboss.weld.logging.messages.BeanMessage.PRODUCER_METHOD_CANNOT_HAVE_A_WILDCARD_RETURN_TYPE;
import static org.jboss.weld.logging.messages.BeanMessage.PRODUCER_METHOD_WITH_TYPE_VARIABLE_RETURN_TYPE_MUST_BE_DEPENDENT;
import static org.jboss.weld.logging.messages.BeanMessage.RETURN_TYPE_MUST_BE_CONCRETE;
import static org.jboss.weld.logging.messages.BeanMessage.USING_DEFAULT_SCOPE;
import static org.jboss.weld.logging.messages.BeanMessage.USING_SCOPE;
import static org.jboss.weld.util.cache.LoadingCacheUtils.getCacheValue;
import static org.jboss.weld.util.reflection.Reflections.cast;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.lang.reflect.WildcardType;
import java.util.HashSet;
import java.util.Set;
import javax.enterprise.context.Dependent;
import javax.enterprise.context.NormalScope;
import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.Produces;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.enterprise.inject.spi.Producer;
import javax.inject.Inject;
import javax.inject.Scope;
import org.jboss.weld.Container;
import org.jboss.weld.bootstrap.BeanDeployerEnvironment;
import org.jboss.weld.bootstrap.api.ServiceRegistry;
import org.jboss.weld.exceptions.DefinitionException;
import org.jboss.weld.exceptions.IllegalProductException;
import org.jboss.weld.exceptions.WeldException;
import org.jboss.weld.injection.CurrentInjectionPoint;
import org.jboss.weld.introspector.WeldMember;
import org.jboss.weld.manager.BeanManagerImpl;
import org.jboss.weld.metadata.cache.MetaAnnotationStore;
import org.jboss.weld.util.Beans;
import org.jboss.weld.util.reflection.Reflections;
import org.slf4j.cal10n.LocLogger;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
/**
* The implicit producer bean
*
* @param
* @param
* @param
* @author Gavin King
* @author David Allen
* @author Marko Luksa
*/
public abstract class AbstractProducerBean extends AbstractReceiverBean {
private static final CacheLoader, Boolean> SERIALIZABLE_CHECK = new CacheLoader, Boolean>() {
public Boolean load(Class from) {
return Reflections.isSerializable(from);
}
};
// Logger for messages
private static final LocLogger log = loggerFactory().getLogger(BEAN);
// Underlying Producer represented by this bean
private Producer producer;
// Passivation flags
private boolean passivationCapableBean;
private boolean passivationCapableDependency;
// Serialization cache for produced types at runtime
private LoadingCache, Boolean> serializationCheckCache;
/**
* Constructor
*
* @param declaringBean The declaring bean
* @param beanManager The Bean manager
*/
public AbstractProducerBean(String idSuffix, AbstractClassBean declaringBean, BeanManagerImpl beanManager, ServiceRegistry services) {
super(idSuffix, declaringBean, beanManager, services);
serializationCheckCache = CacheBuilder.newBuilder().build(SERIALIZABLE_CHECK);
}
@Override
public abstract WeldMember getWeldAnnotated();
@Override
// Overriden to provide the class of the bean that declares the producer
// method/field
public Class getBeanClass() {
return getDeclaringBean().getBeanClass();
}
/**
* Initializes the API types
*/
@Override
protected void initTypes() {
if (getType().isArray() || getType().isPrimitive()) {
Set types = new HashSet();
types.add(getProducerReturnType());
types.add(Object.class);
super.types = types;
} else {
super.initTypes();
}
}
/**
* Initializes the type
*/
protected void initType() {
try {
this.type = getWeldAnnotated().getJavaClass();
} catch (ClassCastException e) {
Type type = Beans.getDeclaredBeanType(getClass());
throw new WeldException(PRODUCER_CAST_ERROR, e, getWeldAnnotated().getJavaClass(), (type == null ? " unknown " : type));
}
}
/**
* Validates the producer method
*/
protected void checkProducerReturnType() {
if ((getProducerReturnType() instanceof TypeVariable) || (getProducerReturnType() instanceof WildcardType)) {
throw new DefinitionException(RETURN_TYPE_MUST_BE_CONCRETE, getProducerReturnType());
} else if (getWeldAnnotated().isParameterizedType()) {
for (Type type : getWeldAnnotated().getActualTypeArguments()) {
if (!Dependent.class.equals(getScope()) && type instanceof TypeVariable) {
throw new DefinitionException(PRODUCER_METHOD_WITH_TYPE_VARIABLE_RETURN_TYPE_MUST_BE_DEPENDENT, getWeldAnnotated());
} else if (type instanceof WildcardType) {
throw new DefinitionException(PRODUCER_METHOD_CANNOT_HAVE_A_WILDCARD_RETURN_TYPE, getWeldAnnotated());
}
}
}
}
private Type getProducerReturnType() {
return getWeldAnnotated().getBaseType();
}
/**
* Initializes the bean and its metadata
*/
@Override
public void initialize(BeanDeployerEnvironment environment) {
getDeclaringBean().initialize(environment);
super.initialize(environment);
checkProducerReturnType();
initPassivationCapable();
}
private void initPassivationCapable() {
if (getWeldAnnotated().isFinal() && !Serializable.class.isAssignableFrom(getWeldAnnotated().getJavaClass())) {
this.passivationCapableBean = false;
} else {
this.passivationCapableBean = true;
}
if (isNormalScoped()) {
this.passivationCapableDependency = true;
} else if (getScope().equals(Dependent.class) && passivationCapableBean) {
this.passivationCapableDependency = true;
} else {
this.passivationCapableDependency = false;
}
}
@Override
public boolean isPassivationCapableBean() {
return passivationCapableBean;
}
@Override
public boolean isPassivationCapableDependency() {
return passivationCapableDependency;
}
@Override
public Set getInjectionPoints() {
return getProducer().getInjectionPoints();
}
/**
* Validates the return value
*
* @param instance The instance to validate
*/
protected T checkReturnValue(T instance) {
if (instance == null) {
if (!isDependent()) {
throw new IllegalProductException(NULL_NOT_ALLOWED_FROM_PRODUCER, getProducer());
}
} else {
boolean passivating = beanManager.getServices().get(MetaAnnotationStore.class).getScopeModel(getScope()).isPassivating();
boolean instanceSerializable = isTypeSerializable(instance.getClass());
if (passivating && !instanceSerializable) {
throw new IllegalProductException(NON_SERIALIZABLE_PRODUCT_ERROR, getProducer());
}
InjectionPoint injectionPoint = Container.instance().services().get(CurrentInjectionPoint.class).peek();
if (injectionPoint != null && injectionPoint.getBean() != null) {
if (!instanceSerializable && Beans.isPassivatingScope(injectionPoint.getBean(), beanManager)) {
if (injectionPoint.getMember() instanceof Field) {
if (!injectionPoint.isTransient()) {
throw new IllegalProductException(NON_SERIALIZABLE_FIELD_INJECTION_ERROR, this, injectionPoint);
}
} else if (injectionPoint.getMember() instanceof Method) {
Method method = (Method) injectionPoint.getMember();
if (method.isAnnotationPresent(Inject.class)) {
throw new IllegalProductException(NON_SERIALIZABLE_INITIALIZER_PARAM_INJECTION_ERROR, this, injectionPoint);
}
if (method.isAnnotationPresent(Produces.class)) {
throw new IllegalProductException(NON_SERIALIZABLE_PRODUCER_PARAM_INJECTION_ERROR, this, injectionPoint);
}
} else if (injectionPoint.getMember() instanceof Constructor) {
throw new IllegalProductException(NON_SERIALIZABLE_CONSTRUCTOR_PARAM_INJECTION_ERROR, this, injectionPoint);
}
}
}
}
return instance;
}
@Override
protected void checkType() {
}
protected boolean isTypeSerializable(final Class clazz) {
return getCacheValue(serializationCheckCache, clazz);
}
@Override
protected void initScope() {
Set scopes = new HashSet();
scopes.addAll(getWeldAnnotated().getMetaAnnotations(Scope.class));
scopes.addAll(getWeldAnnotated().getMetaAnnotations(NormalScope.class));
if (scopes.size() > 1) {
throw new DefinitionException(ONLY_ONE_SCOPE_ALLOWED, getProducer());
}
if (scopes.size() == 1) {
this.scope = scopes.iterator().next().annotationType();
log.trace(USING_SCOPE, scope, this);
return;
}
initScopeFromStereotype();
if (this.scope == null) {
this.scope = Dependent.class;
log.trace(USING_DEFAULT_SCOPE, this);
}
}
/**
* This operation is *not* threadsafe, and should not be called outside
* bootstrap
*
* @param producer
*/
public void setProducer(Producer producer) {
this.producer = producer;
}
public Producer getProducer() {
return producer;
}
/**
* Creates an instance of the bean
*
* @returns The instance
*/
public T create(final CreationalContext creationalContext) {
T instance = getProducer().produce(creationalContext);
return checkReturnValue(instance);
}
protected abstract class AbstractProducer implements Producer {
@Override
public T produce(CreationalContext ctx) {
CreationalContext receiverCreationalContext = beanManager.createCreationalContext(getDeclaringBean());
Object receiver = getReceiver(ctx, receiverCreationalContext);
try {
return produce(receiver, ctx);
} finally {
receiverCreationalContext.release();
}
}
public Set getInjectionPoints() {
return cast(getWeldInjectionPoints());
}
protected abstract T produce(Object receiver, CreationalContext ctx);
}
}