edu.internet2.middleware.grouper.pspng

Class LdapObject

java.lang.Object

edu.internet2.middleware.grouper.pspng.LdapObject

public class LdapObject
extends Object

This is a wrapper around ldaptive's LdapEntry. It adds the following capabilities: 1) It keeps track of what attributes were fetched when the object was read from the ldap server. This will be used to raise an error if the fetching code didn't ask for an attribute that was later read from the object. 2) It will convert an Ldaptive LdapEntry into an UnboundId Entry, typically for the purposes of using UnboundId's ability to evaluate filters in memory. 3) It stores when the object was fetched to help with caching 4) It allows "dn" to be treated like a normal attribute

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	attributesRequested
Provisioner	provisioner

Constructor Summary

Constructors

Constructor and Description
LdapObject(org.ldaptive.LdapEntry ldapEntry, String[] attributesRequested)
LdapObject(String dn) Create an LdapObject wrapper around a dn.

Method Summary

Modifier and Type	Method and Description
void	addToIndex(String indexName, org.apache.commons.collections.MultiMap index, String attributeName) Add this LdapObject to an index of ldap objects based on the specified attribute's value.
void	addToLongIndex(String indexName, Map<Long,LdapObject> index, String attributeName) Add this LdapObject to a (single-valued) index of ldap objects based on the specified attribute's value.
void	addToStringIndex(String indexName, Map<String,LdapObject> index, String attributeName) Add this LdapObject to a (single-valued) index of ldap objects based on the specified attribute's value.
boolean	equals(Object obj)
org.ldaptive.LdapAttribute	getAttribute(String attributeName) Get the LdapAttribute from the stored entry.
String	getDn() Get the distinguished name of the ldap entry.
static String	getDnSummary(String dn, int maxNumberRdnComponents) Get just part of a DN, along with an elipses to indicate that it is a summary
Integer	getIntegerValue(String attributeName)
String	getLdifString()
Long	getLongValue(String attributeName)
Map<String,Collection<String>>	getMap()
org.ldaptive.LdapAttribute	getSingleValueAttribute(String attributeName)
String	getStringValue(String attributeName)
Collection<String>	getStringValues(String attributeName)
com.unboundid.ldap.sdk.Entry	getUnboundIdEntry()
int	hashCode()
boolean	matchesLdapFilter(org.ldaptive.SearchFilter filter)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

attributesRequested

protected final Set<String> attributesRequested

provisioner

public final Provisioner provisioner

Constructor Detail

LdapObject

public LdapObject(org.ldaptive.LdapEntry ldapEntry,
                  String[] attributesRequested)

LdapObject

public LdapObject(String dn)

Create an LdapObject wrapper around a dn. This will not have any attributes.

Parameters:

dn -

Method Detail

getDnSummary

public static String getDnSummary(String dn,
                                  int maxNumberRdnComponents)

Get just part of a DN, along with an elipses to indicate that it is a summary

Parameters:

dn -

maxNumberRdnComponents -

Returns:

getUnboundIdEntry

public com.unboundid.ldap.sdk.Entry getUnboundIdEntry()

getAttribute

public org.ldaptive.LdapAttribute getAttribute(String attributeName)

Get the LdapAttribute from the stored entry. This first checks whether the attribute requested was actually requested from the ldap server. If it was, then the LdapAttribute is simply returned; if the attribute was not requested, then this throws an IllegalStateException.

Parameters:

attributeName -

Returns:

getDn

public String getDn()

Get the distinguished name of the ldap entry. This is always lower-cased so it is easy to do case-insensitive comparisons or Map storage

Returns:

Lower-cased distinguished name

getSingleValueAttribute

public org.ldaptive.LdapAttribute getSingleValueAttribute(String attributeName)

getStringValue

public String getStringValue(String attributeName)

getStringValues

public Collection<String> getStringValues(String attributeName)

getLongValue

public Long getLongValue(String attributeName)

getIntegerValue

public Integer getIntegerValue(String attributeName)

getMap

public Map<String,Collection<String>> getMap()

addToStringIndex

public void addToStringIndex(String indexName,
                             Map<String,LdapObject> index,
                             String attributeName)

Add this LdapObject to a (single-valued) index of ldap objects based on the specified attribute's value.

Parameters:

indexName - Name to use when logging problems with idnex

index - Map of (string) attribute values to their LdapObjects

attributeName - What attribute should be key of the requested index

addToLongIndex

public void addToLongIndex(String indexName,
                           Map<Long,LdapObject> index,
                           String attributeName)

Add this LdapObject to a (single-valued) index of ldap objects based on the specified attribute's value.

Parameters:

indexName - Name to use when logging problems with idnex

index - Map of (string) attribute values to their LdapObjects

attributeName - What attribute should be key of the requested index

addToIndex

public void addToIndex(String indexName,
                       org.apache.commons.collections.MultiMap index,
                       String attributeName)

Add this LdapObject to an index of ldap objects based on the specified attribute's value.

Parameters:

indexName -

index -

attributeName -

matchesLdapFilter

public boolean matchesLdapFilter(org.ldaptive.SearchFilter filter)
                          throws PspException

Throws:

PspException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getLdifString

public String getLdifString()
                     throws PspException

Throws:

PspException