common EGIZ code-style refactoring

4 files changed, 457 insertions, 459 deletions

diff --git a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/AbstractMetadataSignatureFilter.java b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/AbstractMetadataSignatureFilter.java
index 424c4431..40cbdeb0 100644
--- a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/AbstractMetadataSignatureFilter.java
+++ b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/AbstractMetadataSignatureFilter.java
@@ -1,35 +1,30 @@
-/*******************************************************************************
- * Copyright 2017 Graz University of Technology
- * EAAF-Core Components has been developed in a cooperation between EGIZ,  
- * A-SIT Plus, A-SIT, and Graz University of Technology.
+/*
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
  *
- * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by
- * the European Commission - subsequent versions of the EUPL (the "Licence");
- * You may not use this work except in compliance with the Licence.
- * You may obtain a copy of the Licence at:
+ * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
+ * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
+ * compliance with the Licence. You may obtain a copy of the Licence at:
  * https://joinup.ec.europa.eu/news/understanding-eupl-v12
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the Licence is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Licence for the specific language governing permissions and
- * limitations under the Licence.
- *  
- * This product combines work with different licenses. See the "NOTICE" text
- * file for details on the various modules and licenses.
- * The "NOTICE" text file is part of the distribution. Any derivative works
- * that you distribute must include a readable copy of the "NOTICE" text file.
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
+ * Unless required by applicable law or agreed to in writing, software distributed under the Licence
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the Licence for the specific language governing permissions and limitations under
+ * the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
+*/
+
 package at.gv.egiz.eaaf.modules.pvp2.impl.validation.metadata;
 
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
-
+import at.gv.egiz.eaaf.core.exceptions.EaafException;
+import at.gv.egiz.eaaf.modules.pvp2.exception.Pvp2MetadataException;
+import at.gv.egiz.eaaf.modules.pvp2.exception.SignatureValidationException;
 import org.opensaml.saml2.metadata.EntitiesDescriptor;
 import org.opensaml.saml2.metadata.EntityDescriptor;
 import org.opensaml.saml2.metadata.provider.MetadataFilter;
@@ -37,118 +32,117 @@ import org.opensaml.xml.XMLObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import at.gv.egiz.eaaf.core.exceptions.EAAFException;
-import at.gv.egiz.eaaf.modules.pvp2.exception.PVP2MetadataException;
-import at.gv.egiz.eaaf.modules.pvp2.exception.SignatureValidationException;
-
 public abstract class AbstractMetadataSignatureFilter implements MetadataFilter {
-	private static final Logger log = LoggerFactory.getLogger(AbstractMetadataSignatureFilter.class);
-		
-	public void doFilter(XMLObject metadata) throws SignatureValidationException {
-		try {
-			if (metadata instanceof EntitiesDescriptor) {
-				EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) metadata;
-				if(entitiesDescriptor.getSignature() == null) {
-					throw new PVP2MetadataException("pvp2.26", 
-							new Object[] {"Root element of metadata file has to be signed"});
-				}
-				processEntitiesDescriptor(entitiesDescriptor);
-				
-				
-				if (entitiesDescriptor.getEntityDescriptors().size() == 0) {
-					throw new PVP2MetadataException("pvp2.26", 
-							new Object[] {"No valid entity in metadata " + entitiesDescriptor.getName()});
-				}
-				
-				
-			} else if (metadata instanceof EntityDescriptor) {
-				EntityDescriptor entityDescriptor = (EntityDescriptor) metadata;
-				processEntityDescriptorr(entityDescriptor);
-				
-			} else
-				throw new PVP2MetadataException("pvp2.26", 
-						new Object[] {"Invalid Metadata file Root element is unknown"});
-			
-			
-			
-			log.info("Metadata signature policy check done OK");
-		} catch (EAAFException e) {
-			log.warn("Metadata signature policy check FAILED.", e);
-			throw new SignatureValidationException(e);
-			
-		}
-	}
-	
-	/**
-	 * Signature verification of a SAML2 EntityDescriptor element
-	 * 
-	 * @param desc 
-	 * @throws PVP2MetadataException if the signature is not valid or can not verified
-	 */
-	protected abstract void verify(EntityDescriptor desc) throws PVP2MetadataException;
-	
-	/**
-	 * Signature verification of a SAML2 EntitiesDescriptor element
-	 * 
-	 * @param desc
-	 * @throws PVP2MetadataException if the signature is not valid or can not verified
-	 */
-	protected abstract void verify(EntitiesDescriptor desc) throws PVP2MetadataException;
-	
-	/**
-	 * Verify a EntityDescriptor element of an EntitiesDescriptor
-	 * 
-	 * @param entity EntityDescriptor to verify
-	 * @param desc Full EntitiesDescriptor  that contains the EntityDescriptor
-	 * @throws PVP2MetadataException
-	 */
-	protected abstract void verify(EntityDescriptor entity, EntitiesDescriptor desc) throws PVP2MetadataException;
-	
-	
-	private void processEntityDescriptorr(EntityDescriptor desc) throws EAAFException {				
-		verify(desc);
-		
-	}
-	
-	private void processEntitiesDescriptor(EntitiesDescriptor desc) throws EAAFException {
-		Iterator<EntitiesDescriptor> entID = desc.getEntitiesDescriptors().iterator();
-		
-		if(desc.getSignature() != null) {
-			verify(desc);
-			
-		}
-		
-		while(entID.hasNext()) {
-			processEntitiesDescriptor(entID.next());
-		}
-				
-		Iterator<EntityDescriptor> entIT = desc.getEntityDescriptors().iterator();
-		List<EntityDescriptor> verifiedEntIT = new ArrayList<EntityDescriptor>();
-		
-		//check every Entity		
-		while(entIT.hasNext()) {			
-			EntityDescriptor entity = entIT.next();
-			log.debug("Validate metadata for entityID: " + entity.getEntityID() + " ..... ");
-			try {
-				verify(entity, desc);
-				
-				//add entity to verified entity-list					
-				verifiedEntIT.add(entity);
-				log.debug("Metadata for entityID: " + entity.getEntityID() + " valid");
-				
-				
-			} catch (Exception e) {
-				//remove entity of signature can not be verified.
-				log.info("Entity " + entity.getEntityID() + " is removed from metadata " 
-						+ desc.getName() + ". Entity verification error: " + e.getMessage());
-
-			}
-			
-		}		
-		
-		//set only verified entity elements
-		desc.getEntityDescriptors().clear();
-		desc.getEntityDescriptors().addAll(verifiedEntIT);
-	}
+  private static final Logger log = LoggerFactory.getLogger(AbstractMetadataSignatureFilter.class);
+
+  @Override
+  public void doFilter(final XMLObject metadata) throws SignatureValidationException {
+    try {
+      if (metadata instanceof EntitiesDescriptor) {
+        final EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) metadata;
+        if (entitiesDescriptor.getSignature() == null) {
+          throw new Pvp2MetadataException("pvp2.26",
+              new Object[] {"Root element of metadata file has to be signed"});
+        }
+        processEntitiesDescriptor(entitiesDescriptor);
+
+
+        if (entitiesDescriptor.getEntityDescriptors().size() == 0) {
+          throw new Pvp2MetadataException("pvp2.26",
+              new Object[] {"No valid entity in metadata " + entitiesDescriptor.getName()});
+        }
+
+
+      } else if (metadata instanceof EntityDescriptor) {
+        final EntityDescriptor entityDescriptor = (EntityDescriptor) metadata;
+        processEntityDescriptorr(entityDescriptor);
+
+      } else {
+        throw new Pvp2MetadataException("pvp2.26",
+            new Object[] {"Invalid Metadata file Root element is unknown"});
+      }
+
+
+
+      log.info("Metadata signature policy check done OK");
+    } catch (final EaafException e) {
+      log.warn("Metadata signature policy check FAILED.", e);
+      throw new SignatureValidationException(e);
+
+    }
+  }
+
+  /**
+   * Signature verification of a SAML2 EntityDescriptor element.
+   *
+   * @param desc EntityDescriptor
+   * @throws Pvp2MetadataException if the signature is not valid or can not verified
+   */
+  protected abstract void verify(EntityDescriptor desc) throws Pvp2MetadataException;
+
+  /**
+   * Signature verification of a SAML2 EntitiesDescriptor element.
+   *
+   * @param desc EntitiesDescriptor
+   * @throws Pvp2MetadataException if the signature is not valid or can not verified
+   */
+  protected abstract void verify(EntitiesDescriptor desc) throws Pvp2MetadataException;
+
+  /**
+   * Verify a EntityDescriptor element of an EntitiesDescriptor.
+   *
+   * @param entity EntityDescriptor to verify
+   * @param desc Full EntitiesDescriptor that contains the EntityDescriptor
+   * @throws Pvp2MetadataException In case of an verification error
+   */
+  protected abstract void verify(EntityDescriptor entity, EntitiesDescriptor desc)
+      throws Pvp2MetadataException;
+
+
+  private void processEntityDescriptorr(final EntityDescriptor desc) throws EaafException {
+    verify(desc);
+
+  }
+
+  private void processEntitiesDescriptor(final EntitiesDescriptor desc) throws EaafException {
+    final Iterator<EntitiesDescriptor> entID = desc.getEntitiesDescriptors().iterator();
+
+    if (desc.getSignature() != null) {
+      verify(desc);
+
+    }
+
+    while (entID.hasNext()) {
+      processEntitiesDescriptor(entID.next());
+    }
+
+    final Iterator<EntityDescriptor> entIT = desc.getEntityDescriptors().iterator();
+    final List<EntityDescriptor> verifiedEntIT = new ArrayList<>();
+
+    // check every Entity
+    while (entIT.hasNext()) {
+      final EntityDescriptor entity = entIT.next();
+      log.debug("Validate metadata for entityID: " + entity.getEntityID() + " ..... ");
+      try {
+        verify(entity, desc);
+
+        // add entity to verified entity-list
+        verifiedEntIT.add(entity);
+        log.debug("Metadata for entityID: " + entity.getEntityID() + " valid");
+
+
+      } catch (final Exception e) {
+        // remove entity of signature can not be verified.
+        log.info("Entity " + entity.getEntityID() + " is removed from metadata " + desc.getName()
+            + ". Entity verification error: " + e.getMessage());
+
+      }
+
+    }
+
+    // set only verified entity elements
+    desc.getEntityDescriptors().clear();
+    desc.getEntityDescriptors().addAll(verifiedEntIT);
+  }
 
 }
diff --git a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PVPEntityCategoryFilter.java b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PVPEntityCategoryFilter.java
deleted file mode 100644
index 87ab31fb..00000000
--- a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PVPEntityCategoryFilter.java
+++ /dev/null
@@ -1,236 +0,0 @@
-/*******************************************************************************
- * Copyright 2017 Graz University of Technology
- * EAAF-Core Components has been developed in a cooperation between EGIZ,  
- * A-SIT Plus, A-SIT, and Graz University of Technology.
- *
- * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by
- * the European Commission - subsequent versions of the EUPL (the "Licence");
- * You may not use this work except in compliance with the Licence.
- * You may obtain a copy of the Licence at:
- * https://joinup.ec.europa.eu/news/understanding-eupl-v12
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the Licence is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Licence for the specific language governing permissions and
- * limitations under the Licence.
- *  
- * This product combines work with different licenses. See the "NOTICE" text
- * file for details on the various modules and licenses.
- * The "NOTICE" text file is part of the distribution. Any derivative works
- * that you distribute must include a readable copy of the "NOTICE" text file.
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
-package at.gv.egiz.eaaf.modules.pvp2.impl.validation.metadata;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import org.opensaml.common.xml.SAMLConstants;
-import org.opensaml.saml2.common.Extensions;
-import org.opensaml.saml2.core.Attribute;
-import org.opensaml.saml2.metadata.AttributeConsumingService;
-import org.opensaml.saml2.metadata.EntitiesDescriptor;
-import org.opensaml.saml2.metadata.EntityDescriptor;
-import org.opensaml.saml2.metadata.LocalizedString;
-import org.opensaml.saml2.metadata.RequestedAttribute;
-import org.opensaml.saml2.metadata.SPSSODescriptor;
-import org.opensaml.saml2.metadata.ServiceName;
-import org.opensaml.saml2.metadata.provider.FilterException;
-import org.opensaml.saml2.metadata.provider.MetadataFilter;
-import org.opensaml.samlext.saml2mdattr.EntityAttributes;
-import org.opensaml.xml.XMLObject;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import at.gv.egiz.eaaf.core.impl.data.Trible;
-import at.gv.egiz.eaaf.modules.pvp2.PVPConstants;
-import at.gv.egiz.eaaf.modules.pvp2.exception.PVP2MetadataException;
-import at.gv.egiz.eaaf.modules.pvp2.impl.builder.PVPAttributeBuilder;
-import at.gv.egiz.eaaf.modules.pvp2.impl.utils.SAML2Utils;
-
-/**
- * @author tlenz
- *
- */
-public class PVPEntityCategoryFilter implements MetadataFilter {
-	private static final Logger log = LoggerFactory.getLogger(PVPEntityCategoryFilter.class);
-	
-	private boolean isUsed = false;
-	
-	/**
-	 * Filter to map PVP EntityCategories into a set of single PVP attributes 
-	 * 
-	 * @param isUsed if true PVP EntityCategories are mapped, otherwise they are ignored
-	 * 
-	 */
-	public PVPEntityCategoryFilter(boolean isUsed) {
-		this.isUsed = isUsed;
-	}
-	
-	
-	/* (non-Javadoc)
-	 * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)
-	 */
-	@Override
-	public void doFilter(XMLObject metadata) throws FilterException {
-		
-		if (isUsed) {
-			 log.trace("Map PVP EntityCategory to single PVP Attributes ... ");
-			String entityId = null;
-			try {
-				if (metadata instanceof EntitiesDescriptor) {
-					 log.trace("Find EnitiesDescriptor ... ");
-					EntitiesDescriptor entitiesDesc = (EntitiesDescriptor) metadata;
-					if (entitiesDesc.getEntityDescriptors() != null) {
-						for (EntityDescriptor el : entitiesDesc.getEntityDescriptors()) 
-							resolveEntityCategoriesToAttributes(el);
-						
-					}
-									
-				} else if (metadata instanceof EntityDescriptor) {
-					 log.trace("Find EntityDescriptor");
-					resolveEntityCategoriesToAttributes((EntityDescriptor)metadata);
-					
-					
-				} else
-					throw new PVP2MetadataException("pvp2.26", 
-							new Object[] {"Invalid Metadata file Root element is no Entities- or EntityDescriptor"});
-				
-				
-				
-			} catch (Exception e) {
-				 log.warn("SAML2 Metadata processing FAILED: Can not resolve EntityCategories for metadata: " + entityId, e);
-				
-			}
-			
-		} else
-			 log.trace("Filter to map PVP EntityCategory to single PVP Attributes is deactivated");
-		
-	}
-
-	private void resolveEntityCategoriesToAttributes(EntityDescriptor metadata) {
-		 log.debug("Resolving EntityCategorie for Entity: " + metadata.getEntityID() + " ...");
-		Extensions extensions = metadata.getExtensions();
-		if (extensions != null) {
-			List<XMLObject> listOfExt = extensions.getUnknownXMLObjects();
-			if (listOfExt != null && !listOfExt.isEmpty()) {
-				 log.trace("Find #" + listOfExt.size() + " 'Extension' elements ");
-				for (XMLObject el : listOfExt) {
-					 log.trace("Find ExtensionElement: " + el.getElementQName().toString());
-					if (el instanceof EntityAttributes) {
-						EntityAttributes entityAttrElem = (EntityAttributes)el;
-						if (entityAttrElem.getAttributes() != null) {
-							 log.trace("Find EntityAttributes. Start attribute processing ...");
-							for (Attribute entityAttr : entityAttrElem.getAttributes()) {
-								if (entityAttr.getName().equals(PVPConstants.ENTITY_CATEGORY_ATTRIBITE)) {
-									if (!entityAttr.getAttributeValues().isEmpty()) {
-										String entityAttrValue = entityAttr.getAttributeValues().get(0).getDOM().getTextContent();
-										if (PVPConstants.EGOVTOKEN.equals(entityAttrValue)) {
-											 log.debug("Find 'EGOVTOKEN' EntityAttribute. Adding single pvp attributes ... ");
-											addAttributesToEntityDescriptor(metadata, 
-													buildAttributeList(PVPConstants.EGOVTOKEN_PVP_ATTRIBUTES), 
-													entityAttrValue);
-											
-																													
-										} else if (PVPConstants.CITIZENTOKEN.equals(entityAttrValue)) {
-											 log.debug("Find 'CITIZENTOKEN' EntityAttribute. Adding single pvp attributes ... ");
-											addAttributesToEntityDescriptor(metadata, 
-													buildAttributeList(PVPConstants.CITIZENTOKEN_PVP_ATTRIBUTES), 
-													entityAttrValue);
-											
-										} else
-											 log.info("EntityAttributeValue: " + entityAttrValue + " is UNKNOWN!");
-																			
-									} else
-										 log.info("EntityAttribute: No attribute value");
-																		
-								} else 
-									 log.info("EntityAttribute: " + entityAttr.getName() + " is NOT supported");
-								
-							}
-										
-						} else
-							 log.info("Can NOT resolve EntityAttributes! Reason: Only EntityAttributes are supported!");
-						
-					}					
-				}
-				
-			} else
-				 log.trace("'Extension' element is 'null' or empty");
-			
-		} else
-			 log.trace("No 'Extension' element found");
-				
-	}
-	
-	/**
-	 * @param metadata
-	 * @param attrList
-	 */
-	private void addAttributesToEntityDescriptor(EntityDescriptor metadata, List<RequestedAttribute> attrList, String entityAttr) {
-		SPSSODescriptor spSSODesc = metadata.getSPSSODescriptor(SAMLConstants.SAML20P_NS);
-		if (spSSODesc != null) {
-			if (spSSODesc.getAttributeConsumingServices() == null || 
-					spSSODesc.getAttributeConsumingServices().isEmpty()) {
-				 log.trace("No 'AttributeConsumingServices' found. Added it ...");
-				
-				AttributeConsumingService attributeService = SAML2Utils.createSAMLObject(AttributeConsumingService.class);						
-				attributeService.setIndex(0);
-				attributeService.setIsDefault(true);
-				ServiceName serviceName = SAML2Utils.createSAMLObject(ServiceName.class);
-				serviceName.setName(new LocalizedString("Default Service", "en"));
-				attributeService.getNames().add(serviceName);
-				
-				if (attrList != null && !attrList.isEmpty()) {
-					attributeService.getRequestAttributes().addAll(attrList);
-					 log.info("Add  " + attrList.size() + " attributes for 'EntityAttribute': " + entityAttr);
-					
-				}
-				
-				spSSODesc.getAttributeConsumingServices().add(attributeService);
-				
-			} else {
-				 log.debug("Find 'AttributeConsumingServices'. Starting updating process ... ");
-				for (AttributeConsumingService el : spSSODesc.getAttributeConsumingServices()) {
-					 log.debug("Update 'AttributeConsumingService' with Index: " + el.getIndex());
-					
-					//load currently requested attributes
-					List<String> currentlyReqAttr = new ArrayList<String>();
-					for (RequestedAttribute reqAttr : el.getRequestAttributes())
-						currentlyReqAttr.add(reqAttr.getName());
-						
-
-					//check against EntityAttribute List
-					for (RequestedAttribute entityAttrListEl : attrList) {
-						if (!currentlyReqAttr.contains(entityAttrListEl.getName())) {
-							el.getRequestAttributes().add(entityAttrListEl);
-							
-						} else
-							 log.debug("'AttributeConsumingService' already contains attr: " + entityAttrListEl.getName());
-						
-					}
-					
-				}
-				
-			}
-			
-		} else
-			 log.info("Can ONLY add 'EntityAttributes' to 'SPSSODescriptor'");
-		
-	}
-
-	private List<RequestedAttribute> buildAttributeList(List<Trible<String, String, Boolean>> attrSet) {
-		List<RequestedAttribute> requestedAttributes = new ArrayList<RequestedAttribute>();
-		for (Trible<String, String, Boolean> el : attrSet)
-			requestedAttributes.add(PVPAttributeBuilder.buildReqAttribute(el.getFirst(), el.getSecond(), el.getThird()));	
-					
-		return requestedAttributes;
-		
-		
-	}
-	 	
-}
diff --git a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PvpEntityCategoryFilter.java b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PvpEntityCategoryFilter.java
new file mode 100644
index 00000000..2d81b1f8
--- /dev/null
+++ b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/PvpEntityCategoryFilter.java
@@ -0,0 +1,251 @@
+/*
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
+ * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
+ * compliance with the Licence. You may obtain a copy of the Licence at:
+ * https://joinup.ec.europa.eu/news/understanding-eupl-v12
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the Licence
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the Licence for the specific language governing permissions and limitations under
+ * the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
+*/
+
+package at.gv.egiz.eaaf.modules.pvp2.impl.validation.metadata;
+
+import java.util.ArrayList;
+import java.util.List;
+import at.gv.egiz.eaaf.core.impl.data.Trible;
+import at.gv.egiz.eaaf.modules.pvp2.PvpConstants;
+import at.gv.egiz.eaaf.modules.pvp2.exception.Pvp2MetadataException;
+import at.gv.egiz.eaaf.modules.pvp2.impl.builder.PvpAttributeBuilder;
+import at.gv.egiz.eaaf.modules.pvp2.impl.utils.Saml2Utils;
+import org.opensaml.common.xml.SAMLConstants;
+import org.opensaml.saml2.common.Extensions;
+import org.opensaml.saml2.core.Attribute;
+import org.opensaml.saml2.metadata.AttributeConsumingService;
+import org.opensaml.saml2.metadata.EntitiesDescriptor;
+import org.opensaml.saml2.metadata.EntityDescriptor;
+import org.opensaml.saml2.metadata.LocalizedString;
+import org.opensaml.saml2.metadata.RequestedAttribute;
+import org.opensaml.saml2.metadata.SPSSODescriptor;
+import org.opensaml.saml2.metadata.ServiceName;
+import org.opensaml.saml2.metadata.provider.FilterException;
+import org.opensaml.saml2.metadata.provider.MetadataFilter;
+import org.opensaml.samlext.saml2mdattr.EntityAttributes;
+import org.opensaml.xml.XMLObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Metadata filter that inject requested attributes based on Metadata EntityCategories.
+ *
+ * @author tlenz
+ *
+ */
+public class PvpEntityCategoryFilter implements MetadataFilter {
+  private static final Logger log = LoggerFactory.getLogger(PvpEntityCategoryFilter.class);
+
+  private boolean isUsed = false;
+
+  /**
+   * Filter to map PVP EntityCategories into a set of single PVP attributes.
+   *
+   * @param isUsed if true PVP EntityCategories are mapped, otherwise they are ignored
+   *
+   */
+  public PvpEntityCategoryFilter(final boolean isUsed) {
+    this.isUsed = isUsed;
+  }
+
+
+  /*
+   * (non-Javadoc)
+   *
+   * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)
+   */
+  @Override
+  public void doFilter(final XMLObject metadata) throws FilterException {
+
+    if (isUsed) {
+      log.trace("Map PVP EntityCategory to single PVP Attributes ... ");
+      final String entityId = null;
+      try {
+        if (metadata instanceof EntitiesDescriptor) {
+          log.trace("Find EnitiesDescriptor ... ");
+          final EntitiesDescriptor entitiesDesc = (EntitiesDescriptor) metadata;
+          if (entitiesDesc.getEntityDescriptors() != null) {
+            for (final EntityDescriptor el : entitiesDesc.getEntityDescriptors()) {
+              resolveEntityCategoriesToAttributes(el);
+            }
+
+          }
+
+        } else if (metadata instanceof EntityDescriptor) {
+          log.trace("Find EntityDescriptor");
+          resolveEntityCategoriesToAttributes((EntityDescriptor) metadata);
+
+
+        } else {
+          throw new Pvp2MetadataException("pvp2.26", new Object[] {
+              "Invalid Metadata file Root element is no Entities- or EntityDescriptor"});
+        }
+
+
+
+      } catch (final Exception e) {
+        log.warn("SAML2 Metadata processing FAILED: Can not resolve EntityCategories for metadata: "
+            + entityId, e);
+
+      }
+
+    } else {
+      log.trace("Filter to map PVP EntityCategory to single PVP Attributes is deactivated");
+    }
+
+  }
+
+  private void resolveEntityCategoriesToAttributes(final EntityDescriptor metadata) {
+    log.debug("Resolving EntityCategorie for Entity: " + metadata.getEntityID() + " ...");
+    final Extensions extensions = metadata.getExtensions();
+    if (extensions != null) {
+      final List<XMLObject> listOfExt = extensions.getUnknownXMLObjects();
+      if (listOfExt != null && !listOfExt.isEmpty()) {
+        log.trace("Find #" + listOfExt.size() + " 'Extension' elements ");
+        for (final XMLObject el : listOfExt) {
+          log.trace("Find ExtensionElement: " + el.getElementQName().toString());
+          if (el instanceof EntityAttributes) {
+            final EntityAttributes entityAttrElem = (EntityAttributes) el;
+            if (entityAttrElem.getAttributes() != null) {
+              log.trace("Find EntityAttributes. Start attribute processing ...");
+              for (final Attribute entityAttr : entityAttrElem.getAttributes()) {
+                if (entityAttr.getName().equals(PvpConstants.ENTITY_CATEGORY_ATTRIBITE)) {
+                  if (!entityAttr.getAttributeValues().isEmpty()) {
+                    final String entityAttrValue =
+                        entityAttr.getAttributeValues().get(0).getDOM().getTextContent();
+                    if (PvpConstants.EGOVTOKEN.equals(entityAttrValue)) {
+                      log.debug(
+                          "Find 'EGOVTOKEN' EntityAttribute. Adding single pvp attributes ... ");
+                      addAttributesToEntityDescriptor(metadata,
+                          buildAttributeList(PvpConstants.EGOVTOKEN_PVP_ATTRIBUTES),
+                          entityAttrValue);
+
+
+                    } else if (PvpConstants.CITIZENTOKEN.equals(entityAttrValue)) {
+                      log.debug(
+                          "Find 'CITIZENTOKEN' EntityAttribute. Adding single pvp attributes ... ");
+                      addAttributesToEntityDescriptor(metadata,
+                          buildAttributeList(PvpConstants.CITIZENTOKEN_PVP_ATTRIBUTES),
+                          entityAttrValue);
+
+                    } else {
+                      log.info("EntityAttributeValue: " + entityAttrValue + " is UNKNOWN!");
+                    }
+
+                  } else {
+                    log.info("EntityAttribute: No attribute value");
+                  }
+
+                } else {
+                  log.info("EntityAttribute: " + entityAttr.getName() + " is NOT supported");
+                }
+
+              }
+
+            } else {
+              log.info(
+                  "Can NOT resolve EntityAttributes! Reason: Only EntityAttributes are supported!");
+            }
+
+          }
+        }
+
+      } else {
+        log.trace("'Extension' element is 'null' or empty");
+      }
+
+    } else {
+      log.trace("No 'Extension' element found");
+    }
+
+  }
+
+
+  private void addAttributesToEntityDescriptor(final EntityDescriptor metadata,
+      final List<RequestedAttribute> attrList, final String entityAttr) {
+    final SPSSODescriptor spSsoDesc = metadata.getSPSSODescriptor(SAMLConstants.SAML20P_NS);
+    if (spSsoDesc != null) {
+      if (spSsoDesc.getAttributeConsumingServices() == null
+          || spSsoDesc.getAttributeConsumingServices().isEmpty()) {
+        log.trace("No 'AttributeConsumingServices' found. Added it ...");
+
+        final AttributeConsumingService attributeService =
+            Saml2Utils.createSamlObject(AttributeConsumingService.class);
+        attributeService.setIndex(0);
+        attributeService.setIsDefault(true);
+        final ServiceName serviceName = Saml2Utils.createSamlObject(ServiceName.class);
+        serviceName.setName(new LocalizedString("Default Service", "en"));
+        attributeService.getNames().add(serviceName);
+
+        if (attrList != null && !attrList.isEmpty()) {
+          attributeService.getRequestAttributes().addAll(attrList);
+          log.info("Add  " + attrList.size() + " attributes for 'EntityAttribute': " + entityAttr);
+
+        }
+
+        spSsoDesc.getAttributeConsumingServices().add(attributeService);
+
+      } else {
+        log.debug("Find 'AttributeConsumingServices'. Starting updating process ... ");
+        for (final AttributeConsumingService el : spSsoDesc.getAttributeConsumingServices()) {
+          log.debug("Update 'AttributeConsumingService' with Index: " + el.getIndex());
+
+          // load currently requested attributes
+          final List<String> currentlyReqAttr = new ArrayList<>();
+          for (final RequestedAttribute reqAttr : el.getRequestAttributes()) {
+            currentlyReqAttr.add(reqAttr.getName());
+          }
+
+
+          // check against EntityAttribute List
+          for (final RequestedAttribute entityAttrListEl : attrList) {
+            if (!currentlyReqAttr.contains(entityAttrListEl.getName())) {
+              el.getRequestAttributes().add(entityAttrListEl);
+
+            } else {
+              log.debug("'AttributeConsumingService' already contains attr: "
+                  + entityAttrListEl.getName());
+            }
+
+          }
+
+        }
+
+      }
+
+    } else {
+      log.info("Can ONLY add 'EntityAttributes' to 'SPSSODescriptor'");
+    }
+
+  }
+
+  private List<RequestedAttribute> buildAttributeList(
+      final List<Trible<String, String, Boolean>> attrSet) {
+    final List<RequestedAttribute> requestedAttributes = new ArrayList<>();
+    for (final Trible<String, String, Boolean> el : attrSet) {
+      requestedAttributes
+          .add(PvpAttributeBuilder.buildReqAttribute(el.getFirst(), el.getSecond(), el.getThird()));
+    }
+
+    return requestedAttributes;
+
+
+  }
+
+}
diff --git a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/SchemaValidationFilter.java b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/SchemaValidationFilter.java
index b5de4b21..3ff78ca8 100644
--- a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/SchemaValidationFilter.java
+++ b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/impl/validation/metadata/SchemaValidationFilter.java
@@ -1,35 +1,28 @@
-/*******************************************************************************
- * Copyright 2017 Graz University of Technology
- * EAAF-Core Components has been developed in a cooperation between EGIZ,  
- * A-SIT Plus, A-SIT, and Graz University of Technology.
+/*
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
  *
- * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by
- * the European Commission - subsequent versions of the EUPL (the "Licence");
- * You may not use this work except in compliance with the Licence.
- * You may obtain a copy of the Licence at:
+ * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
+ * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
+ * compliance with the Licence. You may obtain a copy of the Licence at:
  * https://joinup.ec.europa.eu/news/understanding-eupl-v12
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the Licence is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Licence for the specific language governing permissions and
- * limitations under the Licence.
- *  
- * This product combines work with different licenses. See the "NOTICE" text
- * file for details on the various modules and licenses.
- * The "NOTICE" text file is part of the distribution. Any derivative works
- * that you distribute must include a readable copy of the "NOTICE" text file.
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
-/*******************************************************************************
- *******************************************************************************/
+ * Unless required by applicable law or agreed to in writing, software distributed under the Licence
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the Licence for the specific language governing permissions and limitations under
+ * the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
+*/
+
 package at.gv.egiz.eaaf.modules.pvp2.impl.validation.metadata;
 
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.validation.Schema;
 import javax.xml.validation.Validator;
-
+import at.gv.egiz.eaaf.modules.pvp2.exception.SchemaValidationException;
 import org.opensaml.common.xml.SAMLSchemaBuilder;
 import org.opensaml.saml2.metadata.provider.FilterException;
 import org.opensaml.saml2.metadata.provider.MetadataFilter;
@@ -38,69 +31,65 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.xml.sax.SAXException;
 
-import at.gv.egiz.eaaf.modules.pvp2.exception.SchemaValidationException;
-
-/**
- * @author tlenz
- *
- */
 public class SchemaValidationFilter implements MetadataFilter {
-	private static final Logger log = LoggerFactory.getLogger(SchemaValidationFilter.class);
-	private boolean isActive = true;
-	
-	public SchemaValidationFilter() {
-	}
-	
-	/**
-	 * 
-	 */
-	public SchemaValidationFilter(boolean useSchemaValidation) {
-		this.isActive = useSchemaValidation;
-	}
-	
-	
-	/* (non-Javadoc)
-	 * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)
-	 */
-	@Override
-	public void doFilter(XMLObject arg0) throws FilterException {
-		
-		String errString = null;
-		
-		if (isActive) {
-			try {
-				Schema test = SAMLSchemaBuilder.getSAML11Schema();
-				Validator val = test.newValidator();
-				DOMSource source = new DOMSource(arg0.getDOM());		
-				val.validate(source);
-				log.info("Metadata Schema validation check done OK");
-				return;
-			
-			} catch (SAXException e) {
-				if (log.isDebugEnabled() || log.isTraceEnabled())
-					log.warn("Metadata Schema validation FAILED with exception:", e);
-				else
-					log.warn("Metadata Schema validation FAILED with message: "+ e.getMessage());
-
-				errString = e.getMessage();
-				
-			} catch (Exception e) {
-				if (log.isDebugEnabled() || log.isTraceEnabled())
-					log.warn("Metadata Schema validation FAILED with exception:", e);
-				else
-					log.warn("Metadata Schema validation FAILED with message: "+ e.getMessage());
-				
-				errString = e.getMessage();
-				
-			}
-			
-			throw new FilterException(
-					new SchemaValidationException("pvp2.26", 
-							new Object[] {"Metadata Schema validation FAILED with message: " + errString}));
-						
-		} else		
-			log.info("Metadata Schema validation check is DEACTIVATED!");
-		
-	}
+  private static final Logger log = LoggerFactory.getLogger(SchemaValidationFilter.class);
+  private boolean isActive = true;
+
+  public SchemaValidationFilter() {
+
+  }
+
+  public SchemaValidationFilter(final boolean useSchemaValidation) {
+    this.isActive = useSchemaValidation;
+  }
+
+
+  /*
+   * (non-Javadoc)
+   *
+   * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)
+   */
+  @Override
+  public void doFilter(final XMLObject arg0) throws FilterException {
+
+    String errString = null;
+
+    if (isActive) {
+      try {
+        final Schema test = SAMLSchemaBuilder.getSAML11Schema();
+        final Validator val = test.newValidator();
+        final DOMSource source = new DOMSource(arg0.getDOM());
+        val.validate(source);
+        log.info("Metadata Schema validation check done OK");
+        return;
+
+      } catch (final SAXException e) {
+        if (log.isDebugEnabled() || log.isTraceEnabled()) {
+          log.warn("Metadata Schema validation FAILED with exception:", e);
+        } else {
+          log.warn("Metadata Schema validation FAILED with message: " + e.getMessage());
+        }
+
+        errString = e.getMessage();
+
+      } catch (final Exception e) {
+        if (log.isDebugEnabled() || log.isTraceEnabled()) {
+          log.warn("Metadata Schema validation FAILED with exception:", e);
+        } else {
+          log.warn("Metadata Schema validation FAILED with message: " + e.getMessage());
+        }
+
+        errString = e.getMessage();
+
+      }
+
+      throw new FilterException(new SchemaValidationException("pvp2.26",
+          new Object[] {"Metadata Schema validation FAILED with message: " + errString}));
+
+    } else {
+      log.info("Metadata Schema validation check is DEACTIVATED!");
+    }
+
+  }
 
 }