Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.api.databinding; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.io.IOException; |
aoqi@0 | 29 | import java.io.InputStream; |
aoqi@0 | 30 | import java.io.OutputStream; |
aoqi@0 | 31 | import java.lang.reflect.Method; |
aoqi@0 | 32 | |
aoqi@0 | 33 | import com.sun.xml.internal.ws.api.message.MessageContextFactory; |
aoqi@0 | 34 | import com.sun.xml.internal.ws.api.message.Packet; |
aoqi@0 | 35 | import com.sun.xml.internal.ws.api.pipe.ContentType; |
aoqi@0 | 36 | import com.sun.xml.internal.ws.wsdl.DispatchException; |
aoqi@0 | 37 | |
aoqi@0 | 38 | /** |
aoqi@0 | 39 | * {@code Databinding} is the entry point for all the WebService databinding |
aoqi@0 | 40 | * runtime functionality. Primarily, a Databinding is to serialize/deserialize an |
aoqi@0 | 41 | * XML(SOAP) message to/from a JAVA method invocation and return value which |
aoqi@0 | 42 | * are represented as <code>JavaCallInfo</code> instances. |
aoqi@0 | 43 | * <p> |
aoqi@0 | 44 | * </p> |
aoqi@0 | 45 | * Each Databinding is associated with a <code>MessageFactory</code> instance |
aoqi@0 | 46 | * which can be used to create <code>Message</code> instances that can be |
aoqi@0 | 47 | * deserialized by the Databinding. The <code>MessageFactory</code> also supports |
aoqi@0 | 48 | * the conversion of Oracle Fabric Normalized messages. |
aoqi@0 | 49 | * <p> |
aoqi@0 | 50 | * </p> |
aoqi@0 | 51 | * <blockquote> Following is an example that creates a {@code Databinding} which |
aoqi@0 | 52 | * provides the operations to serialize/deserialize a JavaCallInfo to/from a |
aoqi@0 | 53 | * SOAP message:<br /> |
aoqi@0 | 54 | * |
aoqi@0 | 55 | * <pre> |
aoqi@0 | 56 | * DatabindingFactory wsfac = DatabindingFactory(); |
aoqi@0 | 57 | * Databinding rt = wsfac.createDatabinding(DatabindingConfig); |
aoqi@0 | 58 | * </pre> |
aoqi@0 | 59 | * |
aoqi@0 | 60 | * </blockquote> |
aoqi@0 | 61 | * |
aoqi@0 | 62 | * @author shih-chang.chen@oracle.com |
aoqi@0 | 63 | */ |
aoqi@0 | 64 | public interface Databinding extends com.oracle.webservices.internal.api.databinding.Databinding { |
aoqi@0 | 65 | |
aoqi@0 | 66 | /** |
aoqi@0 | 67 | * Gets the MessageFactory instance associated with this WsRuntime |
aoqi@0 | 68 | * |
aoqi@0 | 69 | * @return the MessageFactory instance associated with this WsRuntime |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | // MessageFactory getMessageFactory(); |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Deserializes a request XML(SOAP) message to a JavaCallInfo instance |
aoqi@0 | 75 | * representing a JAVA method call. |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * @param soap |
aoqi@0 | 78 | * the request message |
aoqi@0 | 79 | * |
aoqi@0 | 80 | * @return the JavaCallInfo representing a method call |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | // JavaCallInfo deserializeRequest(Packet req); |
aoqi@0 | 83 | |
aoqi@0 | 84 | EndpointCallBridge getEndpointBridge(Packet soap) throws DispatchException; |
aoqi@0 | 85 | |
aoqi@0 | 86 | ClientCallBridge getClientBridge(Method method); |
aoqi@0 | 87 | |
aoqi@0 | 88 | /** |
aoqi@0 | 89 | * Serializes a JavaCallInfo instance representing a JAVA method call to a |
aoqi@0 | 90 | * request XML(SOAP) message. |
aoqi@0 | 91 | * |
aoqi@0 | 92 | * @param call |
aoqi@0 | 93 | * the JavaCallInfo representing a method call |
aoqi@0 | 94 | * |
aoqi@0 | 95 | * @return the request XML(SOAP) message |
aoqi@0 | 96 | */ |
aoqi@0 | 97 | // Packet serializeRequest(JavaCallInfo call); |
aoqi@0 | 98 | |
aoqi@0 | 99 | /** |
aoqi@0 | 100 | * Serializes a JavaCallInfo instance representing the return value or |
aoqi@0 | 101 | * exception of a JAVA method call to a response XML(SOAP) message. |
aoqi@0 | 102 | * |
aoqi@0 | 103 | * @param call |
aoqi@0 | 104 | * the JavaCallInfo representing the return value or exception of |
aoqi@0 | 105 | * a JAVA method call |
aoqi@0 | 106 | * |
aoqi@0 | 107 | * @return the response XML(SOAP) message |
aoqi@0 | 108 | */ |
aoqi@0 | 109 | // Packet serializeResponse(JavaCallInfo call); |
aoqi@0 | 110 | |
aoqi@0 | 111 | /** |
aoqi@0 | 112 | * Deserializes a response XML(SOAP) message to a JavaCallInfo instance |
aoqi@0 | 113 | * representing the return value or exception of a JAVA method call. |
aoqi@0 | 114 | * |
aoqi@0 | 115 | * @param soap |
aoqi@0 | 116 | * the response message |
aoqi@0 | 117 | * |
aoqi@0 | 118 | * @param call |
aoqi@0 | 119 | * the JavaCallInfo instance to be updated |
aoqi@0 | 120 | * |
aoqi@0 | 121 | * @return the JavaCallInfo updated with the return value or exception of a |
aoqi@0 | 122 | * JAVA method call |
aoqi@0 | 123 | */ |
aoqi@0 | 124 | // JavaCallInfo deserializeResponse(Packet res, JavaCallInfo call); |
aoqi@0 | 125 | |
aoqi@0 | 126 | /** |
aoqi@0 | 127 | * Gets the WSDL operation metadata of the specified JAVA method. |
aoqi@0 | 128 | * |
aoqi@0 | 129 | * @param method |
aoqi@0 | 130 | * the JAVA method |
aoqi@0 | 131 | * @return the operationMetadata |
aoqi@0 | 132 | */ |
aoqi@0 | 133 | // OperationMetadata getOperationMetadata(java.lang.reflect.Method method); |
aoqi@0 | 134 | |
aoqi@0 | 135 | /** |
aoqi@0 | 136 | * Gets the WebServiceFeatures of this webservice endpoint. |
aoqi@0 | 137 | * |
aoqi@0 | 138 | * @return the features |
aoqi@0 | 139 | */ |
aoqi@0 | 140 | // WebServiceFeature[] getFeatures(); |
aoqi@0 | 141 | |
aoqi@0 | 142 | void generateWSDL(WSDLGenInfo info); |
aoqi@0 | 143 | |
aoqi@0 | 144 | /** |
aoqi@0 | 145 | * @deprecated use MessageContextFactory |
aoqi@0 | 146 | */ |
aoqi@0 | 147 | public ContentType encode( Packet packet, OutputStream out ) throws IOException ; |
aoqi@0 | 148 | |
aoqi@0 | 149 | /** |
aoqi@0 | 150 | * @deprecated use MessageContextFactory |
aoqi@0 | 151 | */ |
aoqi@0 | 152 | public void decode( InputStream in, String ct, Packet packet ) throws IOException; |
aoqi@0 | 153 | |
aoqi@0 | 154 | public MessageContextFactory getMessageContextFactory(); |
aoqi@0 | 155 | } |