se.litsec.eidas.opensaml.common.EidasLoaEnum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eidas-opensaml3 Show documentation

OpenSAML 3.X extension library for the eIDAS Framework

There is a newer version: 1.4.5

/*
 * 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.opensaml.common;

/**
 * Enumeration representing an eIDAS Level of Assurance.
 * 
 * @author Martin Lindström ([email protected])
 */
public enum EidasLoaEnum {
  
  /** eIDAS "low" Level of assurance. */
  LOA_LOW(EidasConstants.EIDAS_LOA_LOW, 1),
  
  /** eIDAS "substantial" Level of assurance. For non-notified eID scheme. */
  LOA_SUBSTANTIAL_NON_NOTIFIED(EidasConstants.EIDAS_LOA_SUBSTANTIAL_NON_NOTIFIED, 2),
  
  /** eIDAS "substantial" Level of assurance. */
  LOA_SUBSTANTIAL(EidasConstants.EIDAS_LOA_SUBSTANTIAL, 3),
  
  /** eIDAS "high" Level of assurance. For non-notified eID scheme. */
  LOA_HIGH_NON_NOTIFIED(EidasConstants.EIDAS_LOA_HIGH_NON_NOTIFIED, 4),  
  
  /** eIDAS "high" Level of assurance. */
  LOA_HIGH(EidasConstants.EIDAS_LOA_HIGH, 5);
  
  /**
   * Returns the URI for this LoA.
   * 
   * @return an URI
   */
  public String getUri() {
    return this.loaUri;
  }
  
  /**
   * Returns the sorting order index.
   * 
   * @return the sorting order (the higher the strength, the higher the value)
   */
  public int getOrder() {
    return this.order;
  }  
  
  /**
   * Given a URI the method returns the enum value matching.
   * 
   * @param uri
   *          URI
   * @return the matching enum value or {@code null} is no match is found
   */
  public static EidasLoaEnum parse(String uri) {
    for (EidasLoaEnum loa : EidasLoaEnum.values()) {
      if (loa.getUri().equals(uri)) {
        return loa;
      }
    }
    return null;
  }

  
  /**
   * Constructor setting the LoA URI.
   * 
   * @param uri
   *          the LoA URI
   * @param order
   *          the sorting order
   */
  private EidasLoaEnum(String uri, int order) {
    this.loaUri = uri;
    this.order = order;
  }
  
  /** The LoA URI. */
  private String loaUri;
  
  /** Sorting order. */
  private int order;  

}