ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: import com.sun.xml.internal.ws.api.addressing.WSEndpointReference;
ohair@286: import com.sun.xml.internal.ws.api.server.Container;
ohair@286: import com.sun.xml.internal.ws.api.server.ContainerResolver;
ohair@286: import com.sun.xml.internal.ws.api.server.WSEndpoint;
ohair@286: import com.sun.xml.internal.ws.client.WSServiceDelegate;
ohair@286: 
ohair@286: import javax.xml.bind.JAXBContext;
ohair@286: import javax.xml.namespace.QName;
ohair@286: import javax.xml.ws.Dispatch;
ohair@286: import javax.xml.ws.EndpointReference;
ohair@286: import javax.xml.ws.Service;
ohair@286: import javax.xml.ws.Service.Mode;
ohair@286: import javax.xml.ws.WebServiceException;
ohair@286: import javax.xml.ws.WebServiceFeature;
ohair@286: import javax.xml.ws.spi.ServiceDelegate;
ohair@286: import java.lang.reflect.Field;
ohair@286: import java.net.URL;
ohair@286: import java.security.AccessController;
ohair@286: import java.security.PrivilegedAction;
ohair@286: import java.util.HashSet;
ohair@286: import java.util.Set;
ohair@286: import java.util.concurrent.CopyOnWriteArraySet;
ohair@286: 
ohair@286: /**
ohair@286:  * JAX-WS implementation of {@link ServiceDelegate}.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * This abstract class is used only to improve the static type safety
ohair@286:  * of the JAX-WS internal API.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * The class name intentionally doesn't include "Delegate",
ohair@286:  * because the fact that it's a delegate is a detail of
ohair@286:  * the JSR-224 API, and for the layers above us this object
ohair@286:  * nevertheless represents {@link Service}. We want them
ohair@286:  * to think of this as an internal representation of a service.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * Only JAX-WS internal code may downcast this to {@link WSServiceDelegate}.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  */
ohair@286: public abstract class WSService extends ServiceDelegate implements ComponentRegistry {
ohair@286:         private final Set<Component> components = new CopyOnWriteArraySet<Component>();
ohair@286: 
ohair@286:         protected WSService() {
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Works like {@link #getPort(EndpointReference, Class, WebServiceFeature...)}
ohair@286:      * but takes {@link WSEndpointReference}.
ohair@286:      */
ohair@286:     public abstract <T> T getPort(WSEndpointReference epr, Class<T> portInterface, WebServiceFeature... features);
ohair@286: 
ohair@286:     /**
alanb@368:      * Works like {@link #createDispatch(javax.xml.ws.EndpointReference, java.lang.Class, javax.xml.ws.Service.Mode, javax.xml.ws.WebServiceFeature[])}
ohair@286:      * but it takes the port name separately, so that EPR without embedded metadata can be used.
ohair@286:      */
ohair@286:     public abstract <T> Dispatch<T> createDispatch(QName portName, WSEndpointReference wsepr, Class<T> aClass, Service.Mode mode, WebServiceFeature... features);
ohair@286: 
ohair@286:     /**
alanb@368:      * Works like {@link #createDispatch(javax.xml.ws.EndpointReference, javax.xml.bind.JAXBContext, javax.xml.ws.Service.Mode, javax.xml.ws.WebServiceFeature[])}
ohair@286:      * but it takes the port name separately, so that EPR without embedded metadata can be used.
ohair@286:      */
ohair@286:     public abstract Dispatch<Object> createDispatch(QName portName, WSEndpointReference wsepr, JAXBContext jaxbContext, Service.Mode mode, WebServiceFeature... features);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link Container} object.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * The components inside {@link WSEndpoint} uses this reference
ohair@286:      * to communicate with the hosting environment.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      always same object. If no "real" {@link Container} instance
ohair@286:      *      is given, {@link Container#NONE} will be returned.
ohair@286:      */
ohair@286:     public abstract @NotNull Container getContainer();
ohair@286: 
ohair@286:     public @Nullable <S> S getSPI(@NotNull Class<S> spiType) {
ohair@286:         for (Component c : components) {
ohair@286:                 S s = c.getSPI(spiType);
ohair@286:                 if (s != null)
ohair@286:                         return s;
ohair@286:         }
ohair@286: 
alanb@368:         return getContainer().getSPI(spiType);
ohair@286:     }
ohair@286: 
ohair@286:     public @NotNull Set<Component> getComponents() {
ohair@286:         return components;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Create a <code>Service</code> instance.
ohair@286:      *
ohair@286:      * The specified WSDL document location and service qualified name MUST
ohair@286:      * uniquely identify a <code>wsdl:service</code> element.
ohair@286:      *
ohair@286:      * @param wsdlDocumentLocation URL for the WSDL document location
ohair@286:      *                             for the service
ohair@286:      * @param serviceName QName for the service
ohair@286:      * @throws WebServiceException If any error in creation of the
ohair@286:      *                    specified service.
ohair@286:      **/
ohair@286:     public static WSService create( URL wsdlDocumentLocation, QName serviceName) {
ohair@286:         return new WSServiceDelegate(wsdlDocumentLocation,serviceName,Service.class);
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Create a <code>Service</code> instance.
ohair@286:      *
ohair@286:      * @param serviceName QName for the service
ohair@286:      * @throws WebServiceException If any error in creation of the
ohair@286:      *                    specified service
ohair@286:      */
ohair@286:     public static WSService create(QName serviceName) {
ohair@286:         return create(null,serviceName);
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a service with a dummy service name.
ohair@286:      */
ohair@286:     public static WSService create() {
ohair@286:         return create(null,new QName(WSService.class.getName(),"dummy"));
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Typed parameter bag used by {@link WSService#create(URL, QName, InitParams)}
ohair@286:      *
ohair@286:      * @since 2.1.3
ohair@286:      */
ohair@286:     public static final class InitParams {
ohair@286:         private Container container;
ohair@286:         /**
ohair@286:          * Sets the {@link Container} object used by the created service.
ohair@286:          * This allows the client to use a specific {@link Container} instance
ohair@286:          * as opposed to the one obtained by {@link ContainerResolver}.
ohair@286:          */
ohair@286:         public void setContainer(Container c) {
ohair@286:             this.container = c;
ohair@286:         }
ohair@286:         public Container getContainer() {
ohair@286:             return container;
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * To create a {@link Service}, we need to go through the API that doesn't let us
ohair@286:      * pass parameters, so as a hack we use thread local.
ohair@286:      */
ohair@286:     protected static final ThreadLocal<InitParams> INIT_PARAMS = new ThreadLocal<InitParams>();
ohair@286: 
ohair@286:     /**
ohair@286:      * Used as a immutable constant so that we can avoid null check.
ohair@286:      */
ohair@286:     protected static final InitParams EMPTY_PARAMS = new InitParams();
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a {@link Service} instance.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This method works really like {@link Service#create(URL, QName)}
ohair@286:      * except it takes one more RI specific parameter.
ohair@286:      *
ohair@286:      * @param wsdlDocumentLocation
ohair@286:      *          {@code URL} for the WSDL document location for the service.
ohair@286:      *          Can be null, in which case WSDL is not loaded.
ohair@286:      * @param serviceName
ohair@286:      *          {@code QName} for the service.
ohair@286:      * @param properties
ohair@286:      *          Additional RI specific initialization parameters. Can be null.
ohair@286:      * @throws WebServiceException
ohair@286:      *          If any error in creation of the specified service.
ohair@286:      **/
ohair@286:     public static Service create( URL wsdlDocumentLocation, QName serviceName, InitParams properties) {
ohair@286:         if(INIT_PARAMS.get()!=null)
ohair@286:             throw new IllegalStateException("someone left non-null InitParams");
ohair@286:         INIT_PARAMS.set(properties);
ohair@286:         try {
ohair@286:             Service svc = Service.create(wsdlDocumentLocation, serviceName);
ohair@286:             if(INIT_PARAMS.get()!=null)
ohair@286:                 throw new IllegalStateException("Service "+svc+" didn't recognize InitParams");
ohair@286:             return svc;
ohair@286:         } finally {
ohair@286:             // even in case of an exception still reset INIT_PARAMS
ohair@286:             INIT_PARAMS.set(null);
ohair@286:         }
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Obtains the {@link WSService} that's encapsulated inside a {@link Service}.
ohair@286:      *
ohair@286:      * @throws IllegalArgumentException
ohair@286:      *      if the given service object is not from the JAX-WS RI.
ohair@286:      */
ohair@286:     public static WSService unwrap(final Service svc) {
ohair@286:         return AccessController.doPrivileged(new PrivilegedAction<WSService>() {
ohair@286:             public WSService run() {
ohair@286:                 try {
ohair@286:                     Field f = svc.getClass().getField("delegate");
ohair@286:                     f.setAccessible(true);
ohair@286:                     Object delegate = f.get(svc);
ohair@286:                     if(!(delegate instanceof WSService))
ohair@286:                         throw new IllegalArgumentException();
ohair@286:                     return (WSService) delegate;
ohair@286:                 } catch (NoSuchFieldException e) {
ohair@286:                     AssertionError x = new AssertionError("Unexpected service API implementation");
ohair@286:                     x.initCause(e);
ohair@286:                     throw x;
ohair@286:                 } catch (IllegalAccessException e) {
ohair@286:                     IllegalAccessError x = new IllegalAccessError(e.getMessage());
ohair@286:                     x.initCause(e);
ohair@286:                     throw x;
ohair@286:                 }
ohair@286:             }
ohair@286:         });
ohair@286:     }
ohair@286: }