javax.xml.soap.MimeHeaders Maven / Gradle / Ivy
Show all versions of webservices-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
import java.util.Iterator;
import java.util.Vector;
/**
* A container for MimeHeader objects, which represent
* the MIME headers present in a MIME part of a message.
*
* This class is used primarily when an application wants to
* retrieve specific attachments based on certain MIME headers and
* values. This class will most likely be used by implementations of
* AttachmentPart and other MIME dependent parts of the SAAJ
* API.
* @see SOAPMessage#getAttachments
* @see AttachmentPart
*/
public class MimeHeaders {
private Vector headers;
/**
* Constructs a default MimeHeaders object initialized with
* an empty Vector object.
*/
public MimeHeaders() {
headers = new Vector();
}
/**
* Returns all of the values for the specified header as an array of
* String objects.
*
* @param name the name of the header for which values will be returned
* @return a String array with all of the values for the
* specified header
* @see #setHeader
*/
public String[] getHeader(String name) {
Vector values = new Vector();
for(int i = 0; i < headers.size(); i++) {
MimeHeader hdr = (MimeHeader) headers.elementAt(i);
if (hdr.getName().equalsIgnoreCase(name)
&& hdr.getValue() != null)
values.addElement(hdr.getValue());
}
if (values.size() == 0)
return null;
String r[] = new String[values.size()];
values.copyInto(r);
return r;
}
/**
* Replaces the current value of the first header entry whose name matches
* the given name with the given value, adding a new header if no existing header
* name matches. This method also removes all matching headers after the first one.
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
* @param name a String with the name of the header for
* which to search
* @param value a String with the value that will replace the
* current value of the specified header
*
* @exception IllegalArgumentException if there was a problem in the
* mime header name or the value being set
* @see #getHeader
*/
public void setHeader(String name, String value)
{
boolean found = false;
if ((name == null) || name.equals(""))
throw new IllegalArgumentException("Illegal MimeHeader name");
for(int i = 0; i < headers.size(); i++) {
MimeHeader hdr = (MimeHeader) headers.elementAt(i);
if (hdr.getName().equalsIgnoreCase(name)) {
if (!found) {
headers.setElementAt(new MimeHeader(hdr.getName(),
value), i);
found = true;
}
else
headers.removeElementAt(i--);
}
}
if (!found)
addHeader(name, value);
}
/**
* Adds a MimeHeader object with the specified name and value
* to this MimeHeaders object's list of headers.
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
* @param name a String with the name of the header to
* be added
* @param value a String with the value of the header to
* be added
*
* @exception IllegalArgumentException if there was a problem in the
* mime header name or value being added
*/
public void addHeader(String name, String value)
{
if ((name == null) || name.equals(""))
throw new IllegalArgumentException("Illegal MimeHeader name");
int pos = headers.size();
for(int i = pos - 1 ; i >= 0; i--) {
MimeHeader hdr = (MimeHeader) headers.elementAt(i);
if (hdr.getName().equalsIgnoreCase(name)) {
headers.insertElementAt(new MimeHeader(name, value),
i+1);
return;
}
}
headers.addElement(new MimeHeader(name, value));
}
/**
* Remove all MimeHeader objects whose name matches the
* given name.
*
* @param name a String with the name of the header for
* which to search
*/
public void removeHeader(String name) {
for(int i = 0; i < headers.size(); i++) {
MimeHeader hdr = (MimeHeader) headers.elementAt(i);
if (hdr.getName().equalsIgnoreCase(name))
headers.removeElementAt(i--);
}
}
/**
* Removes all the header entries from this MimeHeaders object.
*/
public void removeAllHeaders() {
headers.removeAllElements();
}
/**
* Returns all the MimeHeaders in this MimeHeaders object.
*
* @return an Iterator object over this MimeHeaders
* object's list of MimeHeader objects
*/
public Iterator getAllHeaders() {
return headers.iterator();
}
class MatchingIterator implements Iterator {
private boolean match;
private Iterator iterator;
private String[] names;
private Object nextHeader;
MatchingIterator(String[] names, boolean match) {
this.match = match;
this.names = names;
this.iterator = headers.iterator();
}
private Object nextMatch() {
next:
while (iterator.hasNext()) {
MimeHeader hdr = (MimeHeader) iterator.next();
if (names == null)
return match ? null : hdr;
for(int i = 0; i < names.length; i++)
if (hdr.getName().equalsIgnoreCase(names[i]))
if (match)
return hdr;
else
continue next;
if (!match)
return hdr;
}
return null;
}
public boolean hasNext() {
if (nextHeader == null)
nextHeader = nextMatch();
return nextHeader != null;
}
public Object next() {
// hasNext should've prefetched the header for us,
// return it.
if (nextHeader != null) {
Object ret = nextHeader;
nextHeader = null;
return ret;
}
if (hasNext())
return nextHeader;
return null;
}
public void remove() {
iterator.remove();
}
}
/**
* Returns all the MimeHeader objects whose name matches
* a name in the given array of names.
*
* @param names an array of String objects with the names
* for which to search
* @return an Iterator object over the MimeHeader
* objects whose name matches one of the names in the given list
*/
public Iterator getMatchingHeaders(String[] names) {
return new MatchingIterator(names, true);
}
/**
* Returns all of the MimeHeader objects whose name does not
* match a name in the given array of names.
*
* @param names an array of String objects with the names
* for which to search
* @return an Iterator object over the MimeHeader
* objects whose name does not match one of the names in the given list
*/
public Iterator getNonMatchingHeaders(String[] names) {
return new MatchingIterator(names, false);
}
}