org.glassfish.weld.connector.WeldUtils Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2014 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.
*/
// Portions Copyright [2016-2022] [Payara Foundation and/or its affiliates]
package org.glassfish.weld.connector;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.ServerTags;
import com.sun.enterprise.deployment.xml.RuntimeTagNames;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import jakarta.decorator.Decorator;
import jakarta.ejb.MessageDriven;
import jakarta.ejb.Stateful;
import jakarta.ejb.Stateless;
import jakarta.enterprise.context.*;
import jakarta.enterprise.inject.Model;
import jakarta.enterprise.inject.Stereotype;
import jakarta.inject.Inject;
import jakarta.inject.Scope;
import jakarta.inject.Singleton;
import jakarta.interceptor.Interceptor;
import javax.xml.parsers.SAXParserFactory;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.classmodel.reflect.AnnotationModel;
import org.glassfish.hk2.classmodel.reflect.AnnotationType;
import org.glassfish.hk2.classmodel.reflect.ClassModel;
import org.glassfish.hk2.classmodel.reflect.FieldModel;
import org.glassfish.hk2.classmodel.reflect.MethodModel;
import org.glassfish.hk2.classmodel.reflect.Type;
import org.glassfish.hk2.classmodel.reflect.Types;
import org.glassfish.internal.api.Globals;
import org.glassfish.internal.deployment.ExtendedDeploymentContext;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import java.util.logging.Logger;
import java.util.logging.Level;
public class WeldUtils {
private static Logger logger = Logger.getLogger(WeldUtils.class.getName());
private static final String EMPTY_BEANS_XML_MODE_ALL = "fish.payara.deployment.emptyBeansXmlModeALL";
public static final char SEPARATOR_CHAR = '/';
public static final String WEB_INF = "WEB-INF";
public static final String WEB_INF_CLASSES = WEB_INF + SEPARATOR_CHAR + "classes";
public static final String WEB_INF_LIB = WEB_INF + SEPARATOR_CHAR + "lib";
public static final String BEANS_XML_FILENAME = "beans.xml";
public static final String WEB_INF_BEANS_XML = WEB_INF + SEPARATOR_CHAR + BEANS_XML_FILENAME;
public static final String META_INF_BEANS_XML = "META-INF" + SEPARATOR_CHAR + BEANS_XML_FILENAME;
public static final String WEB_INF_CLASSES_META_INF_BEANS_XML = WEB_INF_CLASSES + SEPARATOR_CHAR + META_INF_BEANS_XML;
private static final String SERVICES_DIR = "services";
// We don't want this connector module to depend on CDI API, as connector can be present in a distribution
// which does not have CDI implementation. So, we use the class name as a string.
private static final String SERVICES_CLASSNAME = "jakarta.enterprise.inject.spi.Extension";
private static final String BCE_SERVICES_CLASSNAME = "jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension";
public static final String META_INF_SERVICES_EXTENSION = "META-INF" + SEPARATOR_CHAR + SERVICES_DIR +
SEPARATOR_CHAR + SERVICES_CLASSNAME;
public static final String META_INF_BCE_SERVICES_EXTENSION = "META-INF" + SEPARATOR_CHAR + SERVICES_DIR +
SEPARATOR_CHAR + BCE_SERVICES_CLASSNAME;
public static final String WEB_INF_SERVICES_EXTENSION = WEB_INF_CLASSES + SEPARATOR_CHAR + META_INF_SERVICES_EXTENSION;
public static final String WEB_INF_BCE_EXTENSION = WEB_INF_CLASSES + SEPARATOR_CHAR + META_INF_BCE_SERVICES_EXTENSION;
public static final String CLASS_SUFFIX = ".class";
public static final String JAR_SUFFIX = ".jar";
public static final String RAR_SUFFIX = ".rar";
public static final String EXPANDED_RAR_SUFFIX = "_rar";
public static final String EXPANDED_JAR_SUFFIX = "_jar";
/**
* Bean Deployment Archive type.
*
* Can be WAR, JAR, RAR or UNKNOWN.
*/
public enum BDAType { WAR, JAR, RAR, UNKNOWN };
protected static final Set cdiScopeAnnotations;
static {
final HashSet cdi = new HashSet<>();
cdi.add(Scope.class.getName());
cdi.add(NormalScope.class.getName());
cdi.add("jakarta.faces.view.ViewScoped");
cdi.add("jakarta.faces.flow.FlowScoped");
cdi.add(ConversationScoped.class.getName());
cdi.add(ApplicationScoped.class.getName());
cdi.add(SessionScoped.class.getName());
cdi.add(RequestScoped.class.getName());
cdi.add(Dependent.class.getName());
cdi.add(Singleton.class.getName());
cdi.add(Model.class.getName());
cdiScopeAnnotations = Collections.unmodifiableSet(cdi);
}
protected static final Set cdiEnablingAnnotations;
static {
// CDI scopes
final HashSet cdi = new HashSet<>(cdiScopeAnnotations);
// 1.2 updates
cdi.add(Decorator.class.getName());
cdi.add(Interceptor.class.getName());
cdi.add(Stereotype.class.getName());
// EJB annotations
cdi.add(MessageDriven.class.getName());
cdi.add(Stateful.class.getName());
cdi.add(Stateless.class.getName());
cdi.add(jakarta.ejb.Singleton.class.getName());
cdiEnablingAnnotations = Collections.unmodifiableSet(cdi);
}
/**
* Determine whether the specified archive is an implicit bean deployment archive.
*
* @param context The deployment context
* @param archive The archive in question
* @return true, if it is an implicit bean deployment archive; otherwise, false.
* @throws java.io.IOException
*/
public static boolean isImplicitBeanArchive(DeploymentContext context, ReadableArchive archive)
throws IOException {
if(!isValidBdaBasedOnExtensionAndBeansXml(archive)) {
return false;
}
return isImplicitBeanArchive(context, archive.getURI());
}
/**
* Determine whether the specified archive is an implicit bean deployment archive.
*
* @param context The deployment context
* @param archivePath The URI of the archive
*
* @return true, if it is an implicit bean deployment archive; otherwise, false.
*/
public static boolean isImplicitBeanArchive(DeploymentContext context, URI archivePath) {
return (isImplicitBeanDiscoveryEnabled(context) && hasCDIEnablingAnnotations(context, archivePath));
}
/**
* Determine whether there are any beans annotated with annotations that should enable CDI
* processing even in the absence of a beans.xml descriptor.
*
* @param context The DeploymentContext
* @param path The path to check for annotated beans
*
* @return true, if there is at least one bean annotated with a qualified annotation in the specified path
*/
public static boolean hasCDIEnablingAnnotations(DeploymentContext context, URI path) {
return hasCDIEnablingAnnotations(context, Collections.singleton(path));
}
/**
* Determine whether there are any beans annotated with annotations that should enable CDI
* processing even in the absence of a beans.xml descriptor.
*
* @param context The DeploymentContext
* @param paths The paths to check for annotated beans
*
* @return true, if there is at least one bean annotated with a qualified annotation in the specified paths
*/
public static boolean hasCDIEnablingAnnotations(DeploymentContext context, Collection paths) {
final Types types = getTypes(context);
if (types != null) {
final Set exclusions = new HashSet<>();
for (final Type type : types.getAllTypes()) {
if (!(type instanceof AnnotationType) && type.wasDefinedIn(paths)) {
for (final AnnotationModel am : type.getAnnotations()) {
final AnnotationType at = am.getType();
if (isCDIEnablingAnnotation(at, exclusions)) {
return true;
}
}
}
}
}
return false;
}
/**
* Get the names of any annotation types that are applied to beans, which should enable CDI
* processing even in the absence of a beans.xml descriptor.
*
* @param context The DeploymentContext
*
* @return An array of annotation type names; The array could be empty if none are found.
*/
public static String[] getCDIEnablingAnnotations(DeploymentContext context) {
final Set result = new HashSet<>();
final Types types = getTypes(context);
if (types != null) {
final Set exclusions = new HashSet<>();
for (final Type type : types.getAllTypes()) {
if (!(type instanceof AnnotationType)) {
for (final AnnotationModel am : type.getAnnotations()) {
final AnnotationType at = am.getType();
if (isCDIEnablingAnnotation(at, exclusions)) {
result.add(at.getName());
}
}
}
}
}
return result.toArray(new String[0]);
}
/**
* Get the names of any classes that are annotated with bean-defining annotations, which should
* enable CDI processing even in the absence of a beans.xml descriptor.
*
* @param context The DeploymentContext
*
* @return A collection of class names; The collection could be empty if none are found.
*/
public static Collection getCDIAnnotatedClassNames(DeploymentContext context) {
final Set result = new HashSet<>();
final Set cdiEnablingAnnotations = new HashSet<>();
Collections.addAll(cdiEnablingAnnotations, getCDIEnablingAnnotations(context));
final Types types = getTypes(context);
if (types != null) {
for (final Type type : types.getAllTypes()) {
if (!(type instanceof AnnotationType)) {
for (final AnnotationModel am : type.getAnnotations()) {
final AnnotationType at = am.getType();
if (cdiEnablingAnnotations.contains(at.getName())) {
result.add(type.getName());
break;
}
}
}
}
}
return result;
}
/**
* Searches through the known class names of a {@link BeanDeploymentArchive} to determine which have fields or
* methods with the {@link Inject} annotation.
*
* @param types The Types obtained from a {@link DeploymentContext}'s transient metadata
* @param knownClassNames The known class names of a {@link BeanDeploymentArchive}
* @return The class names from the given list which have fields or methods annotated with {@link Inject}
*/
public static Collection getInjectionTargetClassNames(Types types, Collection knownClassNames) {
final Set result = new HashSet<>();
if (types != null) {
for (String knownClassName : knownClassNames) {
Type type = types.getBy(knownClassName);
if (type != null && type instanceof ClassModel) {
boolean injectionTarget = false;
Collection fieldModels = ((ClassModel) type).getFields();
for (FieldModel fieldModel : fieldModels) {
injectionTarget = annotatedWithInject(fieldModel.getAnnotations());
if (injectionTarget) {
break;
}
}
if (!injectionTarget) {
Collection methodModels = type.getMethods();
for (MethodModel methodModel : methodModels) {
injectionTarget = annotatedWithInject(methodModel.getAnnotations());
if (injectionTarget) {
break;
}
}
}
if (injectionTarget) {
result.add(type.getName());
}
}
}
}
return result;
}
private static boolean annotatedWithInject(Collection annotationModels) {
boolean injectionTarget = false;
for (AnnotationModel annotationModel : annotationModels) {
if (annotationModel.getType().getName().equals(Inject.class.getName())) {
injectionTarget = true;
break;
}
}
return injectionTarget;
}
/**
* Determine whether the specified class is annotated with a CDI scope annotation.
*
* @param clazz The class to check.
*
* @return true, if the specified class has a CDI scope annotation; Otherwise, false.
*/
public static boolean hasScopeAnnotation(Class clazz) {
return hasValidAnnotation(clazz, cdiScopeAnnotations, null);
}
/**
* Determine whether the specified class is annotated with a CDI-enabling annotation.
*
* @param clazz The class to check.
*
* @return true, if the specified class has a CDI scope annotation; Otherwise, false.
*/
public static boolean hasCDIEnablingAnnotation(Class clazz) {
return hasValidAnnotation(clazz, cdiEnablingAnnotations, null);
}
/**
* Determine if the specified annotation type is a CDI-enabling annotation
*
* @param annotationType The annotation type to check
*
* @return true, if the specified annotation type qualifies as a CDI enabler; Otherwise, false
*/
private static boolean isCDIEnablingAnnotation(AnnotationType annotationType) {
return isCDIEnablingAnnotation(annotationType, new HashSet<>());
}
/**
* Determine if the specified annotation type is a CDI-enabling annotation
*
* @param annotationType The annotation type to check
* @param exclusions The Set of annotation type names that should be excluded from the analysis
*
* @return true, if the specified annotation type qualifies as a CDI enabler; Otherwise, false
*/
private static boolean isCDIEnablingAnnotation(AnnotationType annotationType,
Set exclusions) {
final String annotationTypeName = annotationType.getName();
if (cdiEnablingAnnotations.contains(annotationTypeName)) {
return true;
} else if (exclusions.add(annotationTypeName)) {
// If the annotation type itself is not an excluded type, then check its annotation
// types, exclude itself to avoid infinite recursion
for (AnnotationModel parent : annotationType.getAnnotations()) {
if (isCDIEnablingAnnotation(parent.getType(), exclusions)) {
return true;
}
}
}
return false;
}
/**
* Determine whether the specified class is annotated with one of the annotations in the specified
* validScopes collection, but not with any of the annotations in the specified exclusion set.
*
* @param annotatedClass The class to check.
* @param validScopes A collection of valid CDI scope type names
* @param excludedScopes A collection of excluded CDI scope type names
*
* @return true, if the specified class has at least one of the annotations specified in
* validScopes, and none of the annotations specified in excludedScopes; Otherwise, false.
*/
public static boolean hasValidAnnotation(Class annotatedClass,
Set validScopes,
Collection excludedScopes) {
final Set copyOfExcludedScopes = copyCollectionToSet(excludedScopes);
// Check all the annotations on the specified Class to determine if the class is annotated
// with a supported CDI scope
for (final Annotation annotation : annotatedClass.getAnnotations()) {
if (isValidAnnotation(annotation.annotationType(), validScopes, copyOfExcludedScopes)) {
return true;
}
}
return false;
}
private static Set copyCollectionToSet(final Collection toBeCopied) {
final Set copy;
if (toBeCopied == null) {
copy = new HashSet<>();
} else {
copy = new HashSet<>(toBeCopied);
}
return copy;
}
/**
* Determine whether the specified annotation type is one of the specified valid types and not
* in the specified exclusion list. Positive results include those annotations which are themselves
* annotated with types in the valid list.
*
* @param annotationType The annotation type to check
* @param validTypeNames The valid annotation type names
* @param excludedTypeNames The excluded annotation type names
*
* @return true, if the specified type is in the valid list and not in the excluded list; Otherwise, false.
*/
private static boolean isValidAnnotation(Class annotationType,
Set validTypeNames,
Set excludedTypeNames) {
Objects.requireNonNull(validTypeNames);
Objects.requireNonNull(excludedTypeNames);
if (validTypeNames.isEmpty()) {
return false;
}
final String annotationTypeName = annotationType.getName();
if (validTypeNames.contains(annotationTypeName) && !excludedTypeNames.contains(annotationTypeName)) {
return true;
} else if (excludedTypeNames.add(annotationTypeName)){
// If the annotation type itself is not an excluded type, then check its annotation
// types, exclude itself (to avoid infinite recursion)
for (Annotation parent : annotationType.getAnnotations()) {
if (isValidAnnotation(parent.annotationType(), validTypeNames, excludedTypeNames)) {
return true;
}
}
}
return false;
}
private static Types getTypes(DeploymentContext context) {
String metadataKey = Types.class.getName();
Types types = (Types) context.getTransientAppMetadata().get(metadataKey);
while (types == null) {
context = ((ExtendedDeploymentContext) context).getParentContext();
if (context != null) {
types = (Types) context.getTransientAppMetadata().get(metadataKey);
} else {
break;
}
}
return types;
}
public static int getPreLoaderThreads() {
int result = 0;
// Check the "global" configuration
ServiceLocator serviceLocator = Globals.getDefaultHabitat();
if (serviceLocator != null) {
Config config = serviceLocator.getService(Config.class, ServerEnvironment.DEFAULT_INSTANCE_NAME);
if (config != null) {
result = Integer.valueOf(config.getExtensionByType(CDIService.class).getPreLoaderThreadPoolSize());
}
}
return result;
}
public static boolean isConcurrentDeploymentEnabled() {
boolean result = false;
// Check the "global" configuration
ServiceLocator serviceLocator = Globals.getDefaultHabitat();
if (serviceLocator != null) {
Config config = serviceLocator.getService(Config.class, ServerEnvironment.DEFAULT_INSTANCE_NAME);
if (config != null) {
result = Boolean.valueOf(config.getExtensionByType(CDIService.class).getEnableConcurrentDeployment());
}
}
return result;
}
public static boolean isImplicitBeanDiscoveryEnabled() {
boolean result = false;
// Check the "global" configuration
ServiceLocator serviceLocator = Globals.getDefaultHabitat();
if (serviceLocator != null) {
Config config = serviceLocator.getService(Config.class, ServerEnvironment.DEFAULT_INSTANCE_NAME);
if (config != null) {
result = Boolean.valueOf(config.getExtensionByType(CDIService.class).getEnableImplicitCdi());
}
}
return result;
}
public static boolean isImplicitBeanDiscoveryEnabled(DeploymentContext context) {
boolean result = false;
if (isImplicitBeanDiscoveryEnabled()) {
// If implicit discovery is enabled for the server, then check if it's disabled for the
// deployment of this application.
Object propValue = context.getAppProps().get(RuntimeTagNames.IMPLICIT_CDI_ENABLED_PROP);
Object appPropValue = context.getAppProps().get(RuntimeTagNames.PAYARA_ENABLE_IMPLICIT_CDI);
if(appPropValue != null) {
propValue = appPropValue;
}
// If the property is not set, or it's value is true, then implicit discovery is enabled
result = (propValue == null || Boolean.parseBoolean((String) propValue));
}
return result;
}
public static boolean isCDIDevModeEnabled(DeploymentContext context) {
Object propValue = context.getAppProps().get(ServerTags.CDI_DEV_MODE_ENABLED_PROP);
return propValue != null && Boolean.parseBoolean((String) propValue);
}
public static void setCDIDevMode(DeploymentContext context, boolean enabled) {
context.getAppProps().setProperty(ServerTags.CDI_DEV_MODE_ENABLED_PROP, String.valueOf(enabled));
}
public static boolean isEmptyBeansXmlModeALL(DeploymentContext context) {
if(Boolean.getBoolean(EMPTY_BEANS_XML_MODE_ALL)) {
return true;
}
Object propValue = context.getAppProps().get(ServerTags.EMPTY_BEANS_XML_MODE_ALL_PROP);
return propValue != null && Boolean.parseBoolean((String) propValue);
}
public static InputStream getBeansXmlInputStream(DeploymentContext context) {
return getBeansXmlInputStream( context.getSource() );
}
/**
* Determine if an archive is a valid bda based on what the spec says about extensions.
* See section 12.1 which states that if an archive contains an extension but no beans.xml then it is NOT
* a valid bean deployment archive.
*
* @param archive The archive to check.
* @return false if there is an extension and no beans.xml
* true otherwise
*/
public static boolean isValidBdaBasedOnExtensionAndBeansXml(ReadableArchive archive) {
try {
if (hasExtension(archive) && !hasBeansXML(archive)) {
// Extensions and no beans.xml: not a bda
return false;
}
} catch (IOException ignore) {
}
return true;
}
public static boolean hasExtension(ReadableArchive archive) {
try {
if (isWar(archive)) {
return archive.exists(WEB_INF_SERVICES_EXTENSION) || archive.exists(WEB_INF_BCE_EXTENSION);
}
return archive.exists(META_INF_SERVICES_EXTENSION) || archive.exists(META_INF_BCE_SERVICES_EXTENSION);
} catch (IOException ioe) {
logger.log(Level.WARNING, "Error when searching extensions", ioe);
return false;
}
}
public static boolean hasBeansXML(ReadableArchive archive) throws IOException {
if (isWar(archive)) {
return archive.exists(WeldUtils.WEB_INF_BEANS_XML) ||
archive.exists(WeldUtils.WEB_INF_CLASSES_META_INF_BEANS_XML);
}
return archive.exists(WeldUtils.META_INF_BEANS_XML);
}
private static boolean isWar(ReadableArchive archive) throws IOException {
return archive.exists(WeldUtils.WEB_INF);
}
public static InputStream getBeansXmlInputStream( ReadableArchive archive ) {
InputStream inputStream = null;
try {
if (archive.exists(WeldUtils.WEB_INF)) {
inputStream = archive.getEntry(WeldUtils.WEB_INF_BEANS_XML);
if (inputStream == null) {
inputStream = archive.getEntry(WeldUtils.WEB_INF_CLASSES_META_INF_BEANS_XML);
}
} else {
inputStream = archive.getEntry(WeldUtils.META_INF_BEANS_XML);
}
} catch (IOException e) {
return null;
}
return inputStream;
}
/**
* Get the "bean-discovery-mode" from the "beans" element if it exists in beans.xml
* From section 12.1 of CDI spec:
* A bean archive has a bean discovery mode of all, annotated or none. A bean archive which
* contains a beans.xml file with no version has a default bean discovery mode of annotated. A bean
* archive which contains a beans.xml file with version 1.1 (or later) must specify the bean-
* discovey-mode attribute. The default value for the attribute is annotated.
*
* @param beansXmlInputStream The InputStream for the beans.xml to check.
* @return "annotated" if there is no beans.xml
* "annotated" if the bean-discovery-mode is missing
* "annotated" if the bean-discovery-mode is empty
* The value of bean-discovery-mode in all other cases.
*/
public static String getBeanDiscoveryMode(InputStream beansXmlInputStream) {
if (beansXmlInputStream == null) {
// there is no beans.xml.
return "annotated";
}
String beanDiscoveryMode = null;
LocalDefaultHandler handler = new LocalDefaultHandler();
try {
SAXParserFactory.newInstance().newSAXParser().parse(beansXmlInputStream, handler);
} catch (SAXStoppedIntentionallyException exc) {
beanDiscoveryMode = handler.getBeanDiscoveryMode();
} catch (Exception ignore) {
}
if (beanDiscoveryMode == null) {
//when empty beans.xml or bean-discovery-mode not specified
return "annotated";
}
if (beanDiscoveryMode.equals("")) {
return "annotated";
}
return beanDiscoveryMode;
}
private static class LocalDefaultHandler extends DefaultHandler {
String beanDiscoveryMode = null;
@Override
public void startElement(String uri, String localName,String qName, Attributes attributes) throws SAXException {
if (qName.equals("beans")) {
beanDiscoveryMode = attributes.getValue("bean-discovery-mode");
throw new SAXStoppedIntentionallyException();
}
}
public String getBeanDiscoveryMode() {
return beanDiscoveryMode;
}
}
private static class SAXStoppedIntentionallyException extends SAXException {
private SAXStoppedIntentionallyException() {
super();
}
}
}