com.sun.xml.ws.api.pipe.Codecs Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.api.pipe;
import com.sun.istack.NotNull;
import com.sun.xml.ws.api.SOAPVersion;
import com.sun.xml.ws.api.WSBinding;
/**
* Factory methods for some of the {@link Codec} implementations.
*
*
* This class provides methods to create codecs for SOAP/HTTP binding.
* It allows to replace default SOAP envelope(primary part in MIME message)
* codec in the whole Codec.
*
*
* This is a part of the JAX-WS RI internal API so that
* {@link Tube} and transport implementations can reuse the implementations
* done inside the JAX-WS.
*
* @author Jitendra Kotamraju
* @author Kohsuke Kawaguchi
*/
public abstract class Codecs {
/**
* This creates a full {@link Codec} for SOAP binding using the primary
* XML codec argument. The codec argument is used to encode/decode SOAP envelopes
* while the returned codec is responsible for encoding/decoding the whole
* message.
*
*
* Creates codecs can be set during the {@link Tube}line assembly process.
*
* @see ServerTubeAssemblerContext#setCodec(Codec)
* @see ClientTubeAssemblerContext#setCodec(Codec)
*
* @param binding binding of the webservice
* @param xmlEnvelopeCodec SOAP envelope codec
* @return non null codec to parse entire SOAP message(including MIME parts)
*/
public static @NotNull SOAPBindingCodec createSOAPBindingCodec(WSBinding binding, StreamSOAPCodec xmlEnvelopeCodec) {
return new com.sun.xml.ws.encoding.SOAPBindingCodec(binding, xmlEnvelopeCodec);
}
/**
* Creates a default {@link Codec} that can be used to used to
* decode XML infoset in SOAP envelope(primary part in MIME message). New codecs
* can be written using this codec as delegate.
*
* @param version SOAP version of the binding
* @return non null default xml codec
*/
public static @NotNull
StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull SOAPVersion version) {
return com.sun.xml.ws.encoding.StreamSOAPCodec.create(version);
}
}