org.glassfish.weld.connector.WeldSniffer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-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 org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.internal.deployment.GenericSniffer;
import org.jvnet.hk2.annotations.Service;
import javax.enterprise.deploy.shared.ModuleType;
import jakarta.inject.Singleton;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
/**
* Implementation of the Sniffer for Weld.
*/
@Service(name = "weld")
@Singleton
public class WeldSniffer extends GenericSniffer {
private static final String[] containers = { "org.glassfish.weld.WeldContainer" };
private static final java.util.logging.Logger logger = java.util.logging.Logger.getLogger(WeldSniffer.class.getName());
public WeldSniffer() {
// We do not haGenericSniffer(String containerName, String appStigma, String urlPattern
super("cdi", null /* appStigma */, null /* urlPattern */);
}
/**
* Returns true if the archive contains beans.xml as defined by packaging rules of Weld
*/
@Override
public boolean handles(DeploymentContext context) {
ArchiveType archiveType = habitat.getService(ArchiveType.class, context.getArchiveHandler().getArchiveType());
if (archiveType != null && !supportsArchiveType(archiveType)) {
return false;
}
ReadableArchive archive = context.getSource();
boolean isWeldArchive = false;
// scan for beans.xml in expected locations. If at least one is found without bean-discovery-mode="none", this is
// a Weld archive
if (isEntryPresent(archive, WeldUtils.WEB_INF)) {
isWeldArchive = isArchiveCDIEnabled(context, archive, WeldUtils.WEB_INF_BEANS_XML) ||
isArchiveCDIEnabled(context, archive, WeldUtils.WEB_INF_CLASSES_META_INF_BEANS_XML);
if (!isWeldArchive) {
// Check jars under WEB_INF/lib
if (isEntryPresent(archive, WeldUtils.WEB_INF_LIB)) {
isWeldArchive = scanLibDir(context, archive, WeldUtils.WEB_INF_LIB);
}
}
if(!isWeldArchive) {
isWeldArchive = WeldUtils.hasExtension(archive);
}
}
// TODO This doesn't seem to match the ReadableArchive for a stand-alone ejb-jar.
// It might only be true for an ejb-jar within an .ear. Revisit when officially
// adding support for .ears
String archiveName = archive.getName();
if (!isWeldArchive && archiveName != null && archiveName.endsWith(WeldUtils.EXPANDED_JAR_SUFFIX)) {
isWeldArchive = isArchiveCDIEnabled(context, archive, WeldUtils.META_INF_BEANS_XML);
}
// If stand-alone ejb-jar
if (!isWeldArchive && isArchiveCDIEnabled(context, archive, WeldUtils.META_INF_BEANS_XML)) {
isWeldArchive = true;
}
if (!isWeldArchive && archiveName != null && archiveName.endsWith(WeldUtils.EXPANDED_RAR_SUFFIX)) {
isWeldArchive = isArchiveCDIEnabled(context, archive, WeldUtils.META_INF_BEANS_XML);
if (!isWeldArchive) {
// Check jars in root dir of rar
isWeldArchive = scanLibDir(context, archive, "");
}
}
return isWeldArchive;
}
private boolean scanLibDir(DeploymentContext context, ReadableArchive archive, String libLocation) {
boolean entryPresent = false;
if (libLocation != null) {
Enumeration entries = archive.entries(libLocation);
while (entries.hasMoreElements() && !entryPresent) {
String entryName = entries.nextElement();
// if a jar in lib dir and not WEB-INF/lib/foo/bar.jar
if (entryName.endsWith(WeldUtils.JAR_SUFFIX) &&
entryName.indexOf(WeldUtils.SEPARATOR_CHAR, libLocation.length() + 1 ) == -1 ) {
try {
ReadableArchive jarInLib = archive.getSubArchive(entryName);
if (jarInLib != null) {
entryPresent = isArchiveCDIEnabled(context, jarInLib, WeldUtils.META_INF_BEANS_XML);
jarInLib.close();
}
} catch (IOException e) {
}
}
}
}
return entryPresent;
}
protected boolean isEntryPresent(ReadableArchive archive, String entry) {
boolean entryPresent = false;
try {
entryPresent = archive.exists(entry);
} catch (IOException e) {
// ignore
}
return entryPresent;
}
protected boolean isArchiveCDIEnabled(DeploymentContext context, ReadableArchive archive, String relativeBeansXmlPath) {
String beanDiscoveryMode = null;
InputStream beansXmlInputStream = null;
if (archive != null) {
try {
beansXmlInputStream = archive.getEntry(relativeBeansXmlPath);
if (beansXmlInputStream != null) {
try {
beanDiscoveryMode = WeldUtils.getBeanDiscoveryMode(beansXmlInputStream);
} finally {
try {
beansXmlInputStream.close();
} catch (Exception ignore) {
}
}
}
} catch (IOException ignore) {
}
}
if (beansXmlInputStream == null) {
// no beans.xml
try {
return WeldUtils.isImplicitBeanArchive(context, archive);
} catch (IOException e) {
return false;
}
}
// There is a beans.xml.
if (beanDiscoveryMode == null || beanDiscoveryMode.equals("all") || beanDiscoveryMode.equals("annotated")) {
return true;
} else if (beanDiscoveryMode.equals("none")) {
// beanDiscoveryMode = none
return false;
}
// last case is beanDiscoveryMode = annotated
try {
return WeldUtils.isImplicitBeanArchive(context, archive);
} catch (IOException e) {
return false;
}
}
public String[] getContainersNames() {
return containers;
}
/**
*
* This API is used to help determine if the sniffer should recognize
* the current archive.
* If the sniffer does not support the archive type associated with
* the current deployment, the sniffer should not recognize the archive.
*
* @param archiveType the archive type to check
* @return whether the sniffer supports the archive type
*
*/
public boolean supportsArchiveType(ArchiveType archiveType) {
if (archiveType.toString().equals(ModuleType.WAR.toString()) ||
archiveType.toString().equals(ModuleType.EJB.toString()) ||
archiveType.toString().equals(ModuleType.RAR.toString())) {
return true;
}
return false;
}
@Override
public String[] getAnnotationNames(DeploymentContext context) {
// first see if bean-discovery-mode is explicitly set to "none".
InputStream beansXmlInputStream = WeldUtils.getBeansXmlInputStream( context );
if ( beansXmlInputStream != null ) {
try {
String beanDiscoveryMode = WeldUtils.getBeanDiscoveryMode( beansXmlInputStream );
if ( beanDiscoveryMode.equals( "none" ) ) {
return null;
}
} finally {
try {
beansXmlInputStream.close();
} catch (IOException ignore) {
}
}
}
// make sure it's not an extension
if ( ! WeldUtils.isValidBdaBasedOnExtensionAndBeansXml( context.getSource() )) {
return null;
}
return WeldUtils.isImplicitBeanDiscoveryEnabled(context) ? WeldUtils.getCDIEnablingAnnotations(context) : null;
}
}