All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.api.pipe.Codecs Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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;
import com.sun.xml.ws.api.WSFeatureList;

/**
 * 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. * * @param feature the WebServiceFeature objects * @return non null codec to parse entire SOAP message(including MIME parts) */ public static @NotNull SOAPBindingCodec createSOAPBindingCodec(WSFeatureList feature) { return new com.sun.xml.ws.encoding.SOAPBindingCodec(feature); } /** * This creates a full {@link Codec} for XML binding. * * @param feature the WebServiceFeature objects * @return non null codec to parse entire XML message. */ public static @NotNull Codec createXMLCodec(WSFeatureList feature) { return new com.sun.xml.ws.encoding.XMLHTTPBindingCodec(feature); } /** * 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.getFeatures(), 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); } /** * 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. WSBinding * parameter is used to get SOAP version and features. * * @param binding SOAP version and features are used from this binding * @return non null default xml codec * * @deprecated use {@link #createSOAPEnvelopeXmlCodec(WSFeatureList)} */ public static @NotNull StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull WSBinding binding) { return com.sun.xml.ws.encoding.StreamSOAPCodec.create(binding); } /** * 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. WSFeatureList * parameter is used to get SOAP version and features. * * @param features SOAP version and features are used from this WSFeatureList * @return non null default xml codec */ public static @NotNull StreamSOAPCodec createSOAPEnvelopeXmlCodec(@NotNull WSFeatureList features) { return com.sun.xml.ws.encoding.StreamSOAPCodec.create(features); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy