se.swedenconnect.opensaml.eidas.ext.attributes.AttributeUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-eidas Show documentation
OpenSAML 5.X extension library for the eIDAS Framework
The newest version!
/*
 * Copyright 2016-2024 Sweden Connect
 *
 * Licensed 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 se.swedenconnect.opensaml.eidas.ext.attributes;

import javax.xml.namespace.QName;

import org.opensaml.core.xml.XMLObject;
import org.opensaml.core.xml.XMLObjectBuilder;
import org.opensaml.core.xml.config.XMLObjectProviderRegistrySupport;
import org.opensaml.saml.saml2.core.Attribute;
import org.opensaml.saml.saml2.core.AttributeValue;
import org.opensaml.saml.saml2.core.impl.AttributeBuilder;

/**
 * Utility methods for handling attributes and attribute values.
 *
 * @author Martin Lindström
 */
public class AttributeUtils {

  /** Builder for Attribute types. */
  private static final AttributeBuilder attributeBuilder = new AttributeBuilder();

  // Hidden constructor
  private AttributeUtils() {
  }

  /**
   * Utility method that creates an {@code Attribute} given its name, friendly name and name format.
   *
   * @param name the attribute name
   * @param friendlyName the attribute friendly name (may be {@code null})
   * @param nameFormat the name format
   * @return an {@code Attribute} object
   */
  public static Attribute createAttribute(final String name, final String friendlyName, final String nameFormat) {
    final Attribute attribute = attributeBuilder.buildObject();
    attribute.setName(name);
    attribute.setFriendlyName(friendlyName);
    attribute.setNameFormat(nameFormat);
    return attribute;
  }

  /**
   * Creates an {@code Attribute} with the given name (and friendly name) and with a name format of
   * {@value Attribute#URI_REFERENCE}.
   *
   * @param name the attribute name
   * @param friendlyName the attribute friendly name (may be {@code null})
   * @return an {@code Attribute} object
   * @see #createAttribute(String, String, String)
   */
  public static Attribute createAttribute(final String name, final String friendlyName) {
    return createAttribute(name, friendlyName, Attribute.URI_REFERENCE);
  }

  /**
   * Creates an {@code AttributeValue} object of the given class. The type of the attribute value will be the field that
   * is declared as {@code TYPE_NAME} of the given class.
   * 
   * After the object has been constructed, its setter methods should be called to setup the value object before adding
   * it to the attribute itself.
   * 
   *
   * @param  the type
   * @param clazz the type of attribute value
   * @return the attribute value
   * @see #createAttributeValueObject(QName, Class)
   */
  public static  T createAttributeValueObject(final Class clazz) {
    try {
      final QName schemaType = (QName) clazz.getDeclaredField("TYPE_NAME").get(null);
      return createAttributeValueObject(schemaType, clazz);
    }
    catch (final NoSuchFieldException | IllegalArgumentException | IllegalAccessException | SecurityException e) {
      throw new RuntimeException(e);
    }
  }

  /**
   * Creates an {@code AttributeValue} object of the given class and schema type.
   * 
   * After the object has been constructed, its setter methods should be called to setup the value object before adding
   * it to the attribute itself.
   * 
   *
   * @param  the type
   * @param schemaType the schema type that should be assigned to the attribute value, i.e.,
   *          {@code xsi:type="eidas:CurrentFamilyNameType"}
   * @param clazz the type of the attribute value
   * @return the attribute value
   * @see #createAttributeValueObject(Class)
   */
  public static  T createAttributeValueObject(final QName schemaType, final Class clazz) {
    final XMLObjectBuilder builder = XMLObjectProviderRegistrySupport.getBuilderFactory().getBuilder(schemaType);
    final XMLObject object = builder.buildObject(AttributeValue.DEFAULT_ELEMENT_NAME, schemaType);
    return clazz.cast(object);
  }

  /**
   * Utility method that adds an XML object as a value to an {@code Attribute}.
   * 
   * Example:
   * 
   *
   * {@code
   * Attribute attr =
   *     AttributeUtils.createAttribute("http://eidas.europa.eu/attributes/naturalperson/CurrentFamilyName",
   *         "FamilyName");
   * CurrentFamilyNameType value = AttributeUtils.createAttributeValueObject(CurrentFamilyNameType.class);
   * value.setValue("Lindström");
   * AttributeUtils.addAttributeValue(attr, value);
   * }
   * 
   *
   * @param  the type
   * @param attribute the attribute to update
   * @param value the value to add
   */
  public static  void addAttributeValue(final Attribute attribute, final T value) {
    attribute.getAttributeValues().add(value);
  }

}