Skip to main content

This CGIT instance is deprecated, and repositories have been moved to Gitlab or Github. See the repository descriptions for specific locations.

summaryrefslogtreecommitdiffstats
blob: ca93a7bfd917999b2f4fcf41017dcd74d9b25e5c (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
/*******************************************************************************
 * 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.Part;
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.WSIConstants;
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;

/**
 * AP2944
 *
 * <context>For a candidate wsdl:binding</context>
 * <assertionDescription>In a DESCRIPTION, if a wsdl:part element refers to a
 * global element declaration (via the element attribute of the wsdl:part element)
 * then the value of the type attribute of a mime:content element that binds that part
 * is a content type suitable for carrying an XML serialization.</assertionDescription>
 */
public class AP2944 extends AssertionProcess implements WSITag
{
  private final WSDLValidatorImpl validator;

  // A variable that indicates a binding contains mime:content elements
  // that bind wsdl:partS defined with the element attribute
  private boolean mimeContentFound;
  /**
   * @param WSDLValidatorImpl
   */
  public AP2944(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
  {
    // Resetting the variable
    mimeContentFound = false;

    try
    {
      // 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())
        {
          Input portTypeInput = bindingOperation.getOperation().getInput();
          // If the corresponding wsdl:input exists in wsdl:portType
          // and includes the message attribute
          if (portTypeInput != null && portTypeInput.getMessage() != null)
          {
            // If there is an invalid mime:content element
            MIMEContent imc = getInvalidMimeContent(
                inputMimeContents, portTypeInput.getMessage());
            if (imc != null)
            {
              throw new AssertionFailException("The mime:content element in "
                + "the wsdl:input of the \"" + bindingOperation.getName()
                + "\" that binds the \"" + imc.getPart()
                + "\" wsdl:part uses the invalid content type \""
                + imc.getType() + "\". ");
            }
          }
        }

        // If the wsdl:output contains mime:content elements
        if (!outputMimeContents.isEmpty())
        {
          Output portTypeOutput = bindingOperation.getOperation().getOutput();
          // If the corresponding wsdl:output exists in wsdl:portType
          // and includes the message attribute
          if (portTypeOutput != null && portTypeOutput.getMessage() != null)
          {
            // If there is an invalid mime:content element
            MIMEContent imc = getInvalidMimeContent(
              outputMimeContents, portTypeOutput.getMessage());
            if (imc != null)
            {
              throw new AssertionFailException("The mime:content element in "
                + "the wsdl:output of the \"" + bindingOperation.getName()
                + "\" that binds the \"" + imc.getPart()
                + "\" wsdl:part uses the invalid content type \""
                + imc.getType() + "\". ");
            }
          }
        }
      }
      // If mime:content elements are not found,
      // the assertion is not applicable
      if (!mimeContentFound)
        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);
  }

  /**
   * Checks whether any mime:content element binds wsdl:part that is defined
   * with the element attribute and uses the content type "text/xml".
   * @param mimeContents a list of mime:content elements of binding operation.
   * @param message the corresponding wsdl:message element.
   * @return a mime:content element that uses a content type other than
   * "text/xml", null if no one such element is found.
   */
  private MIMEContent getInvalidMimeContent(List mimeContents, Message message)
  {
    // Going through a list of mime:content elements
    for (int i = 0; i < mimeContents.size(); i++)
    {
      MIMEContent mimeContent = (MIMEContent) mimeContents.get(i);
      // Getting the corresponding wsdl:part
      Part part = message.getPart(mimeContent.getPart());
      // If the part is defined with the element attribute
      if (part != null && part.getElementName() != null)
      {
        mimeContentFound = true;
        // If the type attribute value is other than "text/xml"
        if (!WSIConstants.CONTENT_TYPE_TEXT_XML.equals(mimeContent.getType()))
        {
          // return the invalid element
          return mimeContent;
        }
      }
    }
    return null;
  }

  /**
   * 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;
  }
}

Back to the top