com.sun.enterprise.security.ee.SecuritySniffer 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
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-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 [2016-2021] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.security.ee;
import com.sun.enterprise.security.SecurityLifecycle;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.deployment.common.DeploymentUtils;
import com.sun.enterprise.deployment.util.DOLUtils;
import org.glassfish.hk2.api.ServiceHandle;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.deployment.GenericSniffer;
import org.jvnet.hk2.annotations.Service;
import javax.enterprise.deploy.shared.ModuleType;
import java.util.logging.Logger;
import java.io.IOException;
import com.sun.enterprise.module.HK2Module;
import java.lang.annotation.Annotation;
import jakarta.inject.Inject;
/**
* SecuritySniffer for security related activities
*/
@Service(name = "Security")
public class SecuritySniffer extends GenericSniffer {
final String[] containers = { "com.sun.enterprise.security.ee.SecurityContainer" };
@Inject
private ServiceLocator habitat;
private ServiceHandle lifecycle;
@SuppressWarnings("unchecked")
private static final Class[] ejbAnnotations = new Class[] {
jakarta.ejb.Stateless.class, jakarta.ejb.Stateful.class,
jakarta.ejb.MessageDriven.class, jakarta.ejb.Singleton.class
};
public SecuritySniffer() {
super("security", null, null);
}
/**
* Returns true if the passed file or directory is recognized by this instance.
*
* @param location the file or directory to explore
* @return true if this sniffer handles this application type
*/
@Override
public boolean handles(ReadableArchive location) {
ArchiveType archiveType = location.getExtraData(ArchiveType.class);
boolean rv = false;
if (archiveType != null) {
rv |= archiveType.equals(DOLUtils.warType()) || archiveType.equals(DOLUtils.earType())
|| archiveType.equals(DOLUtils.ejbType());
}
return rv || DeploymentUtils.isArchiveOfType(location, DOLUtils.warType(), habitat)
|| DeploymentUtils.isArchiveOfType(location, DOLUtils.earType(), habitat) || isJar(location);
}
/**
* Sets up the container libraries so that any imported bundle from the connector jar file will now be known to the
* module subsystem
*
* This method returns a {@link com.sun.enterprise.module.ModuleDefinition} for the module containing the core
* implementation of the container. That means that this module will be locked as long as there is at least one module
* loaded in the associated container.
*
* @param containerHome is where the container implementation resides
* @param logger the logger to use
* @return the module definition of the core container implementation.
* @throws java.io.IOException exception if something goes sour
*/
@Override
public HK2Module[] setup(String containerHome, Logger logger) throws IOException {
lifecycle = habitat.getServiceHandle(SecurityLifecycle.class);
lifecycle.getService();
return null;
}
/**
* Tears down a container, remove all imported libraries from the module subsystem.
*/
@Override
public void tearDown() {
if (lifecycle != null) {
lifecycle.destroy();
}
}
/**
* 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
*/
@Override
public String[] getContainersNames() {
return containers;
}
@Override
public Class[] getAnnotationTypes() {
return ejbAnnotations;
}
/**
*
* 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
*
*/
@Override
public boolean supportsArchiveType(ArchiveType archiveType) {
if (archiveType.toString().equals(ModuleType.WAR.toString()) ||
archiveType.toString().equals(ModuleType.EJB.toString())) {
return true;
}
return false;
}
private boolean isJar(ReadableArchive location) {
// check for ejb-jar.xml
boolean result = false;
try {
result = location.exists("META-INF/ejb-jar.xml");
} catch (IOException ioEx) {
// TODO
}
return result;
}
}