/**
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements. See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership. The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License. You may obtain a copy of the License at
    *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied. See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.wss4j.policy.stax.assertionStates;
  
  import org.apache.wss4j.policy.AssertionState;
  import org.apache.wss4j.common.WSSPolicyException;
  import org.apache.wss4j.policy.model.AbstractSecurityAssertion;
  import org.apache.wss4j.policy.model.RequiredElements;
  import org.apache.wss4j.policy.model.XPath;
  import org.apache.xml.security.stax.securityEvent.SecurityEvent;
  import org.apache.xml.security.stax.securityEvent.SecurityEventConstants;
  import org.apache.wss4j.policy.stax.Assertable;
  import org.apache.wss4j.policy.stax.DummyPolicyAsserter;
  import org.apache.wss4j.policy.stax.PolicyAsserter;
  import org.apache.wss4j.policy.stax.PolicyUtils;
  import org.apache.wss4j.stax.securityEvent.RequiredElementSecurityEvent;
  import org.apache.wss4j.stax.securityEvent.WSSecurityEventConstants;
  import org.apache.wss4j.stax.utils.WSSUtils;
  
  import javax.xml.namespace.QName;
  
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Map;
  
  /**
   * WSP1.3, 4.3.1 RequiredElements Assertion
   */
  public class RequiredElementsAssertionState extends AssertionState implements Assertable {
  
      private final Map<List<QName>, Boolean> pathElements = new HashMap<>();
      private PolicyAsserter policyAsserter;
  
      public RequiredElementsAssertionState(AbstractSecurityAssertion assertion,
                                            PolicyAsserter policyAsserter,
                                            boolean asserted) {
          super(assertion, asserted);
  
          if (assertion instanceof RequiredElements) {
              RequiredElements requiredElements = (RequiredElements) assertion;
              for (int i = 0; i < requiredElements.getXPaths().size(); i++) {
                  XPath xPath = requiredElements.getXPaths().get(i);
                  List<QName> elements = PolicyUtils.getElementPath(xPath);
                  pathElements.put(elements, Boolean.FALSE);
              }
          }
  
          this.policyAsserter = policyAsserter;
          if (this.policyAsserter == null) {
              this.policyAsserter = new DummyPolicyAsserter();
          }
  
          if (asserted) {
              policyAsserter.assertPolicy(getAssertion());
          }
      }
  
      public void addElement(List<QName> pathElement) {
          this.pathElements.put(pathElement, Boolean.FALSE);
      }
  
      @Override
      public SecurityEventConstants.Event[] getSecurityEventType() {
          return new SecurityEventConstants.Event[]{
                  WSSecurityEventConstants.REQUIRED_ELEMENT
          };
      }
  
      @Override
      public boolean assertEvent(SecurityEvent securityEvent) throws WSSPolicyException {
          RequiredElementSecurityEvent requiredElementSecurityEvent = (RequiredElementSecurityEvent) securityEvent;
  
          Iterator<Map.Entry<List<QName>, Boolean>> elementMapIterator = pathElements.entrySet().iterator();
          while (elementMapIterator.hasNext()) {
              Map.Entry<List<QName>, Boolean> next = elementMapIterator.next();
              List<QName> qNameList = next.getKey();
              if (WSSUtils.pathMatches(qNameList, requiredElementSecurityEvent.getElementPath())) {
                  next.setValue(Boolean.TRUE);
                  break;
              }
          }
          //if we return false here other required elements will trigger a PolicyViolationException
         policyAsserter.assertPolicy(getAssertion());
         return true;
     }
 
     @Override
     public boolean isAsserted() {
         clearErrorMessage();
         Iterator<Map.Entry<List<QName>, Boolean>> elementMapIterator = pathElements.entrySet().iterator();
         while (elementMapIterator.hasNext()) {
             Map.Entry<List<QName>, Boolean> next = elementMapIterator.next();
             if (Boolean.FALSE.equals(next.getValue())) {
                 setErrorMessage("Element " + WSSUtils.pathAsString(next.getKey()) + " must be present");
                 policyAsserter.unassertPolicy(getAssertion(), getErrorMessage());
                 return false;
             }
         }
         policyAsserter.assertPolicy(getAssertion());
         return true;
     }
 }