src/share/jaxws_classes/com/sun/xml/internal/ws/api/message/Attachment.java

Wed, 12 Jun 2013 14:47:09 +0100

author
mkos
date
Wed, 12 Jun 2013 14:47:09 +0100
changeset 384
8f2986ff0235
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8013021: Rebase 8005432 & 8003542 against the latest jdk8/jaxws
8003542: Improve processing of MTOM attachments
8005432: Update access to JAX-WS
Reviewed-by: mullan

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.message;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29
ohair@286 30 import javax.activation.DataHandler;
ohair@286 31 import javax.xml.soap.SOAPMessage;
ohair@286 32 import javax.xml.soap.SOAPException;
ohair@286 33 import javax.xml.transform.Source;
ohair@286 34 import java.io.IOException;
ohair@286 35 import java.io.InputStream;
ohair@286 36 import java.io.OutputStream;
ohair@286 37
ohair@286 38 /**
ohair@286 39 * Attachment.
ohair@286 40 */
ohair@286 41 public interface Attachment {
ohair@286 42
ohair@286 43 /**
ohair@286 44 * Content ID of the attachment. Uniquely identifies an attachment.
ohair@286 45 *
alanb@368 46 * http://www.ietf.org/rfc/rfc2392.txt (which is referred by the ws-i attachment profile
alanb@368 47 * http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html)
alanb@368 48 *
alanb@368 49 * content-id = url-addr-spec
alanb@368 50 * url-addr-spec = addr-spec ; URL encoding of RFC 822 addr-spec
alanb@368 51 * cid-url = "cid" ":" content-id
alanb@368 52 *
alanb@368 53 * A "cid" URL is converted to the corresponding Content-ID message header [MIME] by
alanb@368 54 * removing the "cid:" prefix, converting the % encoded character to their equivalent
alanb@368 55 * US-ASCII characters, and enclosing the remaining parts with an angle bracket pair,
alanb@368 56 * "<" and ">". For example, "cid:foo4%25foo1@bar.net" corresponds to
alanb@368 57 * Content-ID: <foo4%25foo1@bar.net>
alanb@368 58 *
ohair@286 59 * @return
ohair@286 60 * The content ID like "foo-bar-zot@abc.com", without
ohair@286 61 * surrounding '&lt;' and '>' used as the transfer syntax.
ohair@286 62 */
ohair@286 63 @NotNull String getContentId();
ohair@286 64
ohair@286 65 /**
ohair@286 66 * Gets the MIME content-type of this attachment.
ohair@286 67 */
ohair@286 68 String getContentType();
ohair@286 69
ohair@286 70 /**
ohair@286 71 * Gets the attachment as an exact-length byte array.
ohair@286 72 */
ohair@286 73 byte[] asByteArray();
ohair@286 74
ohair@286 75 /**
ohair@286 76 * Gets the attachment as a {@link DataHandler}.
ohair@286 77 */
ohair@286 78 DataHandler asDataHandler();
ohair@286 79
ohair@286 80 /**
ohair@286 81 * Gets the attachment as a {@link Source}.
ohair@286 82 * Note that there's no guarantee that the attachment is actually an XML.
ohair@286 83 */
ohair@286 84 Source asSource();
ohair@286 85
ohair@286 86 /**
ohair@286 87 * Obtains this attachment as an {@link InputStream}.
ohair@286 88 */
ohair@286 89 InputStream asInputStream();
ohair@286 90
ohair@286 91 /**
ohair@286 92 * Writes the contents of the attachment into the given stream.
ohair@286 93 */
ohair@286 94 void writeTo(OutputStream os) throws IOException;
ohair@286 95
ohair@286 96 /**
ohair@286 97 * Writes this attachment to the given {@link SOAPMessage}.
ohair@286 98 */
ohair@286 99 void writeTo(SOAPMessage saaj) throws SOAPException;
ohair@286 100 }

mercurial