org.ligoj.app.plugin.id.DnUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plugin-id Show documentation

There is a newer version: 2.2.5

/*
 * Licensed under MIT (https://github.com/ligoj/ligoj/blob/master/LICENSE)
 */
package org.ligoj.app.plugin.id;

import java.util.Collection;

import jakarta.validation.constraints.NotNull;

import org.apache.commons.lang3.StringUtils;
import org.ligoj.app.api.Normalizer;

/**
 * Distinguished Name (DN) utilities. Originally designed for LDAP, but now used to match tree data.
 */
public final class DnUtils {

	private DnUtils() {
		// Factory pattern
	}

	/**
	 * Return the RDN of the DN.
	 * 
	 * @param dn
	 *            The DN to extract RDN.
	 * @return the RDN of given DN.
	 */
	public static String toRdn(@NotNull final String dn) {
		return Normalizer.normalize(StringUtils.split(dn, "=,")[1]);
	}

	/**
	 * Return the RDN of the parent DN.
	 * 
	 * @param dn
	 *            The DN to extract RDN.
	 * @return the normalized RDN of the parent of given DN.
	 */
	public static String toParentRdn(@NotNull final String dn) {
		return Normalizer.normalize(StringUtils.split(dn, "=,")[3]);
	}

	/**
	 * Indicates the given parent DN is equals or contains the other DN
	 * 
	 * @param parentDn
	 *            Parent DN.
	 * @param childDn
	 *            Child DN
	 * @return true when child=parent or child=.*,parent
	 */
	public static boolean equalsOrParentOf(@NotNull final String parentDn, final String childDn) {
		return childDn != null && (childDn.endsWith("," + parentDn) || childDn.equals(parentDn));
	}

	/**
	 * Indicates the given parent DN collection contains the exact DN or sub DN
	 * 
	 * @param parentDns
	 *            Collection of parent DNs.
	 * @param childDn
	 *            Child DN
	 * @return true when child=parent or child=.*,parent
	 * @see DnUtils#equalsOrParentOf(String, String)
	 */
	public static boolean equalsOrParentOf(@NotNull final Collection parentDns, final String childDn) {
		for (final var dn : parentDns) {
			if (equalsOrParentOf(dn, childDn)) {
				return true;
			}
		}
		return false;
	}

}