eu.europa.esig.dss.model.x509.X500PrincipalHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dss-model Show documentation
DSS Model contains the data model representation for DSS
There is a newer version: 6.2.RC1
/**
 * DSS - Digital Signature Services
 * Copyright (C) 2015 European Commission, provided under the CEF programme
 * 
 * This file is part of the "DSS - Digital Signature Services" project.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package eu.europa.esig.dss.model.x509;

import eu.europa.esig.dss.enumerations.X520Attributes;

import javax.security.auth.x500.X500Principal;

/**
 * This class contain utility methods to extract String representation of a {@code X500Principal} distinguishing name
 *
 */
public class X500PrincipalHelper {

	/**
	 * X500Principal to be processed
	 */
	private final X500Principal principal;

	/**
	 * Default constructor
	 *
	 * @param principal {@link X500Principal}
	 */
	public X500PrincipalHelper(X500Principal principal) {
		this.principal = principal;
	}

	/**
	 * Returns the current {@code X500Principal}
	 *
	 * @return {@link X500Principal}
	 */
	public X500Principal getPrincipal() {
		return principal;
	}

	/**
	 * Gets canonical name
	 *
	 * @return {@link String}
	 */
	public String getCanonical() {
		return principal.getName(X500Principal.CANONICAL);
	}

	/**
	 * Gets RFC2253 standard name
	 *
	 * @return {@link String}
	 */
	public String getRFC2253() {
		return principal.getName(X500Principal.RFC2253);
	}

	/**
	 * Gets pretty-printed RFC2253 standard name
	 *
	 * @return {@link String}
	 */
	public String getPrettyPrintRFC2253() {
		return principal.getName(X500Principal.RFC2253, X520Attributes.getOidDescriptions());
	}

	/**
	 * Gets encoded {@code X500Principal} object binaries
	 *
	 * @return byte array
	 */
	public byte[] getEncoded() {
		return principal.getEncoded();
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((principal == null) ? 0 : principal.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		X500PrincipalHelper other = (X500PrincipalHelper) obj;
		if (principal == null) {
			if (other.principal != null) {
				return false;
			}
		} else if (!principal.equals(other.principal)) {
			return false;
		}
		return true;
	}

}