1/*
2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.ws.api.pipe;
27
28import com.sun.istack.internal.NotNull;
29import com.sun.xml.internal.ws.api.message.Message;
30import com.sun.xml.internal.ws.api.message.AttachmentSet;
31
32import javax.xml.stream.XMLStreamReader;
33
34/**
35 * Reads events from {@link XMLStreamReader} and constructs a
36 * {@link Message} for SOAP envelope. {@link Codecs} allows a
37 * way to construct a whole codec that can handle MTOM, MIME
38 * encoded packages using this codec.
39 *
40 *
41 * @see Codecs
42 * @author Jitendra Kotamraju
43 */
44public interface StreamSOAPCodec extends Codec {
45    /**
46     * Reads events from {@link XMLStreamReader} and constructs a
47     * {@link Message} for SOAP envelope.
48     *
49     * @param reader that represents SOAP envelope infoset
50     * @return a {@link Message} for SOAP envelope
51     */
52    public @NotNull Message decode(@NotNull XMLStreamReader reader);
53
54    /**
55     * Reads events from {@link XMLStreamReader} and constructs a
56     * {@link Message} for SOAP envelope.
57     *
58     * @param reader that represents SOAP envelope infoset
59     * @param att attachments for the message
60     * @return a {@link Message} for SOAP envelope
61     */
62    public @NotNull Message decode(@NotNull XMLStreamReader reader, @NotNull AttachmentSet att);
63}
64