Skip to main content
summaryrefslogtreecommitdiffstats
blob: 1a1eba3286984756a32fec2956548980463ce6ed (plain) (blame)
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
/*******************************************************************************
 * 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.wsdl;

import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import javax.wsdl.Binding;
import javax.wsdl.Definition;
import javax.wsdl.Fault;
import javax.wsdl.Input;
import javax.wsdl.Operation;
import javax.wsdl.Output;
import javax.wsdl.Port;
import javax.wsdl.PortType;
import javax.xml.namespace.QName;

import org.eclipse.wst.wsi.internal.core.WSIException;
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.AssertionProcessVisitor;
import org.eclipse.wst.wsi.internal.core.report.AssertionResult;
import org.eclipse.wst.wsi.internal.core.wsdl.traversal.WSDLTraversal;
import org.eclipse.wst.wsi.internal.core.wsdl.traversal.WSDLTraversalContext;


/**
* BP2416. 
*   <context>For a candidate wsdl:definitions</context>
*   <assertionDescription>Every QName in the WSDL document and its imports, is referencing an element in a namespace that has either been imported or defined in the WSDL document that contains the reference.</assertionDescription>
*/
public class BP2416 extends AssertionProcessVisitor
{
  private final WSDLValidatorImpl validator;

  /**
   * @param WSDLValidatorImpl
   */
  public BP2416(WSDLValidatorImpl impl)
  {
    super(impl);
    this.validator = impl;
  }

  private static final String NS_LIST_KEY = "namespaces";

  /**
   * Checks whether the namespace is defined or imported in the definition.
   * @param qname
   * @param ctx
   */
  private void checkNamespace(QName qname, WSDLTraversalContext ctx)
  {
    if (qname != null)
    {
      String namespace = qname.getNamespaceURI();

      if (namespace != null)
      {
        List namespaces = (List) ctx.getParameter(NS_LIST_KEY);

        if (!namespaces.contains(namespace))
        {
          result = AssertionResult.RESULT_FAILED;
          failureDetailMessage = namespace;

          ctx.cancelProcessing();
        }
      } // ??? should we do something otherwise  
    }
  }

  /* (non-Javadoc)
   * @see org.wsi.wsdl.traversal.WSDLVisitor#visit(javax.wsdl.Port, java.lang.Object, org.wsi.wsdl.traversal.WSDLTraversalContext)
   */
  public void visit(Port port, Object parent, WSDLTraversalContext ctx)
  {
    if (port != null)
    {
      Binding binding = port.getBinding();
      if (binding != null)
      {
        checkNamespace(binding.getQName(), ctx);
      }
    }
  }

  /* (non-Javadoc)
   * @see org.wsi.wsdl.traversal.WSDLVisitor#visit(javax.wsdl.Binding, java.lang.Object, org.wsi.wsdl.traversal.WSDLTraversalContext)
   */
  public void visit(Binding binding, Object parent, WSDLTraversalContext ctx)
  {
    if (binding != null)
    {
      PortType pType = binding.getPortType();
      if (pType != null)
      {
        checkNamespace(pType.getQName(), ctx);
      }
    }
  }

  /* (non-Javadoc)
   * @see org.wsi.wsdl.traversal.WSDLVisitor#visit(javax.wsdl.Operation, java.lang.Object, org.wsi.wsdl.traversal.WSDLTraversalContext)
   */
  public void visit(
    Operation operation,
    Object parent,
    WSDLTraversalContext ctx)
  {
    if (operation != null)
    {
      Input input = operation.getInput();
      if (input != null && input.getMessage() != null)
      {
        checkNamespace(input.getMessage().getQName(), ctx);
      }

      Output output = operation.getOutput();
      if (output != null && output.getMessage() != null)
      {
        checkNamespace(output.getMessage().getQName(), ctx);
      }

      Map faults = operation.getFaults();
      for (Iterator iter = faults.values().iterator(); iter.hasNext();)
      {
        Fault fault = (Fault) iter.next();

        if (fault.getMessage() != null)
        {
          checkNamespace(fault.getMessage().getQName(), ctx);
        }
      }
    }
  }

  /* (non-Javadoc)
   * @see org.wsi.wsdl.traversal.WSDLVisitor#visit(javax.wsdl.Message, java.lang.Object, org.wsi.wsdl.traversal.WSDLTraversalContext)
   */
  /* REMOVE: This is already done in WSI2417
  public void visit(Message message, Object parent, WSDLTraversalContext ctx) {
   if (message != null) {
     Map parts = message.getParts();
     for (Iterator iter = parts.values().iterator(); iter.hasNext();) {
       Part part = (Part) iter.next();
       
       checkNamespace(part.getElementName(), ctx);                
       checkNamespace(part.getTypeName(), ctx);
     }
   }
  }
  */

  /* (non-Javadoc)
  * @see org.wsi.test.profile.validator.impl.BaseValidatorImpl.AssertionProcess#validate(org.wsi.test.profile.TestAssertion, org.wsi.test.profile.validator.EntryContext)
  */
  public AssertionResult validate(
    TestAssertion testAssertion,
    EntryContext entryContext)
    throws WSIException
  {
    result = AssertionResult.RESULT_PASSED;

    // Get the definition from the entry context
    Definition definition =
      (Definition) entryContext.getEntry().getEntryDetail();

    // get list of namespaces imported and defined in the definition
    List namespaces = this.validator.getWSDLTargetNamespaceList(definition);

    // REMOVE:
    //Map namespaces = definition.getNamespaces();

    // traverse definition to check namespaces
    Map params = new HashMap();
    params.put(NS_LIST_KEY, namespaces);

    WSDLTraversal traversal = new WSDLTraversal();
    // VisitorAdaptor.adapt(this);
    traversal.setVisitor(this);
    traversal.visitOperation(true);
    traversal.visitBinding(true);
    traversal.visitMessage(true);
    traversal.visitPort(true);

    traversal.ignoreImport();
    traversal.ignoreReferences();
    traversal.traverse(definition, params);

    if (result.equals(AssertionResult.RESULT_FAILED))
    {
      this.validator.createFailureDetail(failureDetailMessage, entryContext);
    }

    // Return assertion result
    return validator.createAssertionResult(testAssertion, result, failureDetail);
  }
}

Back to the top