1 /*
   2  * Copyright (c) 1997, 2010, 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      * @return
  47      *      The content ID like "foo-bar-zot@abc.com", without
  48      *      surrounding '<' and '>' used as the transfer syntax.
  49      */
  50     @NotNull String getContentId();
  51 
  52     /**
  53      * Gets the MIME content-type of this attachment.
  54      */
  55     String getContentType();
  56 
  57     /**
  58      * Gets the attachment as an exact-length byte array.
  59      */
  60     byte[] asByteArray();
  61 
  62     /**
  63      * Gets the attachment as a {@link DataHandler}.
  64      */
  65     DataHandler asDataHandler();
  66 
  67     /**
  68      * Gets the attachment as a {@link Source}.
  69      * Note that there's no guarantee that the attachment is actually an XML.
  70      */
  71     Source asSource();
  72 
  73     /**
  74      * Obtains this attachment as an {@link InputStream}.
  75      */
  76     InputStream asInputStream();
  77 
  78     /**
  79      * Writes the contents of the attachment into the given stream.
  80      */
  81     void writeTo(OutputStream os) throws IOException;
  82 
  83     /**
  84      * Writes this attachment to the given {@link SOAPMessage}.
  85      */
  86     void writeTo(SOAPMessage saaj) throws SOAPException;
  87 }