KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > Part


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis;
57
58
59 public interface Part
60 {
61    /**
62     * Gets all the values of the <CODE>MimeHeader</CODE> object
63     * in this <CODE>SOAPPart</CODE> object that is identified by
64     * the given <CODE>String</CODE>.
65     *
66     * @param name the name of the header; example:
67     * "Content-Type"
68     * @return a <CODE>String</CODE> array giving all the values for
69     * the specified header
70     */
71    public abstract String JavaDoc[] getMimeHeader(String JavaDoc name);
72
73    /**
74     * Add the specified MIME header, as per JAXM.
75     */
76    public void addMimeHeader(String JavaDoc header, String JavaDoc value);
77
78    /**
79     * Content location.
80     */
81    public String JavaDoc getContentLocation();
82
83    /**
84     * Set content location.
85     */
86    public void setContentLocation(String JavaDoc loc);
87
88    /**
89     * Sets Content-Id of this part.
90     * already defined.
91     *
92     * @param newCid new Content-Id
93     */
94    public void setContentId(String JavaDoc newCid);
95
96    /**
97     * Content ID.
98     */
99    public String JavaDoc getContentId();
100
101    /**
102     * Get all headers that match
103     */
104    public java.util.Iterator JavaDoc getMatchingMimeHeaders(final String JavaDoc[] match);
105
106    /**
107     * Get all headers that do not match
108     */
109    public java.util.Iterator JavaDoc getNonMatchingMimeHeaders(final String JavaDoc[] match);
110
111    /**
112     * Content type.
113     */
114    public abstract String JavaDoc getContentType();
115
116    /**
117     * Content ID.
118     *
119     * @return the contentId reference value that should be used directly
120     * as an href in a SOAP element to reference this attachment.
121     * <B>Not part of JAX-RPC, JAX-M, SAAJ, etc. </B>
122     */
123    public String JavaDoc getContentIdRef();
124 }
125
126
Popular Tags