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.api.message;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: 
ohair@286: import javax.activation.DataHandler;
ohair@286: import javax.xml.soap.SOAPMessage;
ohair@286: import javax.xml.soap.SOAPException;
ohair@286: import javax.xml.transform.Source;
ohair@286: import java.io.IOException;
ohair@286: import java.io.InputStream;
ohair@286: import java.io.OutputStream;
ohair@286: 
ohair@286: /**
ohair@286:  * Attachment.
ohair@286:  */
ohair@286: public interface Attachment {
ohair@286: 
ohair@286:     /**
ohair@286:      * Content ID of the attachment. Uniquely identifies an attachment.
ohair@286:      *
alanb@368:      * http://www.ietf.org/rfc/rfc2392.txt (which is referred by the ws-i attachment profile
alanb@368:      * http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html)
alanb@368:      *
alanb@368:      * content-id    = url-addr-spec
alanb@368:      * url-addr-spec = addr-spec  ; URL encoding of RFC 822 addr-spec
alanb@368:      * cid-url       = "cid" ":" content-id
alanb@368:      *
alanb@368:      * A "cid" URL is converted to the corresponding Content-ID message header [MIME] by
alanb@368:      * removing the "cid:" prefix, converting the % encoded character to their equivalent
alanb@368:      * US-ASCII characters, and enclosing the remaining parts with an angle bracket pair,
alanb@368:      * "<" and ">".  For  example, "cid:foo4%25foo1@bar.net" corresponds to
alanb@368:      *      Content-ID: <foo4%25foo1@bar.net>
alanb@368:      *
ohair@286:      * @return
ohair@286:      *      The content ID like "foo-bar-zot@abc.com", without
ohair@286:      *      surrounding '&lt;' and '>' used as the transfer syntax.
ohair@286:      */
ohair@286:     @NotNull String getContentId();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the MIME content-type of this attachment.
ohair@286:      */
ohair@286:     String getContentType();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the attachment as an exact-length byte array.
ohair@286:      */
ohair@286:     byte[] asByteArray();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the attachment as a {@link DataHandler}.
ohair@286:      */
ohair@286:     DataHandler asDataHandler();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the attachment as a {@link Source}.
ohair@286:      * Note that there's no guarantee that the attachment is actually an XML.
ohair@286:      */
ohair@286:     Source asSource();
ohair@286: 
ohair@286:     /**
ohair@286:      * Obtains this attachment as an {@link InputStream}.
ohair@286:      */
ohair@286:     InputStream asInputStream();
ohair@286: 
ohair@286:     /**
ohair@286:      * Writes the contents of the attachment into the given stream.
ohair@286:      */
ohair@286:     void writeTo(OutputStream os) throws IOException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Writes this attachment to the given {@link SOAPMessage}.
ohair@286:      */
ohair@286:     void writeTo(SOAPMessage saaj) throws SOAPException;
ohair@286: }