/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.xml.internal.ws.api.pipe;

import com.sun.istack.internal.NotNull;
import com.sun.xml.internal.ws.api.message.Message;
import com.sun.xml.internal.ws.api.message.AttachmentSet;

import javax.xml.stream.XMLStreamReader;

Reads events from XMLStreamReader and constructs a Message for SOAP envelope. Codecs allows a way to construct a whole codec that can handle MTOM, MIME encoded packages using this codec.
Author:Jitendra Kotamraju
See Also:
/** * Reads events from {@link XMLStreamReader} and constructs a * {@link Message} for SOAP envelope. {@link Codecs} allows a * way to construct a whole codec that can handle MTOM, MIME * encoded packages using this codec. * * * @see Codecs * @author Jitendra Kotamraju */
public interface StreamSOAPCodec extends Codec {
Reads events from XMLStreamReader and constructs a Message for SOAP envelope.
Params:
  • reader – that represents SOAP envelope infoset
Returns:a Message for SOAP envelope
/** * Reads events from {@link XMLStreamReader} and constructs a * {@link Message} for SOAP envelope. * * @param reader that represents SOAP envelope infoset * @return a {@link Message} for SOAP envelope */
public @NotNull Message decode(@NotNull XMLStreamReader reader);
Reads events from XMLStreamReader and constructs a Message for SOAP envelope.
Params:
  • reader – that represents SOAP envelope infoset
  • att – attachments for the message
Returns:a Message for SOAP envelope
/** * Reads events from {@link XMLStreamReader} and constructs a * {@link Message} for SOAP envelope. * * @param reader that represents SOAP envelope infoset * @param att attachments for the message * @return a {@link Message} for SOAP envelope */
public @NotNull Message decode(@NotNull XMLStreamReader reader, @NotNull AttachmentSet att); }