Apache Addressing

Clover coverage report - Apache Addressing - 1.0

Coverage timestamp: Tue Mar 22 2005 07:59:24 EST

FRAMES NO FRAMES

file stats:	LOC:	232		Methods:	10
	NCLOC:	152		Classes:	1

30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover

Source file

Conditionals

Statements

Methods

TOTAL

AddressingUtils.java

19%

25.7%

50%

25.4%

 /*
  * Copyright  1999-2004 The Apache Software Foundation.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  *
  */
 
 package org.apache.axis.message.addressing.util;
 
 import org.apache.axis.message.addressing.Constants;
 import org.apache.axis.message.addressing.AddressingHeaders;
 
 import java.util.Iterator;
 import java.util.List;
 import java.util.ArrayList;
 
 import javax.xml.soap.Name;
 import javax.xml.soap.SOAPHeader;
 import javax.xml.soap.SOAPHeaderElement;
 import javax.xml.soap.SOAPElement;
 import javax.xml.soap.SOAPException;
 
 import javax.wsdl.Input;
 import javax.wsdl.Output;
 import javax.wsdl.Operation;
 import javax.wsdl.extensions.AttributeExtensible;
 
 import javax.xml.namespace.QName;
 import javax.xml.rpc.handler.MessageContext;
 
 /**
  * Class AddressingUtils
  * 
  * @author Jarek Gawor (gawor@apache.org)
  */
 public class AddressingUtils {
 
     /**
      * Removes all instances of a given header name in WS-Addressing
      * namespace for a given actor.
      */
     public static void removeHeader(SOAPHeader soapHeader, 
                                     String actorURI,
                                     String headerName) {
         if (soapHeader == null) {
             return;
         }
         Iterator headers = soapHeader.examineHeaderElements(actorURI);
         List existingElements = new ArrayList();
         while (headers.hasNext()) {
             SOAPHeaderElement hElement = (SOAPHeaderElement) headers.next();
             Name hName = hElement.getElementName();
             if (isAddressingNamespaceURI( hName.getURI() ) &&
                 hName.getLocalName().equals(headerName)) {
                 existingElements.add(hElement);
             }
         }
         for (int i = 0; i < existingElements.size(); i++) {
             SOAPHeaderElement el = (SOAPHeaderElement) existingElements.get(i);
             el.detachNode();
         }
     }
 
     public static boolean isAddressingNamespaceURI( String nsURI ) {
         return Constants.ADDRESSING_NS_URI_SET.contains( nsURI );
     }
 
     /**
      * Removes all instances of all WS-Addressing headers for a given
      * actor.
      */
     public static void removeHeaders(SOAPHeader soapHeader, 
                                      String actorURI) {
         if (soapHeader == null) {
             return;
         }
         Iterator headers = soapHeader.examineHeaderElements(actorURI);
         List existingElements = new ArrayList();
         while (headers.hasNext()) {
             SOAPHeaderElement hElement = (SOAPHeaderElement) headers.next();
             Name hName = hElement.getElementName();
             if (isAddressingNamespaceURI( hName.getURI() )) {
                 existingElements.add(hElement);
             }
         }
         for (int i = 0; i < existingElements.size(); i++) {
             SOAPHeaderElement el = (SOAPHeaderElement) existingElements.get(i);
             el.detachNode();
         }
     }
     
     /**
      * Gets response <code>AddressingHeaders</code> associated with the 
      * specified context. If there are no <code>AddressingHeaders</code>
      * associated with the context, new reponse <code>AddressingHeaders</code>
      * are created and associated with the context.
      */
     public static AddressingHeaders getResponseHeaders(MessageContext msgCtx) {
         return getHeaders(msgCtx, Constants.ENV_ADDRESSING_RESPONSE_HEADERS);
     }
     
     /**
      * Gets request <code>AddressingHeaders</code> associated with the 
      * specified context. If there are no <code>AddressingHeaders</code>
      * associated with the context, new request <code>AddressingHeaders</code>
      * are created and associated with the context.
      */
     public static AddressingHeaders getRequestHeaders(MessageContext msgCtx) {
         return getHeaders(msgCtx, Constants.ENV_ADDRESSING_REQUEST_HEADERS);
     }
     
     private static AddressingHeaders getHeaders(MessageContext msgCtx,
                                                 String type) {
         AddressingHeaders headers =
             (AddressingHeaders)msgCtx.getProperty(type);
         
         if (headers == null) {
             headers = new AddressingHeaders();
             // set property so other handlers might have a chance to use/modify
             msgCtx.setProperty(type, headers);
         }
         
         return headers;
     }
 
     /**
      * Gets input action. See section 3.3 of the 2004 WS-Addressing 
      * specification.
      */
     public static String getInputAction(QName portTypeQName,
                                         Operation operation) {
         if (portTypeQName == null || operation == null) {
             throw new IllegalArgumentException("Null parameters are not allowed.");
         }
         Input input = operation.getInput();
         if (input == null) {
             return null;
         }
         return getAction(input, input.getName(), 
                          portTypeQName, operation, "Request");
     }
 
     /**
      * Gets output action. See section 3.3 of the 2004 WS-Addressing 
      * specification.
      */
     public static String getOutputAction(QName portTypeQName,
                                          Operation operation) {
         if (portTypeQName == null || operation == null) {
             throw new IllegalArgumentException("Null parameters are not allowed.");
         }
         Output output = operation.getOutput();
         if (output == null) {
             return null;
         }
         return getAction(output, output.getName(), 
                          portTypeQName, operation, "Response");
     }
     
     private static String getAction(AttributeExtensible inputOutput,
                                     String inputOutputName,
                                     QName portTypeQName,
                                     Operation operation,
                                     String defaultName) {
         Object value = 
             inputOutput.getExtensionAttribute(Constants.QNAME_ACTION);
         if (value != null) {
             // wsdl4j returns a qname by default?
             if (value instanceof QName) {
                 return ((QName)value).getLocalPart();
             } else {
                 return value.toString();
             }
         }
         String name = inputOutputName;
         if (name == null) {
             name = operation.getName() + defaultName;
         }
         StringBuffer buf = new StringBuffer(50);
         buf.append(portTypeQName.getNamespaceURI());
         if (!portTypeQName.getNamespaceURI().endsWith("/")) {
             buf.append("/");
         }
         buf.append(portTypeQName.getLocalPart()).append("/").append(name);
         return buf.toString();
     }
     
     /**
      * Gets prefix for a given namespace. If the prefix is already defined
      * for the namespace given, it is returned. Otherwise, a new prefix is 
      * automatically registered with the given namespace and returned.
      *
      */
     public static String getNamespacePrefix(SOAPElement element,
                                             String namespace) 
         throws SOAPException {
         if (element == null || namespace == null) {
             throw new IllegalArgumentException("Null parameters are not allowed.");
         }
         Iterator iter = element.getVisibleNamespacePrefixes();
         String prefix = null;
         String ns = null;
         while(iter.hasNext()) {
             prefix = (String)iter.next();
             ns = element.getNamespaceURI(prefix);
             if (namespace.equals(ns)) {
                 return prefix;
             }
         }
         
         int i = 0;
         prefix = "ns" + i;
         while (element.getNamespaceURI(prefix) != null) {
             prefix = "ns" + i++;
         }
         
         element.addNamespaceDeclaration(prefix, namespace);
         
         return prefix;
     }
 }
 

1		/*
2		* Copyright 1999-2004 The Apache Software Foundation.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		*/
17
18		package org.apache.axis.message.addressing.util;
19
20		import org.apache.axis.message.addressing.Constants;
21		import org.apache.axis.message.addressing.AddressingHeaders;
22
23		import java.util.Iterator;
24		import java.util.List;
25		import java.util.ArrayList;
26
27		import javax.xml.soap.Name;
28		import javax.xml.soap.SOAPHeader;
29		import javax.xml.soap.SOAPHeaderElement;
30		import javax.xml.soap.SOAPElement;
31		import javax.xml.soap.SOAPException;
32
33		import javax.wsdl.Input;
34		import javax.wsdl.Output;
35		import javax.wsdl.Operation;
36		import javax.wsdl.extensions.AttributeExtensible;
37
38		import javax.xml.namespace.QName;
39		import javax.xml.rpc.handler.MessageContext;
40
41		/**
42		* Class AddressingUtils
43		*
44		* @author Jarek Gawor (gawor@apache.org)
45		*/
46		public class AddressingUtils {
47
48		/**
49		* Removes all instances of a given header name in WS-Addressing
50		* namespace for a given actor.
51		*/
52	0	public static void removeHeader(SOAPHeader soapHeader,
53		String actorURI,
54		String headerName) {
55	0	if (soapHeader == null) {
56	0	return;
57		}
58	0	Iterator headers = soapHeader.examineHeaderElements(actorURI);
59	0	List existingElements = new ArrayList();
60	0	while (headers.hasNext()) {
61	0	SOAPHeaderElement hElement = (SOAPHeaderElement) headers.next();
62	0	Name hName = hElement.getElementName();
63	0	if (isAddressingNamespaceURI( hName.getURI() ) &&
64		hName.getLocalName().equals(headerName)) {
65	0	existingElements.add(hElement);
66		}
67		}
68	0	for (int i = 0; i < existingElements.size(); i++) {
69	0	SOAPHeaderElement el = (SOAPHeaderElement) existingElements.get(i);
70	0	el.detachNode();
71		}
72		}
73
74	149	public static boolean isAddressingNamespaceURI( String nsURI ) {
75	149	return Constants.ADDRESSING_NS_URI_SET.contains( nsURI );
76		}
77
78		/**
79		* Removes all instances of all WS-Addressing headers for a given
80		* actor.
81		*/
82	16	public static void removeHeaders(SOAPHeader soapHeader,
83		String actorURI) {
84	16	if (soapHeader == null) {
85	0	return;
86		}
87	16	Iterator headers = soapHeader.examineHeaderElements(actorURI);
88	16	List existingElements = new ArrayList();
89	16	while (headers.hasNext()) {
90	30	SOAPHeaderElement hElement = (SOAPHeaderElement) headers.next();
91	30	Name hName = hElement.getElementName();
92	30	if (isAddressingNamespaceURI( hName.getURI() )) {
93	28	existingElements.add(hElement);
94		}
95		}
96	16	for (int i = 0; i < existingElements.size(); i++) {
97	28	SOAPHeaderElement el = (SOAPHeaderElement) existingElements.get(i);
98	28	el.detachNode();
99		}
100		}
101
102		/**
103		* Gets response <code>AddressingHeaders</code> associated with the
104		* specified context. If there are no <code>AddressingHeaders</code>
105		* associated with the context, new reponse <code>AddressingHeaders</code>
106		* are created and associated with the context.
107		*/
108	4	public static AddressingHeaders getResponseHeaders(MessageContext msgCtx) {
109	4	return getHeaders(msgCtx, Constants.ENV_ADDRESSING_RESPONSE_HEADERS);
110		}
111
112		/**
113		* Gets request <code>AddressingHeaders</code> associated with the
114		* specified context. If there are no <code>AddressingHeaders</code>
115		* associated with the context, new request <code>AddressingHeaders</code>
116		* are created and associated with the context.
117		*/
118	4	public static AddressingHeaders getRequestHeaders(MessageContext msgCtx) {
119	4	return getHeaders(msgCtx, Constants.ENV_ADDRESSING_REQUEST_HEADERS);
120		}
121
122	8	private static AddressingHeaders getHeaders(MessageContext msgCtx,
123		String type) {
124	8	AddressingHeaders headers =
125		(AddressingHeaders)msgCtx.getProperty(type);
126
127	8	if (headers == null) {
128	8	headers = new AddressingHeaders();
129		// set property so other handlers might have a chance to use/modify
130	8	msgCtx.setProperty(type, headers);
131		}
132
133	8	return headers;
134		}
135
136		/**
137		* Gets input action. See section 3.3 of the 2004 WS-Addressing
138		* specification.
139		*/
140	0	public static String getInputAction(QName portTypeQName,
141		Operation operation) {
142	0	if (portTypeQName == null \|\| operation == null) {
143	0	throw new IllegalArgumentException("Null parameters are not allowed.");
144		}
145	0	Input input = operation.getInput();
146	0	if (input == null) {
147	0	return null;
148		}
149	0	return getAction(input, input.getName(),
150		portTypeQName, operation, "Request");
151		}
152
153		/**
154		* Gets output action. See section 3.3 of the 2004 WS-Addressing
155		* specification.
156		*/
157	0	public static String getOutputAction(QName portTypeQName,
158		Operation operation) {
159	0	if (portTypeQName == null \|\| operation == null) {
160	0	throw new IllegalArgumentException("Null parameters are not allowed.");
161		}
162	0	Output output = operation.getOutput();
163	0	if (output == null) {
164	0	return null;
165		}
166	0	return getAction(output, output.getName(),
167		portTypeQName, operation, "Response");
168		}
169
170	0	private static String getAction(AttributeExtensible inputOutput,
171		String inputOutputName,
172		QName portTypeQName,
173		Operation operation,
174		String defaultName) {
175	0	Object value =
176		inputOutput.getExtensionAttribute(Constants.QNAME_ACTION);
177	0	if (value != null) {
178		// wsdl4j returns a qname by default?
179	0	if (value instanceof QName) {
180	0	return ((QName)value).getLocalPart();
181		} else {
182	0	return value.toString();
183		}
184		}
185	0	String name = inputOutputName;
186	0	if (name == null) {
187	0	name = operation.getName() + defaultName;
188		}
189	0	StringBuffer buf = new StringBuffer(50);
190	0	buf.append(portTypeQName.getNamespaceURI());
191	0	if (!portTypeQName.getNamespaceURI().endsWith("/")) {
192	0	buf.append("/");
193		}
194	0	buf.append(portTypeQName.getLocalPart()).append("/").append(name);
195	0	return buf.toString();
196		}
197
198		/**
199		* Gets prefix for a given namespace. If the prefix is already defined
200		* for the namespace given, it is returned. Otherwise, a new prefix is
201		* automatically registered with the given namespace and returned.
202		*
203		*/
204	0	public static String getNamespacePrefix(SOAPElement element,
205		String namespace)
206		throws SOAPException {
207	0	if (element == null \|\| namespace == null) {
208	0	throw new IllegalArgumentException("Null parameters are not allowed.");
209		}
210	0	Iterator iter = element.getVisibleNamespacePrefixes();
211	0	String prefix = null;
212	0	String ns = null;
213	0	while(iter.hasNext()) {
214	0	prefix = (String)iter.next();
215	0	ns = element.getNamespaceURI(prefix);
216	0	if (namespace.equals(ns)) {
217	0	return prefix;
218		}
219		}
220
221	0	int i = 0;
222	0	prefix = "ns" + i;
223	0	while (element.getNamespaceURI(prefix) != null) {
224	0	prefix = "ns" + i++;
225		}
226
227	0	element.addNamespaceDeclaration(prefix, namespace);
228
229	0	return prefix;
230		}
231		}
232