com.sun.enterprise.naming.GlassFishNamingBuilder 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) 2009-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.naming;
import com.sun.enterprise.naming.impl.SerialInitContextFactory;
import org.glassfish.hk2.runlevel.RunLevel;
import org.glassfish.internal.api.InitRunLevel;
import org.glassfish.internal.api.ServerContext;
import org.glassfish.logging.annotation.LogMessageInfo;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PostConstruct;
import org.glassfish.hk2.api.PreDestroy;
import javax.inject.Inject;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.NoInitialContextException;
import javax.naming.spi.InitialContextFactory;
import javax.naming.spi.InitialContextFactoryBuilder;
import javax.naming.spi.NamingManager;
import java.lang.reflect.Field;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.Hashtable;
import java.util.logging.Level;
import static com.sun.enterprise.naming.util.LogFacade.logger;
/**
* This is both a init run level service as well as our implementation of
* {@link InitialContextFactoryBuilder}. When GlassFish starts up, this
* startup service configures NamingManager with appropriate builder by calling
* {@link javax.naming.spi.NamingManager#setInitialContextFactoryBuilder}.
* Once the builder is setup, when ever new InitialContext() is called,
* builder can either instantiate {@link SerialInitContextFactory}, which is our
* implementation of {@link InitialContextFactory}, or any user specified
* InitialContextFactory class. While loading user specified class, it first
* uses Thread's context class loader and then CommonClassLoader.
*
* Please note that this is setup as an init level service to ensure that JNDI subsystem is setup
* before applications are loaded.
*
* @author [email protected]
*/
@Service
@RunLevel(value = InitRunLevel.VAL, mode = RunLevel.RUNLEVEL_MODE_NON_VALIDATING)
public class GlassFishNamingBuilder implements InitialContextFactoryBuilder, PostConstruct, PreDestroy
{
@LogMessageInfo(message = "Failed to load {0} using CommonClassLoader")
public static final String FAILED_TO_LOAD_CLASS = "AS-NAMING-00001";
@LogMessageInfo(message = "Fall back to INITIAL_CONTEXT_FACTORY {0}")
private static final String FALL_BACK_INITIAL_CONTEXT_FACTORY = "AS-NAMING-00008";
@Inject
private ServerContext sc;
/**
* We use a naming builder in order to enable use of JNDI in OSGi context, because the builder gives us
* desired hooks to create appserver specific initial context without having to rely on thread's
* context class loader which is a unknown quantity in osgi environment. Use of a builder can lead to some
* probelamatic scenarios as discussed in issue #11997, so we allow user to disable it if they want. Having such
* configuration option is more of a workaround than a fix, but I have not been able to find a better solution
* so far.
*/
private static final String ALLOW_JNDI_FROM_OSGI = "com.sun.enterprise.naming.allowJndiLookupFromOSGi";
public InitialContextFactory createInitialContextFactory(Hashtable environment) throws NamingException
{
if (environment != null)
{
// As per the documentation of Context.INITIAL_CONTEXT_FACTORY,
// it represents a fully qualified class name.
String className = (String) environment.get(Context.INITIAL_CONTEXT_FACTORY);
if (className != null)
{
try
{
return (InitialContextFactory) (loadClass(className).newInstance());
}
catch (Exception e) {
if (className.startsWith("weblogic.jndi")) {
logger.log(Level.INFO, FALL_BACK_INITIAL_CONTEXT_FACTORY,
"com.sun.enterprise.naming.impl.SerialInitContextFactory");
} else {
NoInitialContextException ne =
new NoInitialContextException("Cannot instantiate class: " + className);
ne.setRootCause(e);
throw ne;
}
}
}
}
// default case
return new SerialInitContextFactory();
}
private Class loadClass(String className) throws ClassNotFoundException
{
ClassLoader tccl = Thread.currentThread().getContextClassLoader();
try {
return Class.forName(className, true, tccl);
} catch (ClassNotFoundException e) {
// Not a significant error. Try with common class loader instead.
logger.logp(Level.FINE, "GlassFishNamingBuilder", "loadClass",
"Failed to load {0} using thread context class loader {1}", new Object[]{className, tccl});
// Try using CommonClassLoader.
ClassLoader ccl = sc.getCommonClassLoader();
if (tccl != ccl) {
try {
return Class.forName(className, true, ccl);
} catch (ClassNotFoundException e2) {
logger.logp(Level.WARNING, "GlassFishNamingBuilder", "loadClass",
FAILED_TO_LOAD_CLASS, new Object[]{className});
throw e2;
}
}
throw e;
}
}
public void postConstruct()
{
try
{
SecurityManager sm = System.getSecurityManager();
if (sm != null)
{
try
{
AccessController.doPrivileged(new PrivilegedExceptionAction()
{
public Void run() throws NamingException
{
if (isUsingBuilder()) {
NamingManager.setInitialContextFactoryBuilder(GlassFishNamingBuilder.this);
}
return null; //Nothing to return
}
});
}
catch (PrivilegedActionException e)
{
throw (NamingException) e.getCause();
}
}
else
{
if (isUsingBuilder()) {
NamingManager.setInitialContextFactoryBuilder(this);
}
}
}
catch (NamingException e)
{
throw new RuntimeException(e);
}
}
public void preDestroy()
{
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
AccessController.doPrivileged(new PrivilegedAction(){
public Void run() {
if (isUsingBuilder()) {
resetInitialContextFactoryBuilder();
}
return null;
}
});
} else {
if (isUsingBuilder()) {
resetInitialContextFactoryBuilder();
}
}
}
private void resetInitialContextFactoryBuilder()
{
try
{
final String fieldName = ifIbmJava6() ? "icfb" : "initctx_factory_builder";
Field f = NamingManager.class.getDeclaredField(fieldName);
f.setAccessible(true);
f.set(null, null);
}
catch (NoSuchFieldException e)
{
throw new RuntimeException(e);
}
catch (IllegalAccessException e)
{
throw new RuntimeException(e); // TODO(Sahoo): Proper Exception Handling
}
}
private boolean ifIbmJava6() {
return System.getProperty("java.vendor", "").equals("IBM Corporation") && System.getProperty("java.version").equals("1.6.0");
}
/**
* @return true if we are using NamingBuilder, else false.
*/
private Boolean isUsingBuilder() {
// We are using a system property, because NamingBuilder is a JDK wide singleton.
return Boolean.valueOf(System.getProperty(ALLOW_JNDI_FROM_OSGI, "true"));
}
}