se.litsec.opensaml.saml2.attribute.AttributeTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation
OpenSAML 3.X utility extension library
There is a newer version: 1.4.5
/*
 * Copyright 2016-2018 Litsec AB
 *
 * 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.litsec.opensaml.saml2.attribute;

import org.opensaml.saml.saml2.core.Attribute;

/**
 * An attribute template is a template of a SAML attribute, i.e., it represents the name, friendly name and name format
 * but not the value of the attribute.
 * 
 * A template may be useful when defining attribute sets and/or attribute release policies.
 * 
 * 
 * @author Martin Lindström ([email protected])
 */
public class AttributeTemplate {

  /** The attribute name. */
  private String name;

  /** The attribute friendly name. */
  private String friendlyName;

  /**
   * The name format of this attribute. The default is {@code urn:oasis:names:tc:SAML:2.0:attrname-format:uri} (
   * {@link Attribute#URI_REFERENCE}).
   */
  private String nameFormat = Attribute.URI_REFERENCE;

  /**
   * Creates an attribute template with the given name and friendly name, the default name format
   * {@code urn:oasis:names:tc:SAML:2.0:attrname-format:uri} ({@link Attribute#URI_REFERENCE}) and not multi-valued.
   * 
   * @param name
   *          the attribute name
   * @param friendlyName
   *          the attribute friendly name (optional)
   */
  public AttributeTemplate(String name, String friendlyName) {
    this(name, friendlyName, Attribute.URI_REFERENCE);
  }

  /**
   * Creates an attribute template with the given name, friendly name and name format.
   * 
   * @param name
   *          the attribute name
   * @param friendlyName
   *          the attribute friendly name
   * @param nameFormat
   *          the name format
   */
  public AttributeTemplate(String name, String friendlyName, String nameFormat) {
    if (name == null) {
      throw new NullPointerException("'name' must not be null");
    }
    this.name = name;
    this.friendlyName = friendlyName;
    this.nameFormat = nameFormat != null ? nameFormat : Attribute.URI_REFERENCE;
  }

  /**
   * Get the name of this attribute template.
   * 
   * @return the name of this attribute template
   */
  public String getName() {
    return this.name;
  }

  /**
   * Get the friendly name of this attribute template.
   * 
   * @return the friendly name of this attribute template
   */
  public String getFriendlyName() {
    return this.friendlyName;
  }

  /**
   * Get the name format of this attribute template.
   * 
   * @return the name format of this attribute template
   */
  public String getNameFormat() {
    return this.nameFormat;
  }

  /**
   * Based on the attribute template an {@link AttributeBuilder} object is created.
   * 
   * @return a builder
   */
  public AttributeBuilder createBuilder() {
    AttributeBuilder builder = new AttributeBuilder(this.name);
    return builder.friendlyName(this.friendlyName).nameFormat(this.nameFormat);
  }

}