01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package com.sun.xml.ws.api.message;
37:
38: import com.sun.istack.NotNull;
39:
40: import javax.activation.DataHandler;
41: import javax.xml.soap.SOAPMessage;
42: import javax.xml.soap.SOAPException;
43: import javax.xml.transform.Source;
44: import java.io.IOException;
45: import java.io.InputStream;
46: import java.io.OutputStream;
47:
48: /**
49: * Attachment.
50: */
51: public interface Attachment {
52:
53: /**
54: * Content ID of the attachment. Uniquely identifies an attachment.
55: *
56: * @return
57: * The content ID like "foo-bar-zot@abc.com", without
58: * surrounding '<' and '>' used as the transfer syntax.
59: */
60: @NotNull
61: String getContentId();
62:
63: /**
64: * Gets the MIME content-type of this attachment.
65: */
66: String getContentType();
67:
68: /**
69: * Gets the attachment as an exact-length byte array.
70: */
71: byte[] asByteArray();
72:
73: /**
74: * Gets the attachment as a {@link DataHandler}.
75: */
76: DataHandler asDataHandler();
77:
78: /**
79: * Gets the attachment as a {@link Source}.
80: * Note that there's no guarantee that the attachment is actually an XML.
81: */
82: Source asSource();
83:
84: /**
85: * Obtains this attachment as an {@link InputStream}.
86: */
87: InputStream asInputStream();
88:
89: /**
90: * Writes the contents of the attachment into the given stream.
91: */
92: void writeTo(OutputStream os) throws IOException;
93:
94: /**
95: * Writes this attachment to the given {@link SOAPMessage}.
96: */
97: void writeTo(SOAPMessage saaj) throws SOAPException;
98: }
|