com.entrust.toolkit.util.net

Class LDAPSearchData

java.lang.Object

com.entrust.toolkit.util.net.LDAPSearchData

public class LDAPSearchData
extends java.lang.Object

This class is used to encapsulate data from an LDAP search done with the LDAPConnection object.

Constructor Summary

Constructors

Constructor and Description
LDAPSearchData(byte[][] ldapData, LdapDirectory directory, LDAPAttributeType attributeType, java.lang.String directoryHostAndPort, java.lang.String dn) Create an LDAPSearchData containing the data retrieved from the LDAP search, the Attribute type used in the search, the directoryHostAndPort information and the DN used for the search.

Method Summary

Modifier and Type	Method and Description
LDAPAttributeType	getAttributeType() Return the attribute type that was used for the search
LdapDirectory	getDirectory() Return the LdapDirectory that was used for the search
java.lang.String	getDirectoryHostAndPort() Return the Directory Hostname and port information used to connect to the LDAP server.
java.lang.String	getDN() Return the DN used for the search
java.lang.String	getInvalidSearchKey() Return the invalidSearch key, used if the invalidSearch cache is used.
byte[][]	getLdapData() Return the raw LDAP data retrieved from the server

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSearchData

public LDAPSearchData(byte[][] ldapData,
                      LdapDirectory directory,
                      LDAPAttributeType attributeType,
                      java.lang.String directoryHostAndPort,
                      java.lang.String dn)

Create an LDAPSearchData containing the data retrieved from the LDAP search, the Attribute type used in the search, the directoryHostAndPort information and the DN used for the search.

Parameters:

ldapData - The LDAP data bytes retrieved from the LDAP server

directory - The LDAP directory used to perform the search

attributeType - The Attribute type that was searched

directoryHostAndPort - The LDAPDirectories host and port information

dn - The DN used for the search

Method Detail

getLdapData

public byte[][] getLdapData()

Return the raw LDAP data retrieved from the server

Returns:

the LDAP data retrieved from the server

getDirectoryHostAndPort

public java.lang.String getDirectoryHostAndPort()

Return the Directory Hostname and port information used to connect to the LDAP server.

Returns:

the directory hostname and port information used to connect to the LDAP server

getDN

public java.lang.String getDN()

Return the DN used for the search

Returns:

the DN used for the search

getAttributeType

public LDAPAttributeType getAttributeType()

Return the attribute type that was used for the search

Returns:

the attribute type used for the search.

getDirectory

public LdapDirectory getDirectory()

Return the LdapDirectory that was used for the search

Returns:

The LdapDirectory used for the search

getInvalidSearchKey

public java.lang.String getInvalidSearchKey()

Return the invalidSearch key, used if the invalidSearch cache is used. This is created by concatenating the directoryHostAndPort, DN and attribute type as follows:

 m_directoryHostAndPort + "/" + m_dn + "/" + m_attributeType.getDirectoryAttributeName()
 

Returns:

the invalidSearchKey