Skip to main content
summaryrefslogtreecommitdiffstats
blob: 02bc3135732a75458a4b08503b4176a560ae2ee8 (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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*******************************************************************************
 * 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.ArrayList;
import java.util.List;

import javax.wsdl.Binding;
import javax.wsdl.BindingInput;
import javax.wsdl.BindingOperation;
import javax.wsdl.BindingOutput;
import javax.wsdl.Input;
import javax.wsdl.Message;
import javax.wsdl.Output;
import javax.wsdl.extensions.ExtensibilityElement;
import javax.wsdl.extensions.mime.MIMEContent;
import javax.wsdl.extensions.mime.MIMEMultipartRelated;
import javax.wsdl.extensions.mime.MIMEPart;

import org.eclipse.wst.wsi.internal.core.WSIException;
import org.eclipse.wst.wsi.internal.core.WSITag;
import org.eclipse.wst.wsi.internal.core.analyzer.AssertionFailException;
import org.eclipse.wst.wsi.internal.core.analyzer.AssertionNotApplicableException;
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.report.AssertionResult;

/**
 * AP2903
 *
 * <context>For a candidate wsdl:binding with at least one mime:content element</context>
 * <assertionDescription>The part attribute of each mime:content element in a wsdl:binding references
 * a wsdl:part element of a wsdl:message that is present in the respective wsdl:input or wsdl:output of the
 * corresponding wsdl:operation of the corresponding wsdl:portType.</assertionDescription>
 */
public class AP2903 extends AssertionProcess implements WSITag
{
  private final WSDLValidatorImpl validator;

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

  /* Validates the test assertion.
  * @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
  {
    try
    {
      // A variable that indicates a binding contains at least one
      // mime:content element
      boolean mimeContentsFound = false;

      // Getting a wsdl:binding
      Binding binding = (Binding) entryContext.getEntry().getEntryDetail();

      // Getting its wsdl:operation elements
      List ops = binding.getBindingOperations();

      // Going through the operation elements
      for (int i = 0; i < ops.size(); i++)
      {
        BindingOperation bindingOperation = (BindingOperation) ops.get(i);

        // Getting wsdl:input and wsdl:output elements of an operation
        BindingInput bindingInput = bindingOperation.getBindingInput();
        BindingOutput bindingOutput = bindingOperation.getBindingOutput();

        // Collecting all the mime:content elements from wsdl:input and wsdl:output
        List inputMimeContents = getMimeContentElements(
          bindingInput == null ? null : bindingInput.getExtensibilityElements());
        List outputMimeContents = getMimeContentElements(
          bindingOutput == null ? null : bindingOutput.getExtensibilityElements());

        // If the wsdl:input contains mime:content elements
        if (!inputMimeContents.isEmpty())
        {
          mimeContentsFound = true;
          Input portTypeInput = bindingOperation.getOperation().getInput();
          // If there is no the corresponding wsdl:input in wsdl:portType,
          // the assertion failed
          if (portTypeInput == null)
            throw new AssertionFailException(
              "There is no the corresponging wsdl:input in the wsdl:portType"
              + " operation for the wsdl:input of the \""
              + bindingOperation.getName() + "\" binding operation.");

          // If the wsdl:portType input does not reference any wsdl:message,
          // the assertion failed
          if (portTypeInput.getMessage() == null)
            throw new AssertionFailException("The wsdl:input of the \""
              + bindingOperation.getOperation().getName() + "\" wsdl:portType "
              + "operation does not reference any wsdl:message.");

          // Getting the part name that is not specified in the wsdl:message
          // the input of wsdl:portType refers to
          String part = getInvalidMimeContentPart(
            inputMimeContents, portTypeInput.getMessage());

          // If such part is found, the assertion failed
          if (part != null)
            throw new AssertionFailException("part=\"" + part +
              "\", the input of the binding operation \""
              + bindingOperation.getName() + "\"");
        }

        // If the wsdl:output contains mime:content elements
        if (!outputMimeContents.isEmpty())
        {
          mimeContentsFound = true;
          Output portTypeOutput = bindingOperation.getOperation().getOutput();
          // If there is no the corresponding wsdl:input in wsdl:portType,
          // the assertion failed
          if (portTypeOutput == null)
            throw new AssertionFailException(
              "There is no the corresponging wsdl:output in the wsdl:portType"
              + " operation for the wsdl:output of the \""
              + bindingOperation.getName() + "\" binding operation.");

          // If the wsdl:portType output does not reference any wsdl:message,
          // the assertion failed
          if (portTypeOutput.getMessage() == null)
            throw new AssertionFailException("The wsdl:output of the \""
              + bindingOperation.getOperation().getName() + "\" wsdl:portType "
              + "operation does not reference any wsdl:message.");

          // Getting the part name that is not specified in the wsdl:message
          // the output of wsdl:portType refers to
          String part = getInvalidMimeContentPart(
              outputMimeContents, portTypeOutput.getMessage());

          // If such part is found, the assertion failed
          if (part != null)
            throw new AssertionFailException("part=\"" + part +
                "\", the output of the binding operation \""
                + bindingOperation.getName() + "\"");
        }
      }

      // If the binding contains no mime:content elements,
      // the assertion is not applicable
      if (!mimeContentsFound)
        throw new AssertionNotApplicableException();
    }
    catch (AssertionNotApplicableException anae)
    {
      result = AssertionResult.RESULT_NOT_APPLICABLE;
    }
    catch (AssertionFailException afe)
    {
      result = AssertionResult.RESULT_FAILED;
      failureDetail = validator.createFailureDetail(
        afe.getMessage(), entryContext);
    }

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

  /**
   * Collects all mime:content elements.
   * @param extElems a list of extensibility elements that can contain mime:contentS.
   * @return the list of mime:content elements found.
   */
  private List getMimeContentElements(List extElems)
  {
    List mimeContentElements = new ArrayList();

    if (extElems != null)
    {
      // Going through all the extensibility elements
      for (int i = 0; i < extElems.size(); i++)
      {
        ExtensibilityElement extElem = (ExtensibilityElement) extElems.get(i);
        // If the element is mime:multipartRelated
        if (extElem.getElementType().equals(WSDL_MIME_MULTIPART))
        {
          // Getting the mime:part elements of the mime:multipartRelated
          List mimeParts = ((MIMEMultipartRelated) extElem).getMIMEParts();
          // Going through all the mime:part elements
          for (int j = 0; j < mimeParts.size(); j++)
          {
            // Collecting all the mime:content elements of this mime:part
            List elems = getMimeContentElements(
              ((MIMEPart) mimeParts.get(j)).getExtensibilityElements());
            // Adding the elements to the list being returned
            mimeContentElements.addAll(elems);
          }
        }
        // Else if the element is mime:content
        else if (extElem.getElementType().equals(WSDL_MIME_CONTENT))
        {
          // Adding the element to the list being returned
          mimeContentElements.add(extElem);
        }
      }
    }

    return mimeContentElements;
  }

  /**
   * Returns part name specified in mime:content element that is not presented in wsdl:message
   * @param mimeContents a list of mime:content elements which part attributes are validated
   * @param message a wsdl:message
   * @return a part name
   */
  private String getInvalidMimeContentPart(List mimeContents, Message message)
  {
    // Going throug all the mime:content elements
    for (int i = 0; i < mimeContents.size(); i++)
    {
      // Getting the part name of a mime:element
      String part = ((MIMEContent) mimeContents.get(i)).getPart();
      // If the wsdl:message does not contain such part, return the part
      if (!message.getParts().keySet().contains(part))
        return part;
    }
    // Return null if no one part is found
    return null;
  }
}

Back to the top