1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*******************************************************************************
* Copyright (c) 2002-2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM - Initial API and implementation
*******************************************************************************/
package org.eclipse.wst.wsi.internal.core.profile.validator.impl.envelope;
import java.util.Iterator;
import java.util.List;
import javax.wsdl.Binding;
import javax.wsdl.BindingInput;
import javax.wsdl.BindingOperation;
import javax.wsdl.BindingOutput;
import javax.wsdl.extensions.ExtensibilityElement;
import javax.wsdl.extensions.soap.SOAPHeader;
import org.eclipse.wst.wsi.internal.core.WSIConstants;
import org.eclipse.wst.wsi.internal.core.WSIException;
import org.eclipse.wst.wsi.internal.core.analyzer.AssertionNotApplicableException;
import org.eclipse.wst.wsi.internal.core.analyzer.AssertionPassException;
import org.eclipse.wst.wsi.internal.core.log.MessageEntry;
import org.eclipse.wst.wsi.internal.core.profile.TestAssertion;
import org.eclipse.wst.wsi.internal.core.profile.validator.EntryContext;
import org.eclipse.wst.wsi.internal.core.profile.validator.impl.AssertionProcess;
import org.eclipse.wst.wsi.internal.core.profile.validator.impl.BaseMessageValidator;
import org.eclipse.wst.wsi.internal.core.report.AssertionResult;
import org.eclipse.wst.wsi.internal.core.xml.XMLUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* BP4100
* <context>For a candidate envelope containing a header block that is either mandatory or is not described in the wsdl:binding.</context>
* <assertionDescription>An envelope contains a header block that is either mandatory or is not described in the wsdl:binding.</assertionDescription>
*/
public class BP4100 extends AssertionProcess {
private final BaseMessageValidator validator;
/**
* @param BaseMessageValidator
*/
public BP4100(BaseMessageValidator impl)
{
super(impl);
this.validator = impl;
}
public AssertionResult validate(
TestAssertion testAssertion,
EntryContext entryContext)
throws WSIException
{
try
{
// Parsing the message
Document doc = entryContext.getMessageEntryDocument();
// If the message is empty or invalid, the assertion is not applicable
if (doc == null)
{
throw new AssertionNotApplicableException();
}
// Getting header elements from envelope
Element root = doc.getDocumentElement();
NodeList headerList = root.getElementsByTagNameNS(
WSIConstants.NS_URI_SOAP, XMLUtils.SOAP_ELEM_HEADER);
// If there is no header, the assertion is not applicable
if (headerList == null || headerList.getLength() == 0)
{
throw new AssertionNotApplicableException();
}
// Getting the header element
Node header = headerList.item(0);
// Getting the immediate child elements of the header
NodeList elems = header.getChildNodes();
// If there are no child elements of the header
// the assertion is not applicable
if (elems == null || elems.getLength() == 0)
{
throw new AssertionNotApplicableException();
}
// Walking through child elements
for (int i = 0; i < elems.getLength(); i++)
{
if (elems.item(i).hasAttributes())
{
// Getting the mustUnderstand attribute
Node muNode = elems.item(i).getAttributes().getNamedItem(
root.getPrefix() + ":" + XMLUtils.SOAP_ATTR_MUST_UNDERSTAND);
// If a header block is mandatory, then the assertion passed
if (muNode != null && muNode.getNodeValue().equals("1"))
{
throw new AssertionPassException();
}
}
// Getting header block name
String blockName = elems.item(i).getLocalName();
// If the name is not presented (occurs when element is empty string)
// then continue with the next element
if (blockName == null)
{
continue;
}
boolean blockNameExists = false;
// Getting WSDL bindings
Binding[] bindings = validator.getWSDLDocument().getBindings();
for (int j = 0; j < bindings.length; j++)
{
// Getting wsdl:operations
List operations = bindings[j].getBindingOperations();
Iterator k = operations.iterator();
while (k.hasNext() && !blockNameExists)
{
BindingOperation operation = (BindingOperation) k.next();
// If this is a request message,
// then getting wsdl:input for an operation
if (entryContext.getMessageEntry().getType().equals(
MessageEntry.TYPE_REQUEST))
{
BindingInput opInput = operation.getBindingInput();
if (opInput != null)
{
// If wsdl:input is presented then checking
// whether the block name is described there or not
blockNameExists = blockNameExists(
opInput.getExtensibilityElements(), blockName);
}
}
// If this is a response message,
// then getting wsdl:output for an operation
else
{
BindingOutput opOutput = operation.getBindingOutput();
if (opOutput != null)
{
// If wsdl:output is presented then checking
// whether the block name is described there or not
blockNameExists = blockNameExists(
opOutput.getExtensibilityElements(), blockName);
}
}
}
}
// If a header block is not described in the appropriate wsdl:binding
// then the assertion passed
if (!blockNameExists)
{
throw new AssertionPassException();
}
}
// No one header block is either mandatory or is not described in the
// appropriate wsdl:binding, the assertion is not applicable
result = AssertionResult.RESULT_NOT_APPLICABLE;
}
catch (AssertionPassException ape)
{
failureDetail = validator.createFailureDetail(
testAssertion.getDetailDescription(), entryContext);
}
catch (AssertionNotApplicableException anae)
{
result = AssertionResult.RESULT_NOT_APPLICABLE;
}
return validator.createAssertionResult(
testAssertion, result, failureDetail);
}
/**
* Checks the existense of blockName in wsdlsoap:header, if it is found in
* a list of ExtensibilityElement objects
*
* @param elems A list of ExtensibilityElement objects
* @param blockName The name that will be checked for existence
* @return true if blockName is described in the wsdlsoap:header extensibility element
*/
private boolean blockNameExists(List elems, String blockName)
{
if (elems == null)
{
return false;
}
Iterator i = elems.iterator();
while (i.hasNext())
{
ExtensibilityElement elem = (ExtensibilityElement) i.next();
String elemName = elem.getElementType().getLocalPart();
if (elemName.equals("header"))
{
SOAPHeader soapHeader = (SOAPHeader) elem;
if (soapHeader.getPart().equals(blockName))
{
return true;
}
}
}
return false;
}
}
|
