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