• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/message/MessageHeaders.java@8f2986ff0235 (annotated)

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

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

author

mkos

date

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

changeset 384

8f2986ff0235

parent 0

373ffda63c9a

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

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2013, 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 java.util.List;
aoqi@0	29	import java.util.Iterator;
aoqi@0	30	import java.util.Set;
aoqi@0	31
aoqi@0	32	import javax.xml.namespace.QName;
aoqi@0	33
aoqi@0	34	import com.sun.xml.internal.ws.api.WSBinding;
aoqi@0	35
aoqi@0	36	/**
aoqi@0	37	* Interface representing all the headers of a {@link Message}
aoqi@0	38	*/
aoqi@0	39	public interface MessageHeaders {
aoqi@0	40	public void understood(Header header);
aoqi@0	41	public void understood(QName name);
aoqi@0	42	public void understood(String nsUri, String localName);
aoqi@0	43	public Header get(String nsUri, String localName, boolean markAsUnderstood);
aoqi@0	44	public Header get(QName name, boolean markAsUnderstood);
aoqi@0	45	public Iterator<Header> getHeaders(String nsUri, String localName, final boolean markAsUnderstood);
aoqi@0	46	/**
aoqi@0	47	* Get all headers in specified namespace
aoqi@0	48	* @param nsUri
aoqi@0	49	* @param markAsUnderstood
aoqi@0	50	* @return
aoqi@0	51	*/
aoqi@0	52	public Iterator<Header> getHeaders(String nsUri, final boolean markAsUnderstood);
aoqi@0	53	public Iterator<Header> getHeaders(QName headerName, final boolean markAsUnderstood);
aoqi@0	54	public Iterator<Header> getHeaders();
aoqi@0	55	public boolean hasHeaders();
aoqi@0	56	public boolean add(Header header);
aoqi@0	57	public Header remove(QName name);
aoqi@0	58	public Header remove(String nsUri, String localName);
aoqi@0	59	//DONT public Header remove(Header header);
aoqi@0	60	public void replace(Header old, Header header);
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Replaces an existing {@link Header} or adds a new {@link Header}.
aoqi@0	64	*
aoqi@0	65	* <p>
aoqi@0	66	* Order doesn't matter in headers, so this method
aoqi@0	67	* does not make any guarantee as to where the new header
aoqi@0	68	* is inserted.
aoqi@0	69	*
aoqi@0	70	* @return
aoqi@0	71	* always true. Don't use the return value.
aoqi@0	72	*/
aoqi@0	73	public boolean addOrReplace(Header header);
aoqi@0	74
aoqi@0	75	/**
aoqi@0	76	* Return a Set of QNames of headers that have been explicitly marked as understood.
aoqi@0	77	* If none have been marked, this method could return null
aoqi@0	78	*/
aoqi@0	79	public Set<QName> getUnderstoodHeaders();
aoqi@0	80
aoqi@0	81	/**
aoqi@0	82	* Returns a Set of QNames of headers that satisfy ALL the following conditions:
aoqi@0	83	* (a) Have mustUnderstand = true
aoqi@0	84	* (b) have NOT been explicitly marked as understood
aoqi@0	85	* (c) If roles argument is non-null, the header has isIgnorable = false
aoqi@0	86	* for the roles argument and SOAP version
aoqi@0	87	* (d) If non-null binding is passed in, are NOT understood by the binding
aoqi@0	88	* (e) If (d) is met, the header is NOT in the knownHeaders list passed in
aoqi@0	89	*
aoqi@0	90	* @param roles
aoqi@0	91	* @param knownHeaders
aoqi@0	92	* @param binding
aoqi@0	93	* @return
aoqi@0	94	*/
aoqi@0	95	public Set<QName> getNotUnderstoodHeaders(Set<String> roles, Set<QName> knownHeaders, WSBinding binding);
aoqi@0	96
aoqi@0	97	/**
aoqi@0	98	* True if the header has been explicitly marked understood, false otherwise
aoqi@0	99	* @param header
aoqi@0	100	* @return
aoqi@0	101	*/
aoqi@0	102	public boolean isUnderstood(Header header);
aoqi@0	103
aoqi@0	104	/**
aoqi@0	105	* True if the header has been explicitly marked understood, false otherwise
aoqi@0	106	* @param header
aoqi@0	107	* @return
aoqi@0	108	*/
aoqi@0	109	public boolean isUnderstood(QName header);
aoqi@0	110
aoqi@0	111	/**
aoqi@0	112	* True if the header has been explicitly marked understood, false otherwise
aoqi@0	113	* @param header
aoqi@0	114	* @return
aoqi@0	115	*/
aoqi@0	116	public boolean isUnderstood(String nsUri, String header);
aoqi@0	117
aoqi@0	118	/**
aoqi@0	119	* Returns <code>Header</code> instances in a <code>List</code>.
aoqi@0	120	* @return <code>List</code> containing <code>Header</code> instances
aoqi@0	121	*/
aoqi@0	122	public List<Header> asList();
aoqi@0	123	}