All Downloads are FREE. Search and download functionalities are using the official Maven repository.

se.litsec.eidas.opensaml2.ext.attributes.AttributeUtils Maven / Gradle / Ivy

There is a newer version: 1.0.6
Show newest version
/*
 * The eidas-opensaml project is an open-source package that extends OpenSAML
 * with definitions for the eIDAS Framework.
 *
 * More details on 
 * Copyright (C) 2016 Litsec AB
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package se.litsec.eidas.opensaml2.ext.attributes;

import javax.xml.namespace.QName;

import org.opensaml.saml2.core.Attribute;
import org.opensaml.saml2.core.AttributeValue;
import org.opensaml.saml2.core.impl.AttributeBuilder;
import org.opensaml.xml.Configuration;
import org.opensaml.xml.XMLObject;
import org.opensaml.xml.XMLObjectBuilder;

/**
 * Utility methods for handling attributes and attribute values.
 * 
 * @author Martin Lindström ([email protected])
 */
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(String name, String friendlyName, String nameFormat) {
    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(String name, 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(Class clazz) { try { QName schemaType = (QName) clazz.getDeclaredField("TYPE_NAME").get(null); return createAttributeValueObject(schemaType, clazz); } catch (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(QName schemaType, Class clazz) { XMLObjectBuilder builder = Configuration.getBuilderFactory().getBuilder(schemaType); 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(Attribute attribute, T value) { attribute.getAttributeValues().add(value); } // TODO: Utility method to add LoA attribute to EntityAttributes. // TODO: Utility method to get LoA attribute from EntityAttributes }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy