ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.encoding;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.xml.internal.ws.api.message.AttachmentSet;
ohair@286: import com.sun.xml.internal.ws.api.message.Message;
ohair@286: import com.sun.xml.internal.ws.api.message.Packet;
ohair@286: import com.sun.xml.internal.ws.api.pipe.Codec;
ohair@286: 
ohair@286: import java.io.IOException;
ohair@286: import java.io.InputStream;
ohair@286: import java.nio.channels.ReadableByteChannel;
ohair@286: 
ohair@286: /**
ohair@286:  * {@link Codec} that works only on the root part of the MIME/multipart.
ohair@286:  * It doesn't work on the attachment parts, so it takes {@link AttachmentSet}
ohair@286:  * as an argument and creates a corresponding {@link Message}. This enables
ohair@286:  * attachments to be parsed lazily by wrapping the mimepull parser into an
ohair@286:  * {@link AttachmentSet}
ohair@286:  *
ohair@286:  * @author Jitendra Kotamraju
ohair@286:  */
ohair@286: public interface RootOnlyCodec extends Codec {
ohair@286: 
ohair@286:     /**
ohair@286:      * Reads root part bytes from {@link InputStream} and constructs a {@link Message}
ohair@286:      * along with the given attachments.
ohair@286:      *
ohair@286:      * @param in root part's data
ohair@286:      *
ohair@286:      * @param contentType root part's MIME content type (like "application/xml")
ohair@286:      *
ohair@286:      * @param packet the new created {@link Message} is set in this packet
ohair@286:      *
ohair@286:      * @param att attachments
ohair@286:      *
ohair@286:      * @throws IOException
ohair@286:      *      if {@link InputStream} throws an exception.
ohair@286:      */
ohair@286:     void decode(@NotNull InputStream in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att)
ohair@286:             throws IOException;
ohair@286: 
ohair@286:     /**
ohair@286:      *
ohair@286:      * @see #decode(InputStream, String, Packet, AttachmentSet)
ohair@286:      */
ohair@286:     void decode(@NotNull ReadableByteChannel in, @NotNull String contentType, @NotNull Packet packet, @NotNull AttachmentSet att);
ohair@286: }