src/share/jaxws_classes/com/sun/xml/internal/ws/encoding/RootOnlyCodec.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.xml.internal.ws.encoding;
aoqi@0 27
aoqi@0 28 import com.sun.istack.internal.NotNull;
aoqi@0 29 import com.sun.xml.internal.ws.api.message.AttachmentSet;
aoqi@0 30 import com.sun.xml.internal.ws.api.message.Message;
aoqi@0 31 import com.sun.xml.internal.ws.api.message.Packet;
aoqi@0 32 import com.sun.xml.internal.ws.api.pipe.Codec;
aoqi@0 33
aoqi@0 34 import java.io.IOException;
aoqi@0 35 import java.io.InputStream;
aoqi@0 36 import java.nio.channels.ReadableByteChannel;
aoqi@0 37
aoqi@0 38 /**
aoqi@0 39 * {@link Codec} that works only on the root part of the MIME/multipart.
aoqi@0 40 * It doesn't work on the attachment parts, so it takes {@link AttachmentSet}
aoqi@0 41 * as an argument and creates a corresponding {@link Message}. This enables
aoqi@0 42 * attachments to be parsed lazily by wrapping the mimepull parser into an
aoqi@0 43 * {@link AttachmentSet}
aoqi@0 44 *
aoqi@0 45 * @author Jitendra Kotamraju
aoqi@0 46 */
aoqi@0 47 public interface RootOnlyCodec extends Codec {
aoqi@0 48
aoqi@0 49 /**
aoqi@0 50 * Reads root part bytes from {@link InputStream} and constructs a {@link Message}
aoqi@0 51 * along with the given attachments.
aoqi@0 52 *
aoqi@0 53 * @param in root part's data
aoqi@0 54 *
aoqi@0 55 * @param contentType root part's MIME content type (like "application/xml")
aoqi@0 56 *
aoqi@0 57 * @param packet the new created {@link Message} is set in this packet
aoqi@0 58 *
aoqi@0 59 * @param att attachments
aoqi@0 60 *
aoqi@0 61 * @throws IOException
aoqi@0 62 * if {@link InputStream} throws an exception.
aoqi@0 63 */
aoqi@0 64 void decode(@NotNull InputStream in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att)
aoqi@0 65 throws IOException;
aoqi@0 66
aoqi@0 67 /**
aoqi@0 68 *
aoqi@0 69 * @see #decode(InputStream, String, Packet, AttachmentSet)
aoqi@0 70 */
aoqi@0 71 void decode(@NotNull ReadableByteChannel in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att);
aoqi@0 72 }

mercurial