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.sei;
aoqi@0: 
aoqi@0: import com.oracle.webservices.internal.api.databinding.JavaCallInfo;
aoqi@0: import com.sun.xml.internal.ws.api.SOAPVersion;
aoqi@0: import com.sun.xml.internal.ws.api.databinding.ClientCallBridge;
aoqi@0: import com.sun.xml.internal.ws.api.message.Message;
aoqi@0: import com.sun.xml.internal.ws.api.message.MessageContextFactory;
aoqi@0: import com.sun.xml.internal.ws.api.message.Packet;
aoqi@0: import com.sun.xml.internal.ws.api.model.JavaMethod;
aoqi@0: import com.sun.xml.internal.ws.fault.SOAPFaultBuilder;
aoqi@0: import com.sun.xml.internal.ws.model.CheckedExceptionImpl;
aoqi@0: import com.sun.xml.internal.ws.model.JavaMethodImpl;
aoqi@0: import com.sun.xml.internal.ws.model.ParameterImpl;
aoqi@0: import com.sun.xml.internal.ws.model.WrapperParameter;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: import java.lang.reflect.Method;
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: 
aoqi@0: /**
aoqi@0:  * {@link com.sun.xml.internal.ws.client.sei.MethodHandler} that handles synchronous method invocations.
aoqi@0:  *  This is refactored from SEIMethodHandler.
aoqi@0:  * <p>
aoqi@0:  * This class mainly performs the following two tasks:
aoqi@0:  * <ol>
aoqi@0:  *  <li>Accepts Object[] that represents arguments for a Java method,
aoqi@0:  *      and creates {@link com.sun.xml.internal.ws.message.jaxb.JAXBMessage} that represents a request message.
aoqi@0:  *  <li>Takes a {@link com.sun.xml.internal.ws.api.message.Message} that represents a response,
aoqi@0:  *      and extracts the return value (and updates {@link javax.xml.ws.Holder }s.)
aoqi@0:  * </ol>
aoqi@0:  *
aoqi@0:  * <h2>Creating {@link com.sun.xml.internal.ws.message.jaxb.JAXBMessage }</h2>
aoqi@0:  * <p>
aoqi@0:  * At the construction time, we prepare {@link com.sun.xml.internal.ws.client.sei.BodyBuilder} and {@link com.sun.xml.internal.ws.client.sei.MessageFiller}s
aoqi@0:  * that know how to move arguments into a {@link com.sun.xml.internal.ws.api.message.Message }.
aoqi@0:  * Some arguments go to the payload, some go to headers, still others go to attachments.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @author Jitendra Kotamraju
aoqi@0:  * @author shih-chang.chen@oracle.com
aoqi@0:  */
aoqi@0: public class StubHandler implements ClientCallBridge {
aoqi@0: 
aoqi@0:     // these objects together create a message from method parameters
aoqi@0:     private final BodyBuilder bodyBuilder;
aoqi@0:     private final MessageFiller[] inFillers;
aoqi@0:     protected final String soapAction;
aoqi@0:     protected final boolean isOneWay;
aoqi@0:     protected final JavaMethodImpl javaMethod;
aoqi@0:     protected final Map<QName, CheckedExceptionImpl> checkedExceptions;
aoqi@0:     protected SOAPVersion soapVersion = SOAPVersion.SOAP_11;
aoqi@0:     protected ResponseBuilder responseBuilder;
aoqi@0:     protected MessageContextFactory packetFactory;
aoqi@0: 
aoqi@0:     public StubHandler(JavaMethodImpl method, MessageContextFactory mcf) {
aoqi@0:         //keep all the CheckedException model for the detail qname
aoqi@0:         this.checkedExceptions = new HashMap<QName, CheckedExceptionImpl>();
aoqi@0:         for(CheckedExceptionImpl ce : method.getCheckedExceptions()){
aoqi@0:             checkedExceptions.put(ce.getBond().getTypeInfo().tagName, ce);
aoqi@0:         }
aoqi@0:         //If a non-"" soapAction is specified, wsa:action the SOAPAction
aoqi@0:         String soapActionFromBinding = method.getBinding().getSOAPAction();
aoqi@0:         if(method.getInputAction() != null && soapActionFromBinding != null && !soapActionFromBinding.equals("") ) {
aoqi@0:             this.soapAction = method.getInputAction();
aoqi@0:         } else {
aoqi@0:             this.soapAction = soapActionFromBinding;
aoqi@0:         }
aoqi@0:         this.javaMethod = method;
aoqi@0:         packetFactory = mcf;
aoqi@0: 
aoqi@0:         soapVersion = javaMethod.getBinding().getSOAPVersion();
aoqi@0: 
aoqi@0:         {// prepare objects for creating messages
aoqi@0:             List<ParameterImpl> rp = method.getRequestParameters();
aoqi@0: 
aoqi@0:             BodyBuilder bodyBuilder = null;
aoqi@0:             List<MessageFiller> fillers = new ArrayList<MessageFiller>();
aoqi@0: 
aoqi@0:             for (ParameterImpl param : rp) {
aoqi@0:                 ValueGetter getter = getValueGetterFactory().get(param);
aoqi@0: 
aoqi@0:                 switch(param.getInBinding().kind) {
aoqi@0:                 case BODY:
aoqi@0:                     if(param.isWrapperStyle()) {
aoqi@0:                         if(param.getParent().getBinding().isRpcLit())
aoqi@0:                             bodyBuilder = new BodyBuilder.RpcLit((WrapperParameter)param, soapVersion, getValueGetterFactory());
aoqi@0:                         else
aoqi@0:                             bodyBuilder = new BodyBuilder.DocLit((WrapperParameter)param, soapVersion, getValueGetterFactory());
aoqi@0:                     } else {
aoqi@0:                         bodyBuilder = new BodyBuilder.Bare(param, soapVersion, getter);
aoqi@0:                     }
aoqi@0:                     break;
aoqi@0:                 case HEADER:
aoqi@0:                     fillers.add(new MessageFiller.Header(
aoqi@0:                         param.getIndex(),
aoqi@0:                         param.getXMLBridge(),
aoqi@0:                         getter ));
aoqi@0:                     break;
aoqi@0:                 case ATTACHMENT:
aoqi@0:                     fillers.add(MessageFiller.AttachmentFiller.createAttachmentFiller(param, getter));
aoqi@0:                     break;
aoqi@0:                 case UNBOUND:
aoqi@0:                     break;
aoqi@0:                 default:
aoqi@0:                     throw new AssertionError(); // impossible
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             if(bodyBuilder==null) {
aoqi@0:                 // no parameter binds to body. we create an empty message
aoqi@0:                 switch(soapVersion) {
aoqi@0:                 case SOAP_11:
aoqi@0:                     bodyBuilder = BodyBuilder.EMPTY_SOAP11;
aoqi@0:                     break;
aoqi@0:                 case SOAP_12:
aoqi@0:                     bodyBuilder = BodyBuilder.EMPTY_SOAP12;
aoqi@0:                     break;
aoqi@0:                 default:
aoqi@0:                     throw new AssertionError();
aoqi@0:                 }
aoqi@0:             }
aoqi@0: 
aoqi@0:             this.bodyBuilder = bodyBuilder;
aoqi@0:             this.inFillers = fillers.toArray(new MessageFiller[fillers.size()]);
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.isOneWay = method.getMEP().isOneWay();
aoqi@0:         responseBuilder = buildResponseBuilder(method, ValueSetterFactory.SYNC);
aoqi@0:     }
aoqi@0: 
aoqi@0:     ResponseBuilder buildResponseBuilder(JavaMethodImpl method, ValueSetterFactory setterFactory) {
aoqi@0:         // prepare objects for processing response
aoqi@0:         List<ParameterImpl> rp = method.getResponseParameters();
aoqi@0:         List<ResponseBuilder> builders = new ArrayList<ResponseBuilder>();
aoqi@0: 
aoqi@0:         for( ParameterImpl param : rp ) {
aoqi@0:             ValueSetter setter;
aoqi@0:             switch(param.getOutBinding().kind) {
aoqi@0:             case BODY:
aoqi@0:                 if(param.isWrapperStyle()) {
aoqi@0:                     if(param.getParent().getBinding().isRpcLit())
aoqi@0:                         builders.add(new ResponseBuilder.RpcLit((WrapperParameter)param, setterFactory));
aoqi@0:                     else
aoqi@0:                         builders.add(new ResponseBuilder.DocLit((WrapperParameter)param, setterFactory));
aoqi@0:                 } else {
aoqi@0:                     setter = setterFactory.get(param);
aoqi@0:                     builders.add(new ResponseBuilder.Body(param.getXMLBridge(),setter));
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0:             case HEADER:
aoqi@0:                 setter = setterFactory.get(param);
aoqi@0:                 builders.add(new ResponseBuilder.Header(soapVersion, param, setter));
aoqi@0:                 break;
aoqi@0:             case ATTACHMENT:
aoqi@0:                 setter = setterFactory.get(param);
aoqi@0:                 builders.add(ResponseBuilder.AttachmentBuilder.createAttachmentBuilder(param, setter));
aoqi@0:                 break;
aoqi@0:             case UNBOUND:
aoqi@0:                 setter = setterFactory.get(param);
aoqi@0:                 builders.add(new ResponseBuilder.NullSetter(setter,
aoqi@0:                     ResponseBuilder.getVMUninitializedValue(param.getTypeInfo().type)));
aoqi@0:                 break;
aoqi@0:             default:
aoqi@0:                 throw new AssertionError();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         ResponseBuilder rb;
aoqi@0:         switch(builders.size()) {
aoqi@0:         case 0:
aoqi@0:             rb = ResponseBuilder.NONE;
aoqi@0:             break;
aoqi@0:         case 1:
aoqi@0:             rb = builders.get(0);
aoqi@0:             break;
aoqi@0:         default:
aoqi@0:             rb = new ResponseBuilder.Composite(builders);
aoqi@0:         }
aoqi@0:         return rb;
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a request {@link com.sun.xml.internal.ws.message.jaxb.JAXBMessage} from method arguments.
aoqi@0:      * @param args proxy invocation arguments
aoqi@0:      * @return Message for the arguments
aoqi@0:      */
aoqi@0:     public Packet createRequestPacket(JavaCallInfo args) {
aoqi@0:         Message msg = bodyBuilder.createMessage(args.getParameters());
aoqi@0: 
aoqi@0:         for (MessageFiller filler : inFillers) filler.fillIn(args.getParameters(),msg);
aoqi@0: 
aoqi@0:         Packet req = (Packet)packetFactory.createContext(msg);
aoqi@0:         req.setState(Packet.State.ClientRequest);
aoqi@0:         req.soapAction = soapAction;
aoqi@0:         req.expectReply = !isOneWay;
aoqi@0:         req.getMessage().assertOneWay(isOneWay);
aoqi@0:         req.setWSDLOperation(getOperationName());
aoqi@0:         return req;
aoqi@0:     }
aoqi@0: 
aoqi@0:     ValueGetterFactory getValueGetterFactory() {
aoqi@0:         return ValueGetterFactory.SYNC;
aoqi@0:     }
aoqi@0: 
aoqi@0:         public JavaCallInfo readResponse(Packet p, JavaCallInfo call) throws Throwable {
aoqi@0:                 Message msg = p.getMessage();
aoqi@0:         if(msg.isFault()) {
aoqi@0:             SOAPFaultBuilder faultBuilder = SOAPFaultBuilder.create(msg);
aoqi@0:             Throwable t = faultBuilder.createException(checkedExceptions);
aoqi@0:             call.setException(t);
aoqi@0:             throw t;
aoqi@0:         } else {
aoqi@0:                 initArgs(call.getParameters());
aoqi@0:             Object ret = responseBuilder.readResponse(msg, call.getParameters());
aoqi@0:             call.setReturnValue(ret);
aoqi@0:             return call;
aoqi@0:         }
aoqi@0:         }
aoqi@0: 
aoqi@0:         public QName getOperationName() {
aoqi@0:                 //TODO javaMethod.getOperation()
aoqi@0:                 return javaMethod.getOperationQName();
aoqi@0:         }
aoqi@0: 
aoqi@0:         public String getSoapAction() {
aoqi@0:                 return soapAction;
aoqi@0:         }
aoqi@0: 
aoqi@0:         public boolean isOneWay() {
aoqi@0:                 return isOneWay;
aoqi@0:         }
aoqi@0: 
aoqi@0:         protected void initArgs(Object[] args) throws Exception {
aoqi@0:         }
aoqi@0: 
aoqi@0:         public Method getMethod() {
aoqi@0:                 return javaMethod.getMethod();
aoqi@0:         }
aoqi@0: 
aoqi@0:     public JavaMethod getOperationModel() {
aoqi@0:         return javaMethod;
aoqi@0:     }
aoqi@0: }