01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.pipe;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.xml.ws.api.SOAPVersion;
41: import com.sun.xml.ws.api.WSBinding;
42:
43: /**
44: * Factory methods for some of the {@link Codec} implementations.
45: *
46: * <p>
47: * This class provides methods to create codecs for SOAP/HTTP binding.
48: * It allows to replace default SOAP envelope(primary part in MIME message)
49: * codec in the whole Codec.
50: *
51: * <p>
52: * This is a part of the JAX-WS RI internal API so that
53: * {@link Tube} and transport implementations can reuse the implementations
54: * done inside the JAX-WS.
55: *
56: * @author Jitendra Kotamraju
57: * @author Kohsuke Kawaguchi
58: */
59: public abstract class Codecs {
60:
61: /**
62: * This creates a full {@link Codec} for SOAP binding using the primary
63: * XML codec argument. The codec argument is used to encode/decode SOAP envelopes
64: * while the returned codec is responsible for encoding/decoding the whole
65: * message.
66: *
67: * <p>
68: * Creates codecs can be set during the {@link Tube}line assembly process.
69: *
70: * @see ServerTubeAssemblerContext#setCodec(Codec)
71: * @see ClientTubeAssemblerContext#setCodec(Codec)
72: *
73: * @param binding binding of the webservice
74: * @param xmlEnvelopeCodec SOAP envelope codec
75: * @return non null codec to parse entire SOAP message(including MIME parts)
76: */
77: public static @NotNull
78: SOAPBindingCodec createSOAPBindingCodec(WSBinding binding,
79: StreamSOAPCodec xmlEnvelopeCodec) {
80: return new com.sun.xml.ws.encoding.SOAPBindingCodec(binding,
81: xmlEnvelopeCodec);
82: }
83:
84: /**
85: * Creates a default {@link Codec} that can be used to used to
86: * decode XML infoset in SOAP envelope(primary part in MIME message). New codecs
87: * can be written using this codec as delegate.
88: *
89: * @param version SOAP version of the binding
90: * @return non null default xml codec
91: */
92: public static @NotNull
93: StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull
94: SOAPVersion version) {
95: return com.sun.xml.ws.encoding.StreamSOAPCodec.create(version);
96: }
97: }
|