org.keycloak.storage.ldap.idm.model.LDAPDn クラス

org.keycloak.storage.ldap.idm.model.LDAPDn 連携図

クラス
class	Entry

公開メンバ関数
boolean	equals (Object obj)
int	hashCode ()
String	toString ()
String	getFirstRdn ()
String	getFirstRdnAttrName ()
String	getFirstRdnAttrValue ()
LDAPDn	getParentDn ()
boolean	isDescendantOf (LDAPDn expectedParentDn)
void	addFirst (String rdnName, String rdnValue)

静的公開メンバ関数
static LDAPDn	fromString (String dnString)

非公開メンバ関数
	LDAPDn ()
	LDAPDn (Deque< Entry > entries)
String	unescapeValue (String escaped)
void	addLast (String rdnName, String rdnValue)

静的非公開メンバ関数
static String	toString (Collection< Entry > entries)

非公開変数類
final Deque< Entry >	entries

詳解

著者

Marek Posolda

構築子と解体子

LDAPDn() [1/2]

org.keycloak.storage.ldap.idm.model.LDAPDn.LDAPDn ( )

inlineprivate

                     {
        this.entries = new LinkedList<>();
    }

LDAPDn() [2/2]

org.keycloak.storage.ldap.idm.model.LDAPDn.LDAPDn ( Deque< Entry >  entries )

inlineprivate

                                         {
        this.entries = entries;
    }

関数詳解

addFirst()

void org.keycloak.storage.ldap.idm.model.LDAPDn.addFirst ( String  rdnName, String  rdnValue  )

inline

                                                          {
        rdnValue = Rdn.escapeValue(rdnValue);
        entries.addFirst(new Entry(rdnName, rdnValue));
    }

addLast()

void org.keycloak.storage.ldap.idm.model.LDAPDn.addLast ( String  rdnName, String  rdnValue  )

inlineprivate

                                                          {
        entries.addLast(new Entry(rdnName, rdnValue));
    }

equals()

boolean org.keycloak.storage.ldap.idm.model.LDAPDn.equals ( Object  obj )

inline

                                      {
        if (!(obj instanceof LDAPDn)) {
            return false;
        }

        return toString().equals(obj.toString());
    }

fromString()

static LDAPDn org.keycloak.storage.ldap.idm.model.LDAPDn.fromString ( String  dnString )

inlinestatic

                                                     {
        LDAPDn dn = new LDAPDn();
        
        // In certain OpenLDAP implementations the uniqueMember attribute is mandatory
        // Thus, if a new group is created, it will contain an empty uniqueMember attribute
        // Later on, when adding members, this empty attribute will be kept
        // Keycloak must be able to process it, properly, w/o throwing an ArrayIndexOutOfBoundsException
        if(dnString.trim().isEmpty())
            return dn;
        
        String[] rdns = dnString.split("(?<!\\\\),");
        for (String entryStr : rdns) {
            String[] rdn = entryStr.split("(?<!\\\\)=");
            if (rdn.length >1) {
                dn.addLast(rdn[0].trim(), rdn[1].trim());
            } else {
                dn.addLast(rdn[0].trim(), "");
            }
        }

        return dn;
    }

getFirstRdn()

String org.keycloak.storage.ldap.idm.model.LDAPDn.getFirstRdn ( )

inline

戻り値

string like "uid=joe" from the DN like "uid=joe,dc=something,dc=org"

                                {
        Entry firstEntry = entries.getFirst();
        return firstEntry.attrName + "=" + unescapeValue(firstEntry.attrValue);
    }

getFirstRdnAttrName()

String org.keycloak.storage.ldap.idm.model.LDAPDn.getFirstRdnAttrName ( )

inline

戻り値

string attribute name like "uid" from the DN like "uid=joe,dc=something,dc=org"

                                        {
        Entry firstEntry = entries.getFirst();
        return firstEntry.attrName;
    }

getFirstRdnAttrValue()

String org.keycloak.storage.ldap.idm.model.LDAPDn.getFirstRdnAttrValue ( )

inline

戻り値

string attribute value like "joe" from the DN like "uid=joe,dc=something,dc=org"

                                         {
        Entry firstEntry = entries.getFirst();
        String dnEscaped = firstEntry.attrValue;
        return unescapeValue(dnEscaped);
    }

getParentDn()

LDAPDn org.keycloak.storage.ldap.idm.model.LDAPDn.getParentDn ( )

inline

戻り値

DN like "dc=something,dc=org" from the DN like "uid=joe,dc=something,dc=org". Returned DN will be new clone not related to the original DN instance.

                                {
        LinkedList<Entry> parentDnEntries = new LinkedList<>(entries);
        parentDnEntries.remove();
        return new LDAPDn(parentDnEntries);
    }

hashCode()

int org.keycloak.storage.ldap.idm.model.LDAPDn.hashCode ( )

inline

                          {
        return toString().hashCode();
    }

isDescendantOf()

boolean org.keycloak.storage.ldap.idm.model.LDAPDn.isDescendantOf ( LDAPDn  expectedParentDn )

inline

                                                           {
        int parentEntriesCount = expectedParentDn.entries.size();

        Deque<Entry> myEntries = new LinkedList<>(this.entries);
        boolean someRemoved = false;
        while (myEntries.size() > parentEntriesCount) {
            myEntries.removeFirst();
            someRemoved = true;
        }

        String myEntriesParentStr = toString(myEntries).toLowerCase();
        String expectedParentDnStr = expectedParentDn.toString().toLowerCase();
        return someRemoved && myEntriesParentStr.equals(expectedParentDnStr);
    }

toString() [1/2]

String org.keycloak.storage.ldap.idm.model.LDAPDn.toString ( )

inline

                             {
        return toString(entries);
    }

toString() [2/2]

static String org.keycloak.storage.ldap.idm.model.LDAPDn.toString ( Collection< Entry >  entries )

inlinestaticprivate

                                                              {
        StringBuilder builder = new StringBuilder();

        boolean first = true;
        for (Entry rdn : entries) {
            if (first) {
                first = false;
            } else {
                builder.append(",");
            }
            builder.append(rdn.attrName).append("=").append(rdn.attrValue);
        }

        return builder.toString();
    }

unescapeValue()

String org.keycloak.storage.ldap.idm.model.LDAPDn.unescapeValue ( String  escaped )

inlineprivate

                                                 {
        // Something needed to handle non-String types?
        return Rdn.unescapeValue(escaped).toString();
    }

メンバ詳解

entries

final Deque<Entry> org.keycloak.storage.ldap.idm.model.LDAPDn.entries

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/federation/src/federation/ldap/src/main/java/org/keycloak/storage/ldap/idm/model/LDAPDn.java