/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.xml.internal.ws.api.message;

import com.sun.istack.internal.NotNull;

import javax.activation.DataHandler;
import javax.xml.soap.SOAPMessage;
import javax.xml.soap.SOAPException;
import javax.xml.transform.Source;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

Attachment.
/**
 * Attachment.
 */
public interface Attachment {

    
Content ID of the attachment. Uniquely identifies an attachment.
http://www.ietf.org/rfc/rfc2392.txt (which is referred by the ws-i attachment profile
http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html)
content-id    = url-addr-spec
url-addr-spec = addr-spec  ; URL encoding of RFC 822 addr-spec
cid-url       = "cid" ":" content-id
A "cid" URL is converted to the corresponding Content-ID message header [MIME] by
removing the "cid:" prefix, converting the % encoded character to their equivalent
US-ASCII characters, and enclosing the remaining parts with an angle bracket pair,
"<" and ">".  For  example, "cid:foo4%25foo1@bar.net" corresponds to
     Content-ID: 
Returns:

     The content ID like "foo-bar-zot@abc.com", without
     surrounding '<' and '>' used as the transfer syntax./**
     * Content ID of the attachment. Uniquely identifies an attachment.
     *
     * http://www.ietf.org/rfc/rfc2392.txt (which is referred by the ws-i attachment profile
     * http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html)
     *
     * content-id    = url-addr-spec
     * url-addr-spec = addr-spec  ; URL encoding of RFC 822 addr-spec
     * cid-url       = "cid" ":" content-id
     *
     * A "cid" URL is converted to the corresponding Content-ID message header [MIME] by
     * removing the "cid:" prefix, converting the % encoded character to their equivalent
     * US-ASCII characters, and enclosing the remaining parts with an angle bracket pair,
     * "<" and ">".  For  example, "cid:foo4%25foo1@bar.net" corresponds to
     *      Content-ID: <foo4%25foo1@bar.net>
     *
     * @return
     *      The content ID like "foo-bar-zot@abc.com", without
     *      surrounding '&lt;' and '>' used as the transfer syntax.
     */
    @NotNull String getContentId();

    
Gets the MIME content-type of this attachment.
/**
     * Gets the MIME content-type of this attachment.
     */
    String getContentType();

    
Gets the attachment as an exact-length byte array.
/**
     * Gets the attachment as an exact-length byte array.
     */
    byte[] asByteArray();

    
Gets the attachment as a DataHandler. /**
     * Gets the attachment as a {@link DataHandler}.
     */
    DataHandler asDataHandler();

    
Gets the attachment as a Source. Note that there's no guarantee that the attachment is actually an XML. /**
     * Gets the attachment as a {@link Source}.
     * Note that there's no guarantee that the attachment is actually an XML.
     */
    Source asSource();

    
Obtains this attachment as an InputStream. /**
     * Obtains this attachment as an {@link InputStream}.
     */
    InputStream asInputStream();

    
Writes the contents of the attachment into the given stream.
/**
     * Writes the contents of the attachment into the given stream.
     */
    void writeTo(OutputStream os) throws IOException;

    
Writes this attachment to the given SOAPMessage. /**
     * Writes this attachment to the given {@link SOAPMessage}.
     */
    void writeTo(SOAPMessage saaj) throws SOAPException;
}