View Javadoc

1   /*
2    * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
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  package org.opensaml.xml.encryption.validator;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.XMLObject;
22  import org.opensaml.xml.encryption.EncryptionProperty;
23  import org.opensaml.xml.util.XMLConstants;
24  import org.opensaml.xml.validation.ValidationException;
25  import org.opensaml.xml.validation.Validator;
26  
27  /**
28   * Checks {@link org.opensaml.xml.encryption.EncryptionProperty} for Schema compliance. 
29   */
30  public class EncryptionPropertySchemaValidator implements Validator<EncryptionProperty> {
31  
32      /** {@inheritDoc} */
33      public void validate(EncryptionProperty xmlObject) throws ValidationException {
34          validateUnknownChildren(xmlObject);
35          validateChildrenNamespaces(xmlObject);
36          validateAttributeNamespaces(xmlObject);
37      }
38  
39      /**
40       * Validate the unknown children.
41       * 
42       * @param xmlObject the object to validate
43       * @throws ValidationException  thrown if the object is invalid
44       */
45      protected void validateUnknownChildren(EncryptionProperty xmlObject) throws ValidationException {
46          if (xmlObject.getUnknownXMLObjects().isEmpty()) {
47              throw new ValidationException("No children were present in the EncryptionProperty object");
48          }
49      }
50      
51      /**
52       * Validate that all children are from another namespace.
53       * 
54       * @param xmlObject the object to validate
55       * @throws ValidationException thrown if the object is invalid
56       */
57      protected void validateChildrenNamespaces(EncryptionProperty xmlObject) throws ValidationException {
58          // Validate that any children are from another namespace.
59          for (XMLObject child : xmlObject.getUnknownXMLObjects()) {
60              QName childName = child.getElementQName();
61              if (XMLConstants.XMLENC_NS.equals(childName.getNamespaceURI())) {
62                  throw new ValidationException("EncryptionProperty contains an illegal child extension element: " + childName);
63              }
64          }
65      }
66      
67      /**
68       * Validate that any wildcard attributes are from the 
69       * XML namespace <code>http://www.w3.org/XML/1998/namespace</code>.
70       * 
71       * @param xmlObject the object to validate
72       * @throws ValidationException thrown if the object is invalid
73       */
74      protected void validateAttributeNamespaces(EncryptionProperty xmlObject) throws ValidationException {
75          // Validate that any extension attribute are from the XML namespace
76          for (QName attribName : xmlObject.getUnknownAttributes().keySet()) {
77              if (! XMLConstants.XML_NS.equals(attribName.getNamespaceURI())) {
78                  throw new ValidationException("EncryptionProperty contains an illegal extension attribute: " + attribName);
79              }
80          }
81      }
82  
83  }