src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/Codecs.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.pipe;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.xml.internal.ws.api.SOAPVersion;
ohair@286 30 import com.sun.xml.internal.ws.api.WSBinding;
ohair@286 31 import com.sun.xml.internal.ws.api.WSFeatureList;
ohair@286 32
ohair@286 33 /**
ohair@286 34 * Factory methods for some of the {@link Codec} implementations.
ohair@286 35 *
ohair@286 36 * <p>
ohair@286 37 * This class provides methods to create codecs for SOAP/HTTP binding.
ohair@286 38 * It allows to replace default SOAP envelope(primary part in MIME message)
ohair@286 39 * codec in the whole Codec.
ohair@286 40 *
ohair@286 41 * <p>
ohair@286 42 * This is a part of the JAX-WS RI internal API so that
ohair@286 43 * {@link Tube} and transport implementations can reuse the implementations
ohair@286 44 * done inside the JAX-WS.
ohair@286 45 *
ohair@286 46 * @author Jitendra Kotamraju
ohair@286 47 * @author Kohsuke Kawaguchi
ohair@286 48 */
ohair@286 49 public abstract class Codecs {
ohair@286 50
ohair@286 51 /**
ohair@286 52 * This creates a full {@link Codec} for SOAP binding.
ohair@286 53 *
ohair@286 54 * @param feature the WebServiceFeature objects
ohair@286 55 * @return non null codec to parse entire SOAP message(including MIME parts)
ohair@286 56 */
ohair@286 57 public static @NotNull SOAPBindingCodec createSOAPBindingCodec(WSFeatureList feature) {
ohair@286 58 return new com.sun.xml.internal.ws.encoding.SOAPBindingCodec(feature);
ohair@286 59 }
ohair@286 60
ohair@286 61 /**
ohair@286 62 * This creates a full {@link Codec} for XML binding.
ohair@286 63 *
ohair@286 64 * @param feature the WebServiceFeature objects
ohair@286 65 * @return non null codec to parse entire XML message.
ohair@286 66 */
ohair@286 67 public static @NotNull Codec createXMLCodec(WSFeatureList feature) {
ohair@286 68 return new com.sun.xml.internal.ws.encoding.XMLHTTPBindingCodec(feature);
ohair@286 69 }
ohair@286 70
ohair@286 71
ohair@286 72 /**
ohair@286 73 * This creates a full {@link Codec} for SOAP binding using the primary
ohair@286 74 * XML codec argument. The codec argument is used to encode/decode SOAP envelopes
ohair@286 75 * while the returned codec is responsible for encoding/decoding the whole
ohair@286 76 * message.
ohair@286 77 *
ohair@286 78 * <p>
ohair@286 79 * Creates codecs can be set during the {@link Tube}line assembly process.
ohair@286 80 *
ohair@286 81 * @see ServerTubeAssemblerContext#setCodec(Codec)
ohair@286 82 * @see ClientTubeAssemblerContext#setCodec(Codec)
ohair@286 83 *
ohair@286 84 * @param binding binding of the webservice
ohair@286 85 * @param xmlEnvelopeCodec SOAP envelope codec
ohair@286 86 * @return non null codec to parse entire SOAP message(including MIME parts)
ohair@286 87 */
ohair@286 88 public static @NotNull SOAPBindingCodec createSOAPBindingCodec(WSBinding binding, StreamSOAPCodec xmlEnvelopeCodec) {
ohair@286 89 return new com.sun.xml.internal.ws.encoding.SOAPBindingCodec(binding.getFeatures(), xmlEnvelopeCodec);
ohair@286 90 }
ohair@286 91
ohair@286 92 /**
ohair@286 93 * Creates a default {@link Codec} that can be used to used to
ohair@286 94 * decode XML infoset in SOAP envelope(primary part in MIME message). New codecs
ohair@286 95 * can be written using this codec as delegate.
ohair@286 96 *
ohair@286 97 * @param version SOAP version of the binding
ohair@286 98 * @return non null default xml codec
ohair@286 99 */
ohair@286 100 public static @NotNull
ohair@286 101 StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull SOAPVersion version) {
ohair@286 102 return com.sun.xml.internal.ws.encoding.StreamSOAPCodec.create(version);
ohair@286 103 }
ohair@286 104
ohair@286 105 /**
ohair@286 106 * Creates a default {@link Codec} that can be used to used to
ohair@286 107 * decode XML infoset in SOAP envelope(primary part in MIME message).
ohair@286 108 * New codecs can be written using this codec as delegate. WSBinding
ohair@286 109 * parameter is used to get SOAP version and features.
ohair@286 110 *
ohair@286 111 * @param binding SOAP version and features are used from this binding
ohair@286 112 * @return non null default xml codec
ohair@286 113 *
ohair@286 114 * @deprecated use {@link #createSOAPEnvelopeXmlCodec(WSFeatureList)}
ohair@286 115 */
ohair@286 116 public static @NotNull StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull WSBinding binding) {
ohair@286 117 return com.sun.xml.internal.ws.encoding.StreamSOAPCodec.create(binding);
ohair@286 118 }
ohair@286 119
ohair@286 120 /**
ohair@286 121 * Creates a default {@link Codec} that can be used to used to
ohair@286 122 * decode XML infoset in SOAP envelope(primary part in MIME message).
ohair@286 123 * New codecs can be written using this codec as delegate. WSFeatureList
ohair@286 124 * parameter is used to get SOAP version and features.
ohair@286 125 *
ohair@286 126 * @param features SOAP version and features are used from this WSFeatureList
ohair@286 127 * @return non null default xml codec
ohair@286 128 */
ohair@286 129 public static @NotNull StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull WSFeatureList features) {
ohair@286 130 return com.sun.xml.internal.ws.encoding.StreamSOAPCodec.create(features);
ohair@286 131 }
ohair@286 132 }

mercurial