org.glassfish.ejb.deployment.annotation.handlers.AfterCompletionHandler Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.ejb.deployment.annotation.handlers;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.logging.Level;
import jakarta.ejb.AfterCompletion;
import jakarta.ejb.Stateful;
import com.sun.enterprise.deployment.MethodDescriptor;
import com.sun.enterprise.deployment.annotation.context.EjbContext;
import org.glassfish.apf.AnnotationHandlerFor;
import org.glassfish.apf.AnnotationInfo;
import org.glassfish.apf.AnnotationProcessorException;
import org.glassfish.apf.HandlerProcessingResult;
import org.glassfish.ejb.deployment.descriptor.EjbSessionDescriptor;
import org.jvnet.hk2.annotations.Service;
/**
* This handler is responsible for handling the jakarta.ejb.AfterCompletion
* annotation on a Bean method.
*
* @author Marina Vatkina
*/
@Service
@AnnotationHandlerFor(AfterCompletion.class)
public class AfterCompletionHandler extends AbstractAttributeHandler {
public AfterCompletionHandler() {
}
protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo,
EjbContext[] ejbContexts) throws AnnotationProcessorException {
for (EjbContext ejbContext : ejbContexts) {
EjbSessionDescriptor ejbDesc =
(EjbSessionDescriptor) ejbContext.getDescriptor();
Method annMethod = (Method) ainfo.getAnnotatedElement();
checkValid(annMethod);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Setting AfterCompletion method " + annMethod);
}
ejbDesc.setAfterCompletionMethodIfNotSet(new MethodDescriptor(annMethod));
}
return getDefaultProcessedResult();
}
/**
* @return an array of annotation types this annotation handler would
* require to be processed (if present) before it processes it's own
* annotation type.
*/
public Class[] getTypeDependencies() {
return new Class[] { Stateful.class};
}
protected boolean supportTypeInheritance() {
return true;
}
/**
* Verify that the return type is void and it's a no-arg method
*/
private void checkValid(Method m) throws AnnotationProcessorException {
if ( !(m.getReturnType().equals(Void.TYPE) &&
(m.getParameterTypes().length == 1 &&
m.getParameterTypes()[0].equals(Boolean.TYPE))) ) {
throw new AnnotationProcessorException("Method " + m +
"annotated as @AfterCompletion is not valid");
}
}
}