se.litsec.opensaml.saml2.attribute.AttributeRepository 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

/*
 * The opensaml-ext project is an open-source package that extends OpenSAML
 * with useful extensions and utilities.
 *
 * More details on 
 * Copyright (C) 2017 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.opensaml.saml2.attribute;

import java.util.List;

/**
 * An interface for a repository of attribute definitions.
 * 
 * @author Martin Lindström ([email protected])
 */
public interface AttributeRepository {

  /**
   * Returns a list of all attribute names that are stored in the repository.
   * 
   * @return a list of attribute names
   */
  List getAttributeNames();

  /**
   * Returns the {@code AttributeTemplate} for the given attribute name.
   * 
   * @param name
   *          the attribute name
   * @return the matching {@code AttributeTemplate} or {@code null} if no match exists
   */
  AttributeTemplate getByName(String name);

  /**
   * Returns the {@code AttributeTemplate} for the given friendly name.
   * 
   * @param friendlyName
   *          the attribute friendly name
   * @return the matching {@code AttributeTemplate} or {@code null} if no match exists
   */
  AttributeTemplate getByFriendlyName(String friendlyName);

}