/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-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.connectors.jms.deployment.annotation.handlers;
import com.sun.enterprise.deployment.*;
import com.sun.enterprise.deployment.annotation.context.*;
import com.sun.enterprise.deployment.annotation.handlers.AbstractResourceHandler;
import org.glassfish.apf.AnnotationHandlerFor;
import org.glassfish.apf.AnnotationInfo;
import org.glassfish.apf.AnnotationProcessorException;
import org.glassfish.apf.HandlerProcessingResult;
import org.glassfish.deployment.common.JavaEEResourceType;
import org.glassfish.deployment.common.RootDeploymentDescriptor;
import org.jvnet.hk2.annotations.Service;
import javax.interceptor.AroundInvoke;
import javax.interceptor.AroundTimeout;
import javax.interceptor.Interceptors;
import javax.jms.JMSDestinationDefinition;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;
@Service
@AnnotationHandlerFor(JMSDestinationDefinition.class)
public class JMSDestinationDefinitionHandler extends AbstractResourceHandler {
public JMSDestinationDefinitionHandler() {
}
protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo, ResourceContainerContext[] rcContexts)
throws AnnotationProcessorException {
JMSDestinationDefinition jmsDestinationDefnAn =
(JMSDestinationDefinition)ainfo.getAnnotation();
return processAnnotation(jmsDestinationDefnAn, ainfo, rcContexts);
}
protected HandlerProcessingResult processAnnotation(JMSDestinationDefinition jmsDestinationDefnAn, AnnotationInfo aiInfo,
ResourceContainerContext[] rcContexts)
throws AnnotationProcessorException {
Class<?> annotatedClass = (Class<?>)aiInfo.getAnnotatedElement();
Annotation[] annotations = annotatedClass.getAnnotations();
boolean warClass = isAWebComponentClass(annotations);
boolean ejbClass = isAEjbComponentClass(annotations);
for (ResourceContainerContext context : rcContexts) {
if (!canProcessAnnotation(annotatedClass, ejbClass, warClass, context)) {
return getDefaultProcessedResult();
}
Set<ResourceDescriptor> jmsddDescs = context.getResourceDescriptors(JavaEEResourceType.JMSDD);
JMSDestinationDefinitionDescriptor desc = createDescriptor(jmsDestinationDefnAn);
if (isDefinitionAlreadyPresent(jmsddDescs, desc)) {
merge(jmsddDescs, jmsDestinationDefnAn);
} else {
context.addResourceDescriptor(desc);
}
}
return getDefaultProcessedResult();
}
/**
* To take care of the case where an ejb is provided in a .war and
* annotation processor will process this class twice (once for ejb and
* once for web-bundle-context, which is a bug).<br>
* This method helps to overcome the issue, partially.<br>
* Checks whether both the annotated class and the context are either ejb or web.
*
* @param annotatedClass annotated-class
* @param ejbClass indicates whether the class is an ejb-class
* @param warClass indicates whether the class is an web-class
* @param context resource-container-context
* @return boolean indicates whether the annotation can be processed.
*/
private boolean canProcessAnnotation(Class<?> annotatedClass, boolean ejbClass, boolean warClass,
ResourceContainerContext context) {
if (ejbClass) {
if (!(context instanceof EjbBundleContext ||
context instanceof EjbContext ||
context instanceof EjbInterceptorContext
)) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing as the class is " +
"an EJB class and context is not one of EJBContext");
}
return false;
}
} else if (context instanceof EjbBundleContext) {
EjbBundleContext ejbContext = (EjbBundleContext) context;
EjbBundleDescriptor ejbBundleDescriptor = ejbContext.getDescriptor();
EjbDescriptor[] ejbDescriptor = ejbBundleDescriptor.getEjbByClassName(annotatedClass.getName());
if (ejbDescriptor == null || ejbDescriptor.length == 0) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing as the class " +
"[ " + annotatedClass + " ] is " +
"not an EJB class and the context is EJBContext");
}
return false;
}
} else if (warClass) {
if (!(context instanceof WebBundleContext || context instanceof WebComponentsContext
|| context instanceof WebComponentContext )) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing as the class is " +
"an Web class and context is not one of WebContext");
}
return false;
}
} else if (context instanceof WebBundleContext) {
WebBundleContext webBundleContext = (WebBundleContext) context;
WebBundleDescriptor webBundleDescriptor = webBundleContext.getDescriptor();
Collection<RootDeploymentDescriptor> extDesc = webBundleDescriptor.getExtensionsDescriptors();
for (RootDeploymentDescriptor desc : extDesc) {
if (desc instanceof EjbBundleDescriptor) {
EjbBundleDescriptor ejbBundleDesc = (EjbBundleDescriptor)desc;
EjbDescriptor[] ejbDescs = ejbBundleDesc.getEjbByClassName(annotatedClass.getName());
if (ejbDescs != null && ejbDescs.length > 0) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing as the class " +
"[ " + annotatedClass + " ] is " +
"not an Web class and the context is WebContext");
}
return false;
} else if (ejbBundleDesc.getInterceptorByClassName(annotatedClass.getName()) != null) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing " +
"as the class " +
"[ " + annotatedClass + " ] is " +
"not an Web class and the context is WebContext");
}
return false;
} else {
Method[] methods = annotatedClass.getDeclaredMethods();
for (Method method : methods) {
Annotation annotations[] = method.getAnnotations();
for (Annotation annotation : annotations) {
if (annotation.annotationType().equals(AroundInvoke.class) ||
annotation.annotationType().equals(AroundTimeout.class) ||
annotation.annotationType().equals(Interceptors.class)) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Ignoring @JMSDestinationDefinition annotation processing " +
"as the class " +
"[ " + annotatedClass + " ] is " +
"not an Web class, an interceptor and the context is WebContext");
}
return false;
}
}
}
}
}
}
}
return true;
}
private boolean isDefinitionAlreadyPresent(Set<ResourceDescriptor> jmsddDescs,
JMSDestinationDefinitionDescriptor desc) {
for (ResourceDescriptor descriptor : jmsddDescs) {
if (descriptor.equals(desc)) {
return true;
}
}
return false;
}
private void merge(Set<ResourceDescriptor> jmsddDescs, JMSDestinationDefinition defn) {
for (ResourceDescriptor descriptor : jmsddDescs) {
JMSDestinationDefinitionDescriptor desc = (JMSDestinationDefinitionDescriptor)descriptor;
if (desc.getName().equals(defn.name())) {
if (desc.getInterfaceName() == null) {
desc.setInterfaceName(defn.interfaceName());
}
if (desc.getClassName() == null) {
if (isValid(defn.className())) {
desc.setClassName(defn.className());
}
}
if (desc.getDescription() == null) {
if (isValid(defn.description())) {
desc.setDescription(defn.description());
}
}
if (desc.getResourceAdapter() == null) {
if (isValid(defn.resourceAdapter())) {
desc.setResourceAdapter(defn.resourceAdapter());
}
}
if (desc.getDestinationName() == null) {
if (isValid(defn.destinationName())) {
desc.setDestinationName(defn.destinationName());
}
}
Properties properties = desc.getProperties();
String[] defnProperties = defn.properties();
if (defnProperties.length > 0) {
for (String property : defnProperties) {
int index = property.indexOf("=");
// found "=" and not at start or end of string
if (index > 0 && index < property.length() - 1) {
String name = property.substring(0, index).trim();
String value = property.substring(index + 1).trim();
//add to properties only when not already present
if (properties.get(name) == null) {
properties.put(name, value);
}
}
}
}
break;
}
}
}
private JMSDestinationDefinitionDescriptor createDescriptor(JMSDestinationDefinition defn) {
JMSDestinationDefinitionDescriptor desc = new JMSDestinationDefinitionDescriptor();
desc.setMetadataSource(MetadataSource.ANNOTATION);
desc.setName(defn.name());
desc.setInterfaceName(defn.interfaceName());
if (isValid(defn.className())) {
desc.setClassName(defn.className());
}
if (isValid(defn.description())) {
desc.setDescription(defn.description());
}
if (isValid(defn.resourceAdapter())) {
desc.setResourceAdapter(defn.resourceAdapter());
}
if (isValid(defn.destinationName())) {
desc.setDestinationName(defn.destinationName());
}
if (defn.properties() != null) {
Properties properties = desc.getProperties();
String[] defnProperties = defn.properties();
if (defnProperties.length > 0) {
for (String property : defnProperties) {
int index = property.indexOf("=");
// found "=" and not at start or end of string
if (index > 0 && index < property.length() - 1) {
String name = property.substring(0, index).trim();
String value = property.substring(index + 1).trim();
properties.put(name, value);
}
}
}
}
return desc;
}
private boolean isValid(String s) {
return (s != null) && !s.equals("");
}
}