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.api.message;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 
  30 import javax.activation.DataHandler;
  31 import javax.xml.soap.SOAPMessage;
  32 import javax.xml.soap.SOAPException;
  33 import javax.xml.transform.Source;
  34 import java.io.IOException;
  35 import java.io.InputStream;
  36 import java.io.OutputStream;
  37 
  38 /**
  39  * Attachment.
  40  */
  41 public interface Attachment {
  42 
  43     /**
  44      * Content ID of the attachment. Uniquely identifies an attachment.
  45      *
  46      * http://www.ietf.org/rfc/rfc2392.txt (which is referred by the ws-i attachment profile
  47      * http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html)
  48      *
  49      * content-id    = url-addr-spec
  50      * url-addr-spec = addr-spec  ; URL encoding of RFC 822 addr-spec
  51      * cid-url       = "cid" ":" content-id
  52      *
  53      * A "cid" URL is converted to the corresponding Content-ID message header [MIME] by
  54      * removing the "cid:" prefix, converting the % encoded character to their equivalent
  55      * US-ASCII characters, and enclosing the remaining parts with an angle bracket pair,
  56      * "<" and ">".  For  example, "cid:foo4%25foo1@bar.net" corresponds to
  57      *      Content-ID: <foo4%25foo1@bar.net>
  58      *
  59      * @return
  60      *      The content ID like "foo-bar-zot@abc.com", without
  61      *      surrounding '&lt;' and '>' used as the transfer syntax.
  62      */
  63     @NotNull String getContentId();
  64 
  65     /**
  66      * Gets the MIME content-type of this attachment.
  67      */
  68     String getContentType();
  69 
  70     /**
  71      * Gets the attachment as an exact-length byte array.
  72      */
  73     byte[] asByteArray();
  74 
  75     /**
  76      * Gets the attachment as a {@link DataHandler}.
  77      */
  78     DataHandler asDataHandler();
  79 
  80     /**
  81      * Gets the attachment as a {@link Source}.
  82      * Note that there's no guarantee that the attachment is actually an XML.
  83      */
  84     Source asSource();
  85 
  86     /**
  87      * Obtains this attachment as an {@link InputStream}.
  88      */
  89     InputStream asInputStream();
  90 
  91     /**
  92      * Writes the contents of the attachment into the given stream.
  93      */
  94     void writeTo(OutputStream os) throws IOException;
  95 
  96     /**
  97      * Writes this attachment to the given {@link SOAPMessage}.
  98      */
  99     void writeTo(SOAPMessage saaj) throws SOAPException;
 100 }