aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.assembler;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.istack.internal.logging.Logger;
aoqi@0: import com.sun.xml.internal.ws.api.ResourceLoader;
aoqi@0: import com.sun.xml.internal.ws.api.server.Container;
aoqi@0: import com.sun.xml.internal.ws.resources.TubelineassemblyMessages;
aoqi@0: import com.sun.xml.internal.ws.runtime.config.MetroConfig;
aoqi@0: import com.sun.xml.internal.ws.runtime.config.TubeFactoryList;
aoqi@0: import com.sun.xml.internal.ws.runtime.config.TubelineDefinition;
aoqi@0: import com.sun.xml.internal.ws.runtime.config.TubelineMapping;
aoqi@0: import com.sun.xml.internal.ws.util.xml.XmlUtil;
aoqi@0: 
aoqi@0: import javax.xml.bind.JAXBContext;
aoqi@0: import javax.xml.bind.JAXBElement;
aoqi@0: import javax.xml.bind.Unmarshaller;
aoqi@0: import javax.xml.stream.XMLInputFactory;
aoqi@0: import javax.xml.ws.WebServiceException;
aoqi@0: import java.lang.reflect.Method;
aoqi@0: import java.lang.reflect.ReflectPermission;
aoqi@0: import java.net.MalformedURLException;
aoqi@0: import java.net.URI;
aoqi@0: import java.net.URISyntaxException;
aoqi@0: import java.net.URL;
aoqi@0: import java.security.*;
aoqi@0: import java.util.PropertyPermission;
aoqi@0: import java.util.logging.Level;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * This class is responsible for locating and loading Metro configuration files
aoqi@0:  * (both application jaxws-tubes.xml and default jaxws-tubes-default.xml).
aoqi@0:  * <p/>
aoqi@0:  * Once the configuration is loaded the class is able to resolve which tubeline
aoqi@0:  * configuration belongs to each endpoint or endpoint client. This information is
aoqi@0:  * then used in {@link TubelineAssemblyController} to construct the list of
aoqi@0:  * {@link TubeCreator} objects that are used in the actual tubeline construction.
aoqi@0:  *
aoqi@0:  * @author Marek Potociar <marek.potociar at sun.com>
aoqi@0:  */
aoqi@0: // TODO Move the logic of this class directly into MetroConfig class.
aoqi@0: class MetroConfigLoader {
aoqi@0: 
aoqi@0:     private static final Logger LOGGER = Logger.getLogger(MetroConfigLoader.class);
aoqi@0: 
aoqi@0:     private MetroConfigName defaultTubesConfigNames;
aoqi@0: 
aoqi@0:     private static interface TubeFactoryListResolver {
aoqi@0: 
aoqi@0:         TubeFactoryList getFactories(TubelineDefinition td);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final TubeFactoryListResolver ENDPOINT_SIDE_RESOLVER = new TubeFactoryListResolver() {
aoqi@0: 
aoqi@0:         public TubeFactoryList getFactories(TubelineDefinition td) {
aoqi@0:             return (td != null) ? td.getEndpointSide() : null;
aoqi@0:         }
aoqi@0:     };
aoqi@0:     private static final TubeFactoryListResolver CLIENT_SIDE_RESOLVER = new TubeFactoryListResolver() {
aoqi@0: 
aoqi@0:         public TubeFactoryList getFactories(TubelineDefinition td) {
aoqi@0:             return (td != null) ? td.getClientSide() : null;
aoqi@0:         }
aoqi@0:     };
aoqi@0:     //
aoqi@0:     private MetroConfig defaultConfig;
aoqi@0:     private URL defaultConfigUrl;
aoqi@0:     private MetroConfig appConfig;
aoqi@0:     private URL appConfigUrl;
aoqi@0: 
aoqi@0:     MetroConfigLoader(Container container, MetroConfigName defaultTubesConfigNames) {
aoqi@0:         this.defaultTubesConfigNames = defaultTubesConfigNames;
aoqi@0:         ResourceLoader spiResourceLoader = null;
aoqi@0:         if (container != null) {
aoqi@0:             spiResourceLoader = container.getSPI(ResourceLoader.class);
aoqi@0:         }
aoqi@0:         // if spi resource can't load resource, default (MetroConfigUrlLoader) is used;
aoqi@0:         // it searches the classpath, so it would be most probably used
aoqi@0:         // when using jaxws- or metro-defaults from jaxws libraries
aoqi@0:         init(container, spiResourceLoader, new MetroConfigUrlLoader(container));
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void init(Container container, ResourceLoader... loaders) {
aoqi@0: 
aoqi@0:         String appFileName = null;
aoqi@0:         String defaultFileName = null;
aoqi@0:         if (container != null) {
aoqi@0:             MetroConfigName mcn = container.getSPI(MetroConfigName.class);
aoqi@0:             if (mcn != null) {
aoqi@0:                 appFileName = mcn.getAppFileName();
aoqi@0:                 defaultFileName = mcn.getDefaultFileName();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         if (appFileName == null) {
aoqi@0:             appFileName = defaultTubesConfigNames.getAppFileName();
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (defaultFileName == null) {
aoqi@0:             defaultFileName = defaultTubesConfigNames.getDefaultFileName();
aoqi@0:         }
aoqi@0:         this.defaultConfigUrl = locateResource(defaultFileName, loaders);
aoqi@0:         if (defaultConfigUrl == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalStateException(TubelineassemblyMessages.MASM_0001_DEFAULT_CFG_FILE_NOT_FOUND(defaultFileName)));
aoqi@0:         }
aoqi@0: 
aoqi@0:         LOGGER.config(TubelineassemblyMessages.MASM_0002_DEFAULT_CFG_FILE_LOCATED(defaultFileName, defaultConfigUrl));
aoqi@0:         this.defaultConfig = MetroConfigLoader.loadMetroConfig(defaultConfigUrl);
aoqi@0:         if (defaultConfig == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalStateException(TubelineassemblyMessages.MASM_0003_DEFAULT_CFG_FILE_NOT_LOADED(defaultFileName)));
aoqi@0:         }
aoqi@0:         if (defaultConfig.getTubelines() == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalStateException(TubelineassemblyMessages.MASM_0004_NO_TUBELINES_SECTION_IN_DEFAULT_CFG_FILE(defaultFileName)));
aoqi@0:         }
aoqi@0:         if (defaultConfig.getTubelines().getDefault() == null) {
aoqi@0:             throw LOGGER.logSevereException(new IllegalStateException(TubelineassemblyMessages.MASM_0005_NO_DEFAULT_TUBELINE_IN_DEFAULT_CFG_FILE(defaultFileName)));
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.appConfigUrl = locateResource(appFileName, loaders);
aoqi@0:         if (appConfigUrl != null) {
aoqi@0:             LOGGER.config(TubelineassemblyMessages.MASM_0006_APP_CFG_FILE_LOCATED(appConfigUrl));
aoqi@0:             this.appConfig = MetroConfigLoader.loadMetroConfig(appConfigUrl);
aoqi@0:         } else {
aoqi@0:             LOGGER.config(TubelineassemblyMessages.MASM_0007_APP_CFG_FILE_NOT_FOUND());
aoqi@0:             this.appConfig = null;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     TubeFactoryList getEndpointSideTubeFactories(URI endpointReference) {
aoqi@0:         return getTubeFactories(endpointReference, ENDPOINT_SIDE_RESOLVER);
aoqi@0:     }
aoqi@0: 
aoqi@0:     TubeFactoryList getClientSideTubeFactories(URI endpointReference) {
aoqi@0:         return getTubeFactories(endpointReference, CLIENT_SIDE_RESOLVER);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private TubeFactoryList getTubeFactories(URI endpointReference, TubeFactoryListResolver resolver) {
aoqi@0:         if (appConfig != null && appConfig.getTubelines() != null) {
aoqi@0:             for (TubelineMapping mapping : appConfig.getTubelines().getTubelineMappings()) {
aoqi@0:                 if (mapping.getEndpointRef().equals(endpointReference.toString())) {
aoqi@0:                     TubeFactoryList list = resolver.getFactories(getTubeline(appConfig, resolveReference(mapping.getTubelineRef())));
aoqi@0:                     if (list != null) {
aoqi@0:                         return list;
aoqi@0:                     } else {
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (appConfig.getTubelines().getDefault() != null) {
aoqi@0:                 TubeFactoryList list = resolver.getFactories(getTubeline(appConfig, resolveReference(appConfig.getTubelines().getDefault())));
aoqi@0:                 if (list != null) {
aoqi@0:                     return list;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         for (TubelineMapping mapping : defaultConfig.getTubelines().getTubelineMappings()) {
aoqi@0:             if (mapping.getEndpointRef().equals(endpointReference.toString())) {
aoqi@0:                 TubeFactoryList list = resolver.getFactories(getTubeline(defaultConfig, resolveReference(mapping.getTubelineRef())));
aoqi@0:                 if (list != null) {
aoqi@0:                     return list;
aoqi@0:                 } else {
aoqi@0:                     break;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         return resolver.getFactories(getTubeline(defaultConfig, resolveReference(defaultConfig.getTubelines().getDefault())));
aoqi@0:     }
aoqi@0: 
aoqi@0:     TubelineDefinition getTubeline(MetroConfig config, URI tubelineDefinitionUri) {
aoqi@0:         if (config != null && config.getTubelines() != null) {
aoqi@0:             for (TubelineDefinition td : config.getTubelines().getTubelineDefinitions()) {
aoqi@0:                 if (td.getName().equals(tubelineDefinitionUri.getFragment())) {
aoqi@0:                     return td;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static URI resolveReference(String reference) {
aoqi@0:         try {
aoqi@0:             return new URI(reference);
aoqi@0:         } catch (URISyntaxException ex) {
aoqi@0:             throw LOGGER.logSevereException(new WebServiceException(TubelineassemblyMessages.MASM_0008_INVALID_URI_REFERENCE(reference), ex));
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     private static URL locateResource(String resource, ResourceLoader loader) {
aoqi@0:         if (loader == null) return null;
aoqi@0: 
aoqi@0:         try {
aoqi@0:             return loader.getResource(resource);
aoqi@0:         } catch (MalformedURLException ex) {
aoqi@0:             LOGGER.severe(TubelineassemblyMessages.MASM_0009_CANNOT_FORM_VALID_URL(resource), ex);
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static URL locateResource(String resource, ResourceLoader[] loaders) {
aoqi@0: 
aoqi@0:         for (ResourceLoader loader : loaders) {
aoqi@0:             URL url = locateResource(resource, loader);
aoqi@0:             if (url != null) {
aoqi@0:                 return url;
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static MetroConfig loadMetroConfig(@NotNull URL resourceUrl) {
aoqi@0:         MetroConfig result = null;
aoqi@0:         try {
aoqi@0:             JAXBContext jaxbContext = createJAXBContext();
aoqi@0:             Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
aoqi@0:             XMLInputFactory factory = XmlUtil.newXMLInputFactory(true);
aoqi@0:             final JAXBElement<MetroConfig> configElement = unmarshaller.unmarshal(factory.createXMLStreamReader(resourceUrl.openStream()), MetroConfig.class);
aoqi@0:             result = configElement.getValue();
aoqi@0:         } catch (Exception e) {
aoqi@0:             LOGGER.warning(TubelineassemblyMessages.MASM_0010_ERROR_READING_CFG_FILE_FROM_LOCATION(resourceUrl.toString()), e);
aoqi@0:         }
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static JAXBContext createJAXBContext() throws Exception {
aoqi@0:         if (isJDKInternal()) {
aoqi@0:             // since jdk classes are repackaged, extra privilege is necessary to create JAXBContext
aoqi@0:             return AccessController.doPrivileged(
aoqi@0:                     new PrivilegedExceptionAction<JAXBContext>() {
aoqi@0:                         @Override
aoqi@0:                         public JAXBContext run() throws Exception {
aoqi@0:                             return JAXBContext.newInstance(MetroConfig.class.getPackage().getName());
aoqi@0:                         }
aoqi@0:                     }, createSecurityContext()
aoqi@0:             );
aoqi@0:         } else {
aoqi@0:             // usage from JAX-WS/Metro/Glassfish
aoqi@0:             return JAXBContext.newInstance(MetroConfig.class.getPackage().getName());
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static AccessControlContext createSecurityContext() {
aoqi@0:         PermissionCollection perms = new Permissions();
aoqi@0:         perms.add(new RuntimePermission("accessClassInPackage.com" + ".sun.xml.internal.ws.runtime.config")); // avoid repackaging
aoqi@0:         perms.add(new ReflectPermission("suppressAccessChecks"));
aoqi@0:         return new AccessControlContext(
aoqi@0:                 new ProtectionDomain[]{
aoqi@0:                         new ProtectionDomain(null, perms),
aoqi@0:                 });
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static boolean isJDKInternal() {
aoqi@0:         // avoid "string repackaging"
aoqi@0:         return MetroConfigLoader.class.getName().startsWith("com." + "sun.xml.internal.ws");
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static class MetroConfigUrlLoader extends ResourceLoader {
aoqi@0: 
aoqi@0:         Container container; // TODO remove the field together with the code path using it (see below)
aoqi@0:         ResourceLoader parentLoader;
aoqi@0: 
aoqi@0:         MetroConfigUrlLoader(ResourceLoader parentLoader) {
aoqi@0:             this.parentLoader = parentLoader;
aoqi@0:         }
aoqi@0: 
aoqi@0:         MetroConfigUrlLoader(Container container) {
aoqi@0:             this((container != null) ? container.getSPI(ResourceLoader.class) : null);
aoqi@0:             this.container = container;
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public URL getResource(String resource) throws MalformedURLException {
aoqi@0:             LOGGER.entering(resource);
aoqi@0:             URL resourceUrl = null;
aoqi@0:             try {
aoqi@0:                 if (parentLoader != null) {
aoqi@0:                     if (LOGGER.isLoggable(Level.FINE)) {
aoqi@0:                         LOGGER.fine(TubelineassemblyMessages.MASM_0011_LOADING_RESOURCE(resource, parentLoader));
aoqi@0:                     }
aoqi@0: 
aoqi@0:                     resourceUrl = parentLoader.getResource(resource);
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 if (resourceUrl == null) {
aoqi@0:                     resourceUrl = loadViaClassLoaders("com/sun/xml/internal/ws/assembler/" + resource);
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 if (resourceUrl == null && container != null) {
aoqi@0:                     // TODO: we should remove this code path, the config file should be loaded using ResourceLoader only
aoqi@0:                     resourceUrl = loadFromServletContext(resource);
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 return resourceUrl;
aoqi@0:             } finally {
aoqi@0:                 LOGGER.exiting(resourceUrl);
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         private static URL loadViaClassLoaders(final String resource) {
aoqi@0:             URL resourceUrl = tryLoadFromClassLoader(resource, Thread.currentThread().getContextClassLoader());
aoqi@0:             if (resourceUrl == null) {
aoqi@0:                 resourceUrl = tryLoadFromClassLoader(resource, MetroConfigLoader.class.getClassLoader());
aoqi@0:                 if (resourceUrl == null) {
aoqi@0:                     return ClassLoader.getSystemResource(resource);
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             return resourceUrl;
aoqi@0:         }
aoqi@0: 
aoqi@0:         private static URL tryLoadFromClassLoader(final String resource, final ClassLoader loader) {
aoqi@0:             return (loader != null) ? loader.getResource(resource) : null;
aoqi@0:         }
aoqi@0: 
aoqi@0:         private URL loadFromServletContext(String resource) throws RuntimeException {
aoqi@0:             Object context = null;
aoqi@0:             try {
aoqi@0:                 final Class<?> contextClass = Class.forName("javax.servlet.ServletContext");
aoqi@0:                 context = container.getSPI(contextClass);
aoqi@0:                 if (context != null) {
aoqi@0:                     if (LOGGER.isLoggable(Level.FINE)) {
aoqi@0:                         LOGGER.fine(TubelineassemblyMessages.MASM_0012_LOADING_VIA_SERVLET_CONTEXT(resource, context));
aoqi@0:                     }
aoqi@0:                     try {
aoqi@0:                         final Method method = context.getClass().getMethod("getResource", String.class);
aoqi@0:                         final Object result = method.invoke(context, "/WEB-INF/" + resource);
aoqi@0:                         return URL.class.cast(result);
aoqi@0:                     } catch (Exception e) {
aoqi@0:                         throw LOGGER.logSevereException(new RuntimeException(TubelineassemblyMessages.MASM_0013_ERROR_INVOKING_SERVLET_CONTEXT_METHOD("getResource()")), e);
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:             } catch (ClassNotFoundException e) {
aoqi@0:                 if (LOGGER.isLoggable(Level.FINE)) {
aoqi@0:                     LOGGER.fine(TubelineassemblyMessages.MASM_0014_UNABLE_TO_LOAD_CLASS("javax.servlet.ServletContext"));
aoqi@0:                 }
aoqi@0:             }
aoqi@0:             return null;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0: }