1 /* 2 * Copyright (c) 1997, 2012, 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 26 package com.sun.xml.internal.ws.encoding; 27 28 import com.sun.istack.internal.NotNull; 29 import com.sun.xml.internal.ws.api.message.AttachmentSet; 30 import com.sun.xml.internal.ws.api.message.Message; 31 import com.sun.xml.internal.ws.api.message.Packet; 32 import com.sun.xml.internal.ws.api.pipe.Codec; 33 34 import java.io.IOException; 35 import java.io.InputStream; 36 import java.nio.channels.ReadableByteChannel; 37 38 /** 39 * {@link Codec} that works only on the root part of the MIME/multipart. 40 * It doesn't work on the attachment parts, so it takes {@link AttachmentSet} 41 * as an argument and creates a corresponding {@link Message}. This enables 42 * attachments to be parsed lazily by wrapping the mimepull parser into an 43 * {@link AttachmentSet} 44 * 45 * @author Jitendra Kotamraju 46 */ 47 public interface RootOnlyCodec extends Codec { 48 49 /** 50 * Reads root part bytes from {@link InputStream} and constructs a {@link Message} 51 * along with the given attachments. 52 * 53 * @param in root part's data 54 * 55 * @param contentType root part's MIME content type (like "application/xml") 56 * 57 * @param packet the new created {@link Message} is set in this packet 58 * 59 * @param att attachments 60 * 61 * @throws IOException 62 * if {@link InputStream} throws an exception. 63 */ decode(@otNull InputStream in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att)64 void decode(@NotNull InputStream in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att) 65 throws IOException; 66 67 /** 68 * 69 * @see #decode(InputStream, String, Packet, AttachmentSet) 70 */ decode(@otNull ReadableByteChannel in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att)71 void decode(@NotNull ReadableByteChannel in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att); 72 } 73