| /* |
| * Copyright 2005-2006 Sun Microsystems, Inc. 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. Sun designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| * CA 95054 USA or visit www.sun.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. |
| */ |
| public interface Attachment { |
| |
| /** |
| * Content ID of the attachment. Uniquely identifies an attachment. |
| * |
| * @return |
| * The content ID like "foo-bar-zot@abc.com", without |
| * surrounding '<' and '>' used as the transfer syntax. |
| */ |
| @NotNull String getContentId(); |
| |
| /** |
| * Gets the MIME content-type of this attachment. |
| */ |
| String getContentType(); |
| |
| /** |
| * Gets the attachment as an exact-length byte array. |
| */ |
| byte[] asByteArray(); |
| |
| /** |
| * Gets the attachment as a {@link DataHandler}. |
| */ |
| DataHandler asDataHandler(); |
| |
| /** |
| * 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 {@link InputStream}. |
| */ |
| InputStream asInputStream(); |
| |
| /** |
| * Writes the contents of the attachment into the given stream. |
| */ |
| void writeTo(OutputStream os) throws IOException; |
| |
| /** |
| * Writes this attachment to the given {@link SOAPMessage}. |
| */ |
| void writeTo(SOAPMessage saaj) throws SOAPException; |
| } |