com.rli.tools.sync.cacherefresh.tools

Class DnUtils

java.lang.Object

com.rli.tools.sync.cacherefresh.tools.DnUtils

public class DnUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VAR_DN Placeholder used in methods that do value substitution in distinguished names.
static java.lang.String	VAR_RDN Placeholder used in methods that do value substitution in distinguished names.

Method Summary

Modifier and Type	Method and Description
static int	calculateLevelDif(java.lang.String parentDn, java.lang.String childDn) Given a parent DN and a child DN, returns the difference in depth between those two DNs.
static java.lang.String[]	cutDN(java.lang.String dnToCut, java.lang.String rdnNameDivision) Splits a DN into three parts based on a given RDN name.
static boolean	equalsDN(java.lang.String dn1, java.lang.String dn2) Indicates whether the two given distinguished names are equal (note: comparison is case-insensitive).
static boolean	equalsDN(java.lang.String dn1, java.lang.String dn2, boolean isMetaDN) Indicates whether the two given distinguished names are equal (note: comparison is case-insensitive).
static java.lang.String[][]	explodeDN_ArrayNameValue(java.lang.String dn) Given a DN, returns an array where each element is a two-element String array (first element is the RDN name, second element is the RDN value) representing the RDN that composes the DN.
static java.lang.String[]	explodeDN(java.lang.String dn) Given a DN, returns an array where each element is an RDN that composes the DN.
static java.lang.String[]	explodeRDN_fromDN(java.lang.String dn) Returns a two-element String array containing two elements: the name and the value of the RDN for the given DN.
static java.lang.String[]	explodeRDN(java.lang.String rdn) Returns a two-element String array containing two elements: the name and the value of the given RDN.
static java.lang.String	extractNamingContext(java.lang.String dn) Given a DN, returns the naming context associated with the DN.
static java.lang.String	findValueInDn(java.lang.String dn, java.lang.String attrName) Returns the value of the given attribute if it is found in the DN.
static java.lang.String	getDnFromDvxCatalog(java.lang.String externalDn) For Radiant Logic Internal Use.
static java.lang.String	getDNPattern(java.lang.String dn) Returns the original DN with the value part from each RDN removed.
static java.lang.String	getFirstValueForComposite(java.lang.String compositeName, java.lang.String dn) For Radiant Logic Internal Use.
static java.lang.String	getIdValueFromRdnValue(java.lang.String rdnValue) Given an RDN value that has format 'value1 {value2}' returns the value between brackets.
static java.lang.String	getLabelInBetween(java.lang.String dn) Note: method intended for Radiant internal use.
static java.lang.String	getLastRdnValue(java.lang.String dn) Returns the string value of left-most RDN value for the specified DN.
static java.lang.String	getParentDNstr_UsingDN(java.lang.String dn) Returns the parent DN of the given DN.
static java.lang.String	getParentDNstr(java.lang.String dn) Returns the parent DN of the given DN.
static java.lang.String	getRdnAttrAndValueStr_UnJndi(java.lang.String dn) Returns the RDN for the given DN.
static java.lang.String	getRdnAttrAndValueStr(java.lang.String dn) Returns the RDN for the given DN.
static java.lang.String[]	getRdnAttributesFromRdnValue(java.lang.String rdnValue) This method splits the values found in the given RDN value based on whitespace and removes any value found between brackets. Given an RDN value that has format 'value1 value2 value3 {value4}' returns an array of strings containing ["value1", "value2", value3"].
static java.lang.String	getRdnIdValue(java.lang.String dn) Returns the value of the RDN (after the '=' sign) for the given DN.
static java.lang.String	getRdnIdValue(java.lang.String dn, boolean isDNJndiEncoded) Returns the value of the RDN (after the '=' sign) for the given DN.
static java.lang.String	getRdnName(java.lang.String dn) Returns the the attribute portion (before the '=' sign) of the RDN for the specified DN.
static java.lang.String	getRdnValue(java.lang.String dn) Returns the value of the RDN (after the '=' sign) for the given DN.
static java.lang.String	getRdnValue(java.lang.String dn, boolean isDnJndiEncoded) Returns the value of the RDN (after the '=' sign) for the given DN.
static boolean	hasParent(java.lang.String dnChild, java.lang.String dnParent) Indicates if the DN given in the second parameter is a parent of the DN given in the first parameter.
static boolean	hasSameRdnIdValue(java.lang.String dn1, java.lang.String dn2) Given two DNs that have the format "attribute=value1 {value2},..." returns true if both DNs have the same bracketed value.
static boolean	isDescendantOf(java.lang.String dnDown, java.lang.String dnTop) Returns true if the DN specified in the first argument is a descendant of the DN specified in second argument.
static boolean	isDN(java.lang.String s) Indicates if the given String is a distinguished name.
static void	main(java.lang.String[] args)
static java.lang.String	normalizeDN(java.lang.String dn) Returns the specified DN with the characters '=', ' ', '\', '/' replaced by an underscore '_'.
static java.lang.String	removeIdValueFromRdnValue(java.lang.String rdnValue) Given an RDN value that has format 'value1 {value2}' returns 'value1'.
static java.lang.String	removeSuffix(java.lang.String dn, java.lang.String suffixToRemove) Returns the DN with the given suffix removed from the original DN (if it is found).
static java.lang.String	replaceDNWithAttributesValue(java.lang.String dnWithAttributesToReplace, AttributesEnumeration attrsEnu) This method is used to populate parts of a DN based on variables specified in a Map.
static java.lang.String	updateBaseDNSuffix(java.lang.String value, java.lang.String dnTemplate) Returns a DN with the placeholders %rdn and %dn found in the DN template given in the second parameter, replaced by the value given in the first parameter.
static java.lang.String	updateStringWithRdnDnTag(java.lang.String str, java.lang.String value) Updates the given string with the given value where certain placeholders are found.
static java.lang.String	updateSuffix(java.lang.String dn, java.lang.String dnSuffixToUpdate, java.lang.String dnSuffixNewValue) Returns the DN with the given suffix updated with a new value.
static java.lang.String	updateSuffix(java.lang.String dn, java.lang.String dnSuffixToUpdate, java.lang.String dnSuffixNewValue, java.lang.String rules)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VAR_RDN

public static final java.lang.String VAR_RDN

Placeholder used in methods that do value substitution in distinguished names.

See Also:

Constant Field Values

VAR_DN

public static final java.lang.String VAR_DN

Placeholder used in methods that do value substitution in distinguished names.

See Also:

Constant Field Values

Method Detail

getLastRdnValue

public static java.lang.String getLastRdnValue(java.lang.String dn)

Returns the string value of left-most RDN value for the specified DN.

Example: getLastRdnValue("o=vds,dc=radiantlogic,dc=com") will return "vds".

Parameters:

dn - a distinguished name

Returns:

the string value of left-most RDN value for the specified DN.

getFirstValueForComposite

public static final java.lang.String getFirstValueForComposite(java.lang.String compositeName,
                                                               java.lang.String dn)

For Radiant Logic Internal Use.

Parameters:

compositeName -

dn -

Returns:

getDnFromDvxCatalog

public static java.lang.String getDnFromDvxCatalog(java.lang.String externalDn)

For Radiant Logic Internal Use.

Parameters:

externalDn -

Returns:

normalizeDN

public static java.lang.String normalizeDN(java.lang.String dn)

Returns the specified DN with the characters '=', ' ', '\', '/' replaced by an underscore '_'.

Example: normalizeDN("cn=John Doe,ou=Sales/Marketing") returns "cn_John_Doe_ou_Sales_Marketing"

Parameters:

dn - a distinguished name.

Returns:

the specified DN with the characters '=', ' ', '\', '/' replaced by an underscore '_'.

main

public static void main(java.lang.String[] args)

equalsDN

public static boolean equalsDN(java.lang.String dn1,
                               java.lang.String dn2)

Indicates whether the two given distinguished names are equal (note: comparison is case-insensitive).

Parameters:

dn1 - a distinguished name.

dn2 - a distinguished name.

Returns:

true if the two distinguished names are equal, false otherwise.

equalsDN

public static boolean equalsDN(java.lang.String dn1,
                               java.lang.String dn2,
                               boolean isMetaDN)

Indicates whether the two given distinguished names are equal (note: comparison is case-insensitive).

Parameters:

dn1 - a distinguished name.

dn2 - a distinguished name.

isMetaDN - if true, uses a comparison algorithm specific to meta DNs, should be set to false otherwise.

Returns:

true if the two given distinguished names are equal, false otherwise.

calculateLevelDif

public static int calculateLevelDif(java.lang.String parentDn,
                                    java.lang.String childDn)

Given a parent DN and a child DN, returns the difference in depth between those two DNs.
If the two DNs are equal, returns 0.
If the specified child DN is not a child (descendant) of the parent DN, returns -1.

Example: calculateLevelDif("dc=radiantlogic,dc=com", "ou=test,dc=dev,dc=radiantlogic,dc=com") returns 2.

calculateLevelDif("ou=Sales,o=vds", "dc=test,dc=com") returns -1.

Parameters:

parentDn - the parent DN.

childDn - the child DN, a descendant of the given parent DN.

Returns:

the difference in depth between the parent DN and the child DN.
Returns 0 if both DNs are equal.
Returns -1 if the child DN is not a child (descendant) of the parent DN.

getParentDNstr

public static java.lang.String getParentDNstr(java.lang.String dn)

Returns the parent DN of the given DN. Returns null if it does not exist.
Note: this method uses StringOperations in its implementation.

Example: getParentDNstr("dc=web,dc=radiantlogic,dc=com") returns "dc=radiantlogic,dc=com".

Parameters:

dn - a distinguished name.

Returns:

the parent DN of the given DN.
Returns null if it does not exist.

getParentDNstr_UsingDN

public static java.lang.String getParentDNstr_UsingDN(java.lang.String dn)

Returns the parent DN of the given DN. Returns null if it does not exist.
Note: this method uses a pool of DN objects in its implementation.

Example: getParentDNstr_UsingDN("dc=web,dc=radiantlogic,dc=com") returns "dc=radiantlogic,dc=com".

Parameters:

dn - a distinguished name.

Returns:

the parent DN of the given DN.
Returns null if it does not exist.

getRdnName

public static java.lang.String getRdnName(java.lang.String dn)

Returns the the attribute portion (before the '=' sign) of the RDN for the specified DN.

Example: getRdnName("ou=test,dc=radiantlogic,dc=com") returns "ou".

Parameters:

dn - a distinguished name.

Returns:

the attribute portion (before the '=' sign) of the RDN for the specified DN.

getRdnAttrAndValueStr_UnJndi

public static java.lang.String getRdnAttrAndValueStr_UnJndi(java.lang.String dn)

Returns the RDN for the given DN.
Note: DN must follow JNDI formatting rules.

Parameters:

dn - a distinguished name.

Returns:

the RDN for the given DN.

getRdnAttrAndValueStr

public static java.lang.String getRdnAttrAndValueStr(java.lang.String dn)

Returns the RDN for the given DN.
Note: DN must NOT follow JNDI formatting rules.

Parameters:

dn - a distinguished name.

Returns:

the RDN for the given DN.

getRdnValue

public static java.lang.String getRdnValue(java.lang.String dn)

Returns the value of the RDN (after the '=' sign) for the given DN.

Parameters:

dn - a distinguished name.

Returns:

the value of the RDN (after the '=' sign) for the given DN.

getRdnIdValue

public static java.lang.String getRdnIdValue(java.lang.String dn)

Returns the value of the RDN (after the '=' sign) for the given DN.
If the RDN is of the format "attribute=value {value2}" returns the value found between brackets.

Parameters:

dn - a distinguished name.

Returns:

the value of the RDN (after the '=' sign) for the given DN, or the value found between brackets if the RDN has format "attribute=value {value2}".

getRdnValue

public static java.lang.String getRdnValue(java.lang.String dn,
                                           boolean isDnJndiEncoded)

Returns the value of the RDN (after the '=' sign) for the given DN.

Parameters:

dn - a distinguished name.

isDnJndiEncoded - set to true to indicate that the DN is JNDI encoded, false otherwise.

Returns:

the value of the RDN (after the '=' sign) for the given DN.

getRdnIdValue

public static java.lang.String getRdnIdValue(java.lang.String dn,
                                             boolean isDNJndiEncoded)

Returns the value of the RDN (after the '=' sign) for the given DN.
If the RDN is of the format "attribute=value {value2}" returns the value found between brackets.

Parameters:

dn - a distinguished name.

isDNJndiEncoded - set to true to indicate that the DN is JNDI encoded, false otherwise.

Returns:

the value of the RDN (after the '=' sign) for the given DN,
or the value found between brackets if the RDN has format "attribute=value {value2}".

getIdValueFromRdnValue

public static java.lang.String getIdValueFromRdnValue(java.lang.String rdnValue)

Given an RDN value that has format 'value1 {value2}' returns the value between brackets.
If no bracketed value is found, returns the original RDN value.

Parameters:

rdnValue - the value of an RDN (after the '=' sign).

Returns:

the value found between brackets given an RDN value that has format 'value1 {value2}'.
If no bracketed value is found, returns the original RDN value.

removeIdValueFromRdnValue

public static java.lang.String removeIdValueFromRdnValue(java.lang.String rdnValue)

Given an RDN value that has format 'value1 {value2}' returns 'value1'.
If no bracketed value is found, returns the original RDN value.

Parameters:

rdnValue - the value of an RDN (after the '=' sign).

Returns:

the RDN value minus the brackets and whatever is between the brackets.
If no brackets/bracketed value are found, returns the original RDN value.

getRdnAttributesFromRdnValue

public static java.lang.String[] getRdnAttributesFromRdnValue(java.lang.String rdnValue)

This method splits the values found in the given RDN value based on whitespace and removes any value found between brackets.
Given an RDN value that has format 'value1 value2 value3 {value4}' returns an array of strings containing ["value1", "value2", value3"].

Parameters:

rdnValue - an RDN value.

Returns:

an array of strings containing parts of the given RDN value split by whitespace.

hasSameRdnIdValue

public static boolean hasSameRdnIdValue(java.lang.String dn1,
                                        java.lang.String dn2)

Given two DNs that have the format "attribute=value1 {value2},..." returns true if both DNs have the same bracketed value.

Parameters:

dn1 - a distinguished name with a bracketed value.

dn2 - a distinguished name with a bracketed value.

Returns:

returns true if both DNs have the same bracketed value, false otherwise.

isDescendantOf

public static boolean isDescendantOf(java.lang.String dnDown,
                                     java.lang.String dnTop)

Returns true if the DN specified in the first argument is a descendant of the DN specified in second argument.

Parameters:

dnDown - a distinguished name.

dnTop - a distinguished name.

Returns:

true if the DN specified in the first argument is a descendant of the DN specified in second argument, false otherwise.

replaceDNWithAttributesValue

public static java.lang.String replaceDNWithAttributesValue(java.lang.String dnWithAttributesToReplace,
                                                            AttributesEnumeration attrsEnu)

This method is used to populate parts of a DN based on variables specified in a Map.
The values from the Map are used to populate the parts of the DN that have an '@' sign.

Example: replaceDNWithAttributesValue with "cn=@,ou=@,dc=radiantlogic,dc=com" and a Map [ cn -> John Doe, ou -> People ] will return "cn=John Doe,ou=People,dc=radiantlogic,dc=com".

Parameters:

dnWithAttributesToReplace - a distinguished name with '@' signs where values will be inserted.

mapAttributes - a map of attributes (keys) and their values.

Returns:

the distinguished name populated with values from the Map.

cutDN

public static java.lang.String[] cutDN(java.lang.String dnToCut,
                                       java.lang.String rdnNameDivision)

Splits a DN into three parts based on a given RDN name.
The first element is the part of the DN up to the point where the RDN name is found.
The second element is the RDN name and value.
The third element contains the rest of the DN.

Example: cutDN("uid=1,dv=test,ou=beta,o=vds", "ou) returns [ "uid=1,dv=test", "ou=beta", "o=vds"].

Parameters:

dnToCut - the distinguished name that we are splitting.

rdnNameDivision - the RDN name used to determine where the DN is split.

Returns:

a string array containing the three split elements.

isDN

public static boolean isDN(java.lang.String s)

Indicates if the given String is a distinguished name.

Parameters:

s - a String

Returns:

true if the given String is a distinguished name, false otherwise.

extractNamingContext

public static java.lang.String extractNamingContext(java.lang.String dn)

Given a DN, returns the naming context associated with the DN.

Example: extractNamingContext("uid=jdoe,ou=people,o=vds") returns "o=vds".

Parameters:

dn - a distinguished name.

Returns:

the naming context associated with the dn.

explodeDN

public static java.lang.String[] explodeDN(java.lang.String dn)

Given a DN, returns an array where each element is an RDN that composes the DN.

Example: explodeDN("uid=jdoe,ou=people,o=vds") returns the array ["uid=jdoe", "ou=people", "o=vds"].

Parameters:

dn - a distinguished name.

Returns:

an array of RDN elements that compose the DN.

explodeDN_ArrayNameValue

public static java.lang.String[][] explodeDN_ArrayNameValue(java.lang.String dn)

Given a DN, returns an array where each element is a two-element String array (first element is the RDN name, second element is the RDN value) representing the RDN that composes the DN.

Example: explodeDN_ArrayNameValue("uid=jdoe,ou=people,o=vds") returns the array: [ ["uid", "jdoe"], ["ou","people"], ["o","vds"] ]

Parameters:

dn - a distinguished name.

Returns:

an array of RDN elements (each RDN is represented by a two-element String array) that compose the DN.

explodeRDN_fromDN

public static java.lang.String[] explodeRDN_fromDN(java.lang.String dn)

Returns a two-element String array containing two elements: the name and the value of the RDN for the given DN.

Example: explodeRDN_fromDN("uid=jdoe,ou=people,o=vds") returns ["uid", "jdoe"].

Parameters:

dn - a distinguished name.

Returns:

a two element String array containing two elements: the name and the value of the RDN for the given DN.

explodeRDN

public static java.lang.String[] explodeRDN(java.lang.String rdn)

Returns a two-element String array containing two elements: the name and the value of the given RDN.

Parameters:

rdn - a relative distinguished name.

Returns:

a two-element String array containing two elements: the name and the value of the given RDN.

getLabelInBetween

public static java.lang.String getLabelInBetween(java.lang.String dn)

Note: method intended for Radiant internal use. Returns the label between the current node and its next parent.

Example: getLabelInBetween("product=@,category=cars,company=*,...") returns "category=cars".

Parameters:

dn - a meta DN.

Returns:

the label between the current node and its next parent.

updateSuffix

public static java.lang.String updateSuffix(java.lang.String dn,
                                            java.lang.String dnSuffixToUpdate,
                                            java.lang.String dnSuffixNewValue)

Returns the DN with the given suffix updated with a new value. If the suffix is not found, returns the original DN.

Example: updateSuffix("uid=jdoe,ou=people,o=vds","ou=people,o=vds","dc=test") returns "uid=jdoe,dc=test".

Parameters:

dn - a distinguished name.

dnSuffixToUpdate - a suffix to update.

dnSuffixNewValue - a value to replace the suffix.

Returns:

the DN with the given suffix updated with a new value. If the suffix is not found, returns the original DN.

updateSuffix

public static java.lang.String updateSuffix(java.lang.String dn,
                                            java.lang.String dnSuffixToUpdate,
                                            java.lang.String dnSuffixNewValue,
                                            java.lang.String rules)

removeSuffix

public static java.lang.String removeSuffix(java.lang.String dn,
                                            java.lang.String suffixToRemove)

Returns the DN with the given suffix removed from the original DN (if it is found).

Example: removeSuffix("uid=jdoe,ou=People,o=vds", "o=vds") returns "uid=jdoe,ou=People".

Parameters:

dn - a distinguished name.

suffixToRemove - the suffix to remove from the DN.

Returns:

the DN with the given suffix removed from the original DN (if it is found).

updateBaseDNSuffix

public static java.lang.String updateBaseDNSuffix(java.lang.String value,
                                                  java.lang.String dnTemplate)

Returns a DN with the placeholders %rdn and %dn found in the DN template given in the second parameter, replaced by the value given in the first parameter.

Note: if you use the %rdn format, the value parameter must be an RDN of the form (attribute=value). If you use the %dn format, any value can be used for the value parameter.

Parameters:

value - a value that will be used to replace the placeholders.

dnTemplate - a distinguished name template (a DN that can contain %rdn or %dn as placeholders).

Returns:

a DN with the placeholders %rdn and %dn in the DN template replaced by the value in the first parameter.

updateStringWithRdnDnTag

public static java.lang.String updateStringWithRdnDnTag(java.lang.String str,
                                                        java.lang.String value)

Updates the given string with the given value where certain placeholders are found. The string will be updated in the places where it contains %dn and %rdn.

Note: if you use the %rdn format, the value parameter must be an RDN of the form (attribute=value). If you use the %dn format, any value can be used for the value parameter.

Examples: updateStringWithRdnDnTag("uid=%rdn,o=vds","uid=jdoe") return "uid=jdoe,o=vds".

updateStringWithRdnDnTag("uid=jdoe,%dn", "dc=radiantlogic,dc=com") returns "uid=jdoe,dc=radiantlogic,dc=com".

Parameters:

str - a string containing %rdn or %dn where values will be substituted.

value - the value that will be inserted anywhere %rdn or %dn are found in the string.

Returns:

the given string updated with the given value where %rdn and %dn were found.

getDNPattern

public static java.lang.String getDNPattern(java.lang.String dn)

Returns the original DN with the value part from each RDN removed.

Example: getDNPattern("uid=jdoe,ou=people,o=vds") returns "uid=,ou=,o=".

Parameters:

dn - a distinguished name.

Returns:

the original DN with the value part from each RDN removed.

hasParent

public static boolean hasParent(java.lang.String dnChild,
                                java.lang.String dnParent)

Indicates if the DN given in the second parameter is a parent of the DN given in the first parameter.

Example: hasParent("uid=jdoe,ou=people,o=vds", "o=vds") returns true.

Parameters:

dnChild - a distinguished name.

dnParent - a distinguished name.

Returns:

true if the DN given in the second parameter is a parent of the DN given in the first parameter, false otherwise.

findValueInDn

public static java.lang.String findValueInDn(java.lang.String dn,
                                             java.lang.String attrName)

Returns the value of the given attribute if it is found in the DN.
If the attribute appears more than once in the DN, only the left-most value is returned.

Example: findValueInDn("uid=jdoe,ou=sales,ou=people,o=vds", "ou") returns "sales".

Parameters:

dn - a distinguished name.

attrName - the name of an attribute to search for in the DN.

Returns:

the value of the given attribute if it is found in the DN, null otherwise.