com.sun.enterprise.deployment.annotation.handlers.AbstractHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project for IBM JDK
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.deployment.annotation.handlers;
import org.glassfish.internal.deployment.AnnotationTypesProvider;
import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.apf.*;
import org.glassfish.apf.impl.AnnotationUtils;
import org.glassfish.apf.impl.HandlerProcessingResultImpl;
import org.jvnet.hk2.annotations.Optional;
import javax.inject.Inject;
import javax.inject.Named;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* This is an abstract base class for Handlers.
* Concrete subclass has to be annotated with {@link AnnotationHandlerFor} so that appropriate metadata
* can be generated statically. Concrete subclass has to also implement the following method:
* public HandlerProcessingResult processAnnotation(AnnotationInfo ainfo)
*
* @author Shing Wai Chan
*/
public abstract class AbstractHandler implements AnnotationHandler {
protected final static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(AbstractHandler.class);
protected Logger logger = AnnotationUtils.getLogger();
@Inject @Named("EJB") @Optional
protected AnnotationTypesProvider ejbProvider;
@Override
public final Class getAnnotationType() {
return getClass().getAnnotation(AnnotationHandlerFor.class).value();
}
/**
* @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 null;
}
// ----- end of implements AnnotationHandler -----
/**
* @return a default processed result
*/
protected HandlerProcessingResult getDefaultProcessedResult() {
return HandlerProcessingResultImpl.getDefaultResult(
getAnnotationType(), ResultType.PROCESSED);
}
/**
* @return a default failed result
*/
protected HandlerProcessingResult getDefaultFailedResult() {
return HandlerProcessingResultImpl.getDefaultResult(
getAnnotationType(), ResultType.FAILED);
}
/**
* @param aeHandler
* @param ainfo
* @return a result for invalid AnnotatedElementHandler
*/
protected HandlerProcessingResult getInvalidAnnotatedElementHandlerResult(
AnnotatedElementHandler aeHandler, AnnotationInfo ainfo)
throws AnnotationProcessorException {
if (logger.isLoggable(Level.FINE)) {
log(Level.FINE, ainfo,
localStrings.getLocalString(
"enterprise.deployment.annotation.handlers.invalidaehandler",
"Invalid annotation symbol found for this type of class."));
}
if (logger.isLoggable(Level.FINER)) {
logger.finer("Invalid AnnotatedElementHandler: " + aeHandler);
}
return getDefaultProcessedResult();
}
protected void log(Level level, AnnotationInfo ainfo,
String localizedMessage) throws AnnotationProcessorException {
if (Level.SEVERE.equals(level)) {
ainfo.getProcessingContext().getErrorHandler().error(
new AnnotationProcessorException(localizedMessage, ainfo));
} else if (Level.WARNING.equals(level)) {
ainfo.getProcessingContext().getErrorHandler().warning(
new AnnotationProcessorException(localizedMessage, ainfo));
} else if (Level.FINE.equals(level)) {
ainfo.getProcessingContext().getErrorHandler().fine(
new AnnotationProcessorException(localizedMessage, ainfo));
} else if (ainfo != null) {
ainfo.getProcessingContext().getProcessor().log(
level, ainfo, localizedMessage);
} else {
logger.log(level, localizedMessage);
}
}
protected String getInjectionMethodPropertyName(Method method,
AnnotationInfo ainfo) throws AnnotationProcessorException
{
String methodName = method.getName();
String propertyName = null;
if( (methodName.length() > 3) &&
methodName.startsWith("set") ) {
// Derive javabean property name.
propertyName =
methodName.substring(3, 4).toLowerCase(Locale.US) +
methodName.substring(4);
} else {
throw new AnnotationProcessorException(
localStrings.getLocalString(
"enterprise.deployment.annotation.handlers.invalidinjectionmethodname",
"Injection method name must start with \"set\""),
ainfo);
}
return propertyName;
}
/**
* Check if given method is a valid injection method.
* Throw Exception if it is not.
* @exception AnnotationProcessorException
*/
protected void validateInjectionMethod(Method method, AnnotationInfo ainfo)
throws AnnotationProcessorException {
if (method.getParameterTypes().length!=1){
throw new AnnotationProcessorException(
localStrings.getLocalString(
"enterprise.deployment.annotation.handlers.invalidinjectionmethod",
"Injection on a method requires a JavaBeans setter method type with one parameter "),
ainfo);
}
if (!void.class.equals(method.getReturnType())) {
throw new AnnotationProcessorException(
localStrings.getLocalString(
"enterprise.deployment.annotation.handlers.injectionmethodmustreturnvoid",
"Injection on a method requires a void return type"),
ainfo);
}
}
protected HandlerProcessingResult getOverallProcessingResult(
List resultList) {
HandlerProcessingResult overallProcessingResult = null;
for (HandlerProcessingResult result : resultList) {
if (overallProcessingResult == null ||
(result.getOverallResult().compareTo(
overallProcessingResult.getOverallResult()) > 0)) {
overallProcessingResult = result;
}
}
return overallProcessingResult;
}
/**
* This is called by getTypeDependencies().
* @return an array of all ejb annotation types
*/
protected Class[] getEjbAnnotationTypes() {
if (ejbProvider!=null) {
return ejbProvider.getAnnotationTypes();
} else {
return new Class[0];
}
}
/**
* This is called by getTypeDependencies().
* @return an array of all ejb and web types annotation
*/
protected Class[] getEjbAndWebAnnotationTypes() {
Class[] weTypes = null;
Class[] ejbTypes = getEjbAnnotationTypes();
Class[] webTypes = getWebAnnotationTypes();
if (ejbTypes.length > 0) {
weTypes = new Class[ejbTypes.length + webTypes.length];
System.arraycopy(ejbTypes, 0, weTypes, 0, ejbTypes.length);
System.arraycopy(webTypes, 0, weTypes, ejbTypes.length, webTypes.length);
} else {
weTypes = webTypes;
}
return weTypes;
}
/**
* This is called by getTypeDependencies().
* @return an array of all web types annotation
*/
protected Class[] getWebAnnotationTypes() {
return new Class[]{javax.servlet.annotation.WebServlet.class};
}
/**
* This is called by getTypeDependencies().
* @return an array of all connector type annotations
*/
protected Class[] getConnectorAnnotationTypes() {
return new Class[]{javax.resource.spi.Connector.class};
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy