se.idsec.signservice.security.sign.pdf.utils.SubjectDnAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-pdf-commons Show documentation
SignService PDF Commons
The newest version!
/*
 * Copyright 2019-2024 IDsec Solutions 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.idsec.signservice.security.sign.pdf.utils;

/**
 * Enumeration of common certificate subject attributes.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
public enum SubjectDnAttribute {

  /** Common name. */
  cn("2.5.4.3"),

  /** Given name. */
  givenName("2.5.4.42"),

  /** Surname. */
  surname("2.5.4.4"),

  /** Personal identity number. */
  personalIdentityNumber("1.2.752.29.4.13"),

  /** Country. */
  country("2.5.4.6"),

  /** Locality. */
  locality("2.5.4.7"),

  /** Serial number. */
  serialNumber("2.5.4.5"),

  /** Organization name. */
  organizationName("2.5.4.10"),

  /** Organizational unit name. */
  organizationalUnitName("2.5.4.11"),

  /** Organization identifier. */
  organizationIdentifier("2.5.4.97"),

  /** Pseudonym. */
  pseudonym("2.5.4.65"),

  /** DN qualifier. */
  dnQualifier("2.5.4.46"),

  /** Title. */
  title("2.5.4.12"),

  /** Unknown. */
  unknown("");

  /**
   * Gets the object identifier of the attribute.
   *
   * @return the object identifier of the attribute
   */
  public String getOid() {
    return this.oid;
  }

  /**
   * Based on the supplied OID the method returns the corresponding enum.
   *
   * @param oid
   *          the object identifier of the attribute
   * @return a SubjectDnAttribute enum
   */
  public static SubjectDnAttribute getSubjectDnFromOid(final String oid) {
    for (final SubjectDnAttribute subjDn : values()) {
      if (oid.equalsIgnoreCase(subjDn.getOid())) {
        return subjDn;
      }
    }
    return unknown;
  }

  /**
   * Constructor.
   *
   * @param oid
   *          the object identifier of the attribute
   */
  SubjectDnAttribute(final String oid) {
    this.oid = oid;
  }

  /** The object identifier of the attribute. */
  private final String oid;

}