aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, 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.client;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.istack.internal.Nullable;
aoqi@0: import com.sun.xml.internal.ws.api.client.WSPortInfo;
aoqi@0: import com.sun.xml.internal.ws.binding.BindingImpl;
aoqi@0: import com.sun.xml.internal.ws.handler.HandlerChainsModel;
aoqi@0: import com.sun.xml.internal.ws.util.HandlerAnnotationInfo;
aoqi@0: import com.sun.xml.internal.ws.util.HandlerAnnotationProcessor;
aoqi@0: 
aoqi@0: import javax.jws.HandlerChain;
aoqi@0: import javax.xml.ws.Service;
aoqi@0: import javax.xml.ws.handler.Handler;
aoqi@0: import javax.xml.ws.handler.HandlerResolver;
aoqi@0: import javax.xml.ws.handler.PortInfo;
aoqi@0: import javax.xml.ws.soap.SOAPBinding;
aoqi@0: import java.util.ArrayList;
aoqi@0: import java.util.HashMap;
aoqi@0: import java.util.List;
aoqi@0: import java.util.Map;
aoqi@0: import java.util.logging.Level;
aoqi@0: import java.util.logging.Logger;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Used by {@link WSServiceDelegate} to configure {@link BindingImpl}
aoqi@0:  * with handlers. The two mechanisms encapsulated by this abstraction
aoqi@0:  * is {@link HandlerChain} annotaion and {@link HandlerResolver}
aoqi@0:  * interface.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: abstract class HandlerConfigurator {
aoqi@0:     /**
aoqi@0:      * Configures the given {@link BindingImpl} object by adding handlers to it.
aoqi@0:      */
aoqi@0:     abstract void configureHandlers(@NotNull WSPortInfo port, @NotNull BindingImpl binding);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns a {@link HandlerResolver}, if this object encapsulates any {@link HandlerResolver}.
aoqi@0:      * Otherwise null.
aoqi@0:      */
aoqi@0:     abstract HandlerResolver getResolver();
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Configures handlers by calling {@link HandlerResolver}.
aoqi@0:      * <p>
aoqi@0:      * When a null {@link HandlerResolver} is set by the user to
aoqi@0:      * {@link Service#setHandlerResolver(HandlerResolver)}, we'll use this object
aoqi@0:      * with null {@link #resolver}.
aoqi@0:      */
aoqi@0:     static final class HandlerResolverImpl extends HandlerConfigurator {
aoqi@0:         private final @Nullable HandlerResolver resolver;
aoqi@0: 
aoqi@0:         public HandlerResolverImpl(HandlerResolver resolver) {
aoqi@0:             this.resolver = resolver;
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         void configureHandlers(@NotNull WSPortInfo port, @NotNull BindingImpl binding) {
aoqi@0:             if (resolver!=null) {
aoqi@0:                 binding.setHandlerChain(resolver.getHandlerChain(port));
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         HandlerResolver getResolver() {
aoqi@0:             return resolver;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Configures handlers from {@link HandlerChain} annotation.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This class is a simple
aoqi@0:      * map of PortInfo objects to handler chains. It is used by a
aoqi@0:      * {@link WSServiceDelegate} object, and can
aoqi@0:      * be replaced by user code with a different class implementing
aoqi@0:      * HandlerResolver. This class is only used on the client side, and
aoqi@0:      * it includes a lot of logging to help when there are issues since
aoqi@0:      * it deals with port names, service names, and bindings. All three
aoqi@0:      * must match when getting a handler chain from the map.
aoqi@0:      *
aoqi@0:      * <p>It is created by the {@link WSServiceDelegate}
aoqi@0:      * class , which uses {@link HandlerAnnotationProcessor} to create
aoqi@0:      * a handler chain and then it sets the chains on this class and they
aoqi@0:      * are put into the map. The ServiceContext uses the map to set handler
aoqi@0:      * chains on bindings when they are created.
aoqi@0:      */
aoqi@0:     static final class AnnotationConfigurator extends HandlerConfigurator {
aoqi@0:         private final HandlerChainsModel handlerModel;
aoqi@0:         private final Map<WSPortInfo,HandlerAnnotationInfo> chainMap = new HashMap<WSPortInfo,HandlerAnnotationInfo>();
aoqi@0:         private static final Logger logger = Logger.getLogger(
aoqi@0:             com.sun.xml.internal.ws.util.Constants.LoggingDomain + ".handler");
aoqi@0: 
aoqi@0:         AnnotationConfigurator(WSServiceDelegate delegate) {
aoqi@0:             handlerModel = HandlerAnnotationProcessor.buildHandlerChainsModel(delegate.getServiceClass());
aoqi@0:             assert handlerModel!=null; // this class is suppeod to be called only when there's @HandlerCHain
aoqi@0:         }
aoqi@0: 
aoqi@0: 
aoqi@0:         void configureHandlers(WSPortInfo port, BindingImpl binding) {
aoqi@0:             //Check in cache first
aoqi@0:             HandlerAnnotationInfo chain = chainMap.get(port);
aoqi@0: 
aoqi@0:             if(chain==null) {
aoqi@0:                 logGetChain(port);
aoqi@0:                 // Put it in cache
aoqi@0:                 chain = handlerModel.getHandlersForPortInfo(port);
aoqi@0:                 chainMap.put(port,chain);
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (binding instanceof SOAPBinding) {
aoqi@0:                 ((SOAPBinding) binding).setRoles(chain.getRoles());
aoqi@0:             }
aoqi@0: 
aoqi@0:             logSetChain(port,chain);
aoqi@0:             binding.setHandlerChain(chain.getHandlers());
aoqi@0:         }
aoqi@0: 
aoqi@0:         HandlerResolver getResolver() {
aoqi@0:             return new HandlerResolver() {
aoqi@0:                 public List<Handler> getHandlerChain(PortInfo portInfo) {
aoqi@0:                     return new ArrayList<Handler>(
aoqi@0:                         handlerModel.getHandlersForPortInfo(portInfo).getHandlers());
aoqi@0:                 }
aoqi@0:             };
aoqi@0:         }
aoqi@0:         // logged at finer level
aoqi@0:         private void logSetChain(WSPortInfo info, HandlerAnnotationInfo chain) {
aoqi@0:             logger.finer("Setting chain of length " + chain.getHandlers().size() +
aoqi@0:                 " for port info");
aoqi@0:             logPortInfo(info, Level.FINER);
aoqi@0:         }
aoqi@0: 
aoqi@0:         // logged at fine level
aoqi@0:         private void logGetChain(WSPortInfo info) {
aoqi@0:             logger.fine("No handler chain found for port info:");
aoqi@0:             logPortInfo(info, Level.FINE);
aoqi@0:             logger.fine("Existing handler chains:");
aoqi@0:             if (chainMap.isEmpty()) {
aoqi@0:                 logger.fine("none");
aoqi@0:             } else {
aoqi@0:                 for (WSPortInfo key : chainMap.keySet()) {
aoqi@0:                     logger.fine(chainMap.get(key).getHandlers().size() +
aoqi@0:                         " handlers for port info ");
aoqi@0:                     logPortInfo(key, Level.FINE);
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         private void logPortInfo(WSPortInfo info, Level level) {
aoqi@0:             logger.log(level, "binding: " + info.getBindingID() +
aoqi@0:                 "\nservice: " + info.getServiceName() +
aoqi@0:                 "\nport: " + info.getPortName());
aoqi@0:         }
aoqi@0:     }
aoqi@0: }