/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.ejb3.deployment.processors;
import org.jboss.as.ejb3.component.EJBMethodDescription;
import org.jboss.as.ejb3.component.session.SessionBeanComponentDescription;
import org.jboss.as.server.deployment.DeploymentUnitProcessingException;
import org.jboss.as.server.deployment.annotation.CompositeIndex;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationTarget;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.MethodInfo;
import org.jboss.logging.Logger;
import javax.ejb.ConcurrencyManagementType;
import javax.ejb.Lock;
import javax.ejb.LockType;
import java.util.List;
import java.util.Map;
/**
* Processes the {@link javax.ejb.Lock} annotation on a session bean, which allows concurrent access (like @Singleton and @Stateful beans),
* and its methods and updates the {@link SessionBeanComponentDescription} accordingly.
* <p/>
* For optimization, this processor should run after the {@link ConcurrencyManagementAnnotationProcessor} so that {@link LockType} processing
* can be skipped for beans with {@link javax.ejb.ConcurrencyManagementType#BEAN bean managed concurrency}.
*
* @author Jaikiran Pai
*/
public class LockAnnotationProcessor extends AbstractAnnotationEJBProcessor<SessionBeanComponentDescription> {
private static final DotName LOCK_ANNOTATION_DOT_NAME = DotName.createSimple(Lock.class.getName());
/**
* Logger
*/
private static final Logger logger = Logger.getLogger(LockAnnotationProcessor.class);
@Override
protected Class<SessionBeanComponentDescription> getComponentDescriptionType() {
return SessionBeanComponentDescription.class;
}
@Override
protected void processAnnotations(ClassInfo beanClass, CompositeIndex compositeIndex, SessionBeanComponentDescription componentDescription) throws DeploymentUnitProcessingException {
if (!componentDescription.allowsConcurrentAccess()) {
return;
}
if (componentDescription.getConcurrencyManagementType() == ConcurrencyManagementType.BEAN) {
// skip @Lock processing for bean managed concurrency.
logger.debug("Skipping @Lock processing for bean: " + componentDescription.getEJBName() + " with BEAN managed concurrency management");
return;
}
this.processLockAnnotations(beanClass, compositeIndex, componentDescription);
}
private void processLockAnnotations(ClassInfo beanClass, CompositeIndex compositeIndex, SessionBeanComponentDescription componentDescription) throws DeploymentUnitProcessingException {
final DotName superName = beanClass.superName();
if (superName != null) {
ClassInfo superClass = compositeIndex.getClassByName(superName);
if (superClass != null)
processLockAnnotations(superClass, compositeIndex, componentDescription);
}
final Map<DotName, List<AnnotationInstance>> classAnnotations = beanClass.annotations();
if (classAnnotations == null) {
return;
}
List<AnnotationInstance> annotations = classAnnotations.get(LOCK_ANNOTATION_DOT_NAME);
if (annotations == null) {
return;
}
for (AnnotationInstance annotationInstance : annotations) {
AnnotationTarget target = annotationInstance.target();
LockType lockType = LockType.valueOf(annotationInstance.value().asEnum());
if (target instanceof ClassInfo) {
// bean level
componentDescription.setBeanLevelLockType(lockType);
logger.debug("Bean " + componentDescription.getEJBName() + " marked for lock type " + lockType);
} else if (target instanceof MethodInfo) {
// method specific lock type
final MethodInfo method = (MethodInfo) target;
componentDescription.setLockType(lockType, new EJBMethodDescription(method));
}
}
}
}