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

Fri, 14 Feb 2014 11:13:45 +0100

author
mkos
date
Fri, 14 Feb 2014 11:13:45 +0100
changeset 515
6cd506508147
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8026188: Enhance envelope factory
Summary: Avoiding caching data initialized via TCCL in static context; fix also reviewed by Alexander Fomin
Reviewed-by: ahgross, mgrebac, skoivu

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

mercurial