com.sun.enterprise.connectors.connector.module.ConnectorSniffer 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) 1997-2012 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 [2019-2021] Payara Foundation and/or affiliates
package com.sun.enterprise.connectors.connector.module;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.deployment.GenericSniffer;
import com.sun.enterprise.module.HK2Module;
import com.sun.appserv.connectors.internal.api.ConnectorConstants;
import org.glassfish.api.container.Sniffer;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.deployment.common.DeploymentUtils;
import org.jvnet.hk2.annotations.Service;
import jakarta.inject.Singleton;
import java.io.IOException;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.util.List;
import java.util.ArrayList;
import java.lang.annotation.Annotation;
import jakarta.inject.Inject;
/**
* Sniffer for detecting resource-adapter modules
*
* @author Jagadish Ramu
*/
@Service(name = ConnectorConstants.CONNECTOR_MODULE)
@Singleton
public class ConnectorSniffer extends GenericSniffer {
@Inject
private Logger logger;
@Inject RarType rarType;
@Inject ServiceLocator locator;
private static final Class[] connectorAnnotations = new Class[] {
jakarta.resource.spi.Connector.class };
public ConnectorSniffer() {
super(ConnectorConstants.CONNECTOR_MODULE, "META-INF/ra.xml", null);
}
final String[] containerNames = {"com.sun.enterprise.connectors.module.ConnectorContainer"};
/**
* Sets up the container libraries so that any imported bundle from the
* connector jar file will now be known to the module subsystem
*
* @param containerHome is where the container implementation resides
* @param logger the logger to use
* @throws java.io.IOException exception if something goes sour
*/
@Override
public HK2Module[] setup(String containerHome, Logger logger) throws IOException {
// do nothing, we are embedded in GFv3 for now
return null;
}
/**
* Returns the list of Containers that this Sniffer enables.
*
* The runtime will look up each container implementing
* using the names provided in the habitat.
*
* @return list of container names known to the habitat for this sniffer
*/
public String[] getContainersNames() {
return containerNames;
}
/**
* Returns the Module type
*
* @return the container name
*/
public String getModuleType() {
return ConnectorConstants.CONNECTOR_MODULE;
}
/**
* Returns the list of annotations types that this sniffer is interested in.
* If an application bundle contains at least one class annotated with
* one of the returned annotations, the deployment process will not
* call the handles method but will invoke the containers deployers as if
* the handles method had been called and returned true.
*
* @return list of annotations this sniffer is interested in or an empty array
*/
@Override
public Class[] getAnnotationTypes() {
return connectorAnnotations;
}
/**
* @return whether this sniffer should be visible to user
*
*/
public boolean isUserVisible() {
return true;
}
/**
* @return whether this sniffer represents a Java EE container type
*
*/
public boolean isJavaEE() {
return true;
}
/**
* @return the set of the sniffers that should not co-exist for the
* same module. For example, ejb and appclient sniffers should not
* be returned in the sniffer list for a certain module.
* This method will be used to validate and filter the retrieved sniffer
* lists for a certain module
*
*/
public String[] getIncompatibleSnifferTypes() {
return new String[] {"ejb", "web"};
}
/**
* Returns true if the passed file or directory is recognized by this
* sniffer.
* @param context deployment context
* @return true if the location is recognized by this sniffer
*/
@Override
public boolean handles(DeploymentContext context) {
ArchiveType archiveType = habitat.getService(ArchiveType.class, context.getArchiveHandler().getArchiveType());
if (archiveType != null && !supportsArchiveType(archiveType)) {
return false;
}
return DeploymentUtils.isArchiveOfType(context.getSource(), rarType, context, locator);
}
/**
*
* 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.equals(rarType)) {
return true;
}
return false;
}
private static final List deploymentConfigurationPaths =
initDeploymentConfigurationPaths();
private static List initDeploymentConfigurationPaths() {
final List result = new ArrayList();
result.add("META-INF/ra.xml");
result.add("META-INF/sun-ra.xml");
result.add("META-INF/weblogic-ra.xml");
return result;
}
/**
* Returns the descriptor paths that might exist in a connector app.
*
* @return list of the deployment descriptor paths
*/
@Override
protected List getDeploymentConfigurationPaths() {
return deploymentConfigurationPaths;
}
}