public interface LDAPMessageFactory
Modifier and Type | Method and Description |
---|---|
LDAPAddRequest |
createAddRequest(String dn,
LDAPAttribute... attributes)
Creates a new add request, which can be used to perform an LDAP add operation to
create a new entry in the directory.
|
LDAPAttribute |
createAttribute(String attrName,
byte[]... values)
Creates a new attribute, which can be used to create an LDAP add request.
|
LDAPAttribute |
createAttribute(String attrName,
String... values)
Creates a new attribute, which can be used to create an LDAP add request.
|
LDAPBindRequest |
createBindRequest(String bindDN,
String password)
Creates a new bind request, which can be used to perform an LDAP simple bind operation,
which authenticates using a bind DN and password.
|
LDAPCompareRequest |
createCompareRequest(String dn,
String attrName,
byte[] assertionValue)
Creates a new compare request, which can be used to perform an LDAP compare operation to
determine whether a specified entry contains a given attribute value.
|
LDAPCompareRequest |
createCompareRequest(String dn,
String attrName,
String assertionValue)
Creates a new compare request, which can be used to perform an LDAP compare operation to
determine whether a specified entry contains a given attribute value.
|
LDAPDeleteRequest |
createDeleteRequest(String dn)
Creates a new delete request, which can be used to perform an LDAP delete operation to
remove an entry from the directory.
|
LDAPModification |
createModification(LDAPModificationType type,
String attrName)
Creates a new modification, which can be used to create an LDAP modify request.
|
LDAPModification |
createModification(LDAPModificationType type,
String attrName,
byte[]... values)
Creates a new modification, which can be used to create an LDAP modify request.
|
LDAPModification |
createModification(LDAPModificationType type,
String attrName,
String... values)
Creates a new modification, which can be used to create an LDAP modify request.
|
LDAPModifyDNRequest |
createModifyDNRequest(String dn,
String newRDN,
boolean deleteOldRDN)
Creates a new modify DN request, which can be used to perform an LDAP modify DN operation to
rename and/or move an entry or subtree in the directory.
|
LDAPModifyDNRequest |
createModifyDNRequest(String dn,
String newRDN,
boolean deleteOldRDN,
String newSuperiorDN)
Creates a new modify DN request, which can be used to perform an LDAP modify DN operation to
rename and/or move an entry or subtree in the directory.
|
LDAPModifyRequest |
createModifyRequest(String dn,
LDAPModification... modifications)
Creates a new modify request, which can be used to perform an LDAP modify operation to
update an entry in the directory.
|
LDAPSearchRequest |
createSearchRequest(String base,
LDAPSearchScope scope,
String filter,
String... attributes)
Creates a new search request, which can be used to perform an LDAP search operation to
retrieve entries that match a given set of criteria.
|
LDAPAddRequest createAddRequest(String dn, LDAPAttribute... attributes) throws LDAPException
dn
- the distinguished name for the add operation. It must not be null.attributes
- the set of attributes for the add operation. It must not be null.LDAPException
- if failed to create a valid add request for a given DN and set of
attributes.LDAPProvider.sendRequest(LDAPRequest)
LDAPAttribute createAttribute(String attrName, String... values) throws LDAPException
attrName
- the name for this attribute. It must not be null.values
- the set of values for this attribute. It must not be null.LDAPException
- if failed to create a valid attribute for a given name and set of values.LDAPAddRequest
LDAPAttribute createAttribute(String attrName, byte[]... values) throws LDAPException
attrName
- the name for this attribute. It must not be null.values
- the set of values for this attribute. It must not be null.LDAPException
- if failed to create a valid attribute for a given name and set of values.LDAPAddRequest
LDAPBindRequest createBindRequest(String bindDN, String password) throws LDAPException
bindDN
- the distinguished name for the simple bind operation.password
- the password for the simple bind operation.LDAPException
- if failed to create a valid bind request for a given bind DN and password.LDAPProvider.sendRequest(LDAPRequest)
LDAPCompareRequest createCompareRequest(String dn, String attrName, String assertionValue) throws LDAPException
dn
- the entry distinguished name for the compare operation. It must not be null.attrName
- the name of the attribute for the compare operation. It must not be null.assertionValue
- the assertion value for the compare operation. It must not be null.LDAPException
- if failed to create a valid compare request for a given DN, attribute
name and assertion value.LDAPProvider.sendRequest(LDAPRequest)
LDAPCompareRequest createCompareRequest(String dn, String attrName, byte[] assertionValue) throws LDAPException
dn
- the entry distinguished name for the compare operation. It must not be null.attrName
- the name of the attribute for the compare operation. It must not be null.assertionValue
- the assertion value for the compare operation. It must not be null.LDAPException
- if failed to create a valid compare request for a given DN, attribute
name and assertion value.LDAPProvider.sendRequest(LDAPRequest)
LDAPDeleteRequest createDeleteRequest(String dn) throws LDAPException
dn
- the distinguished name for the delete operation. It must not be null.LDAPException
- if failed to create a valid delete request for a given DN.LDAPProvider.sendRequest(LDAPRequest)
LDAPModification createModification(LDAPModificationType type, String attrName) throws LDAPException
type
- the modification type for this modification. It must not be null.attrName
- the name of the attribute to target with this modification. It must not be null.LDAPException
- if failed to create a valid modification for a given type and attribute name.LDAPModifyRequest
LDAPModification createModification(LDAPModificationType type, String attrName, String... values) throws LDAPException
type
- the modification type for this modification. It must not be null.attrName
- the name of the attribute to target with this modification. It must not be null.values
- the set of attribute values for this modification. It must not be null.LDAPException
- if failed to create a valid modification for a given type, attribute name
and values.LDAPModifyRequest
LDAPModification createModification(LDAPModificationType type, String attrName, byte[]... values) throws LDAPException
type
- the modification type for this modification. It must not be null.attrName
- the name of the attribute to target with this modification. It must not be null.values
- the set of attribute values for this modification. It must not be null.LDAPException
- if failed to create a valid modification for a given type, attribute name
and values.LDAPModifyRequest
LDAPModifyRequest createModifyRequest(String dn, LDAPModification... modifications) throws LDAPException
dn
- the distinguished name for the modify operation. It must not be null.modifications
- the set of modifications to apply to the entry. It must not be null.LDAPException
- if failed to create a valid modify request for a given DN and set
of modifications.LDAPProvider.sendRequest(LDAPRequest)
LDAPModifyDNRequest createModifyDNRequest(String dn, String newRDN, boolean deleteOldRDN) throws LDAPException
dn
- the entry distinguished name for the modify DN operation. It must not be null.newRDN
- the new relative distinguished name for the modify DN operation. It must not be null.deleteOldRDN
- specifies whether the old relative distinguished name value should be removed
from the entry.LDAPException
- if failed to create a valid modify DN request for a given DN, newRDN and
deleteOldRDN indicator.LDAPProvider.sendRequest(LDAPRequest)
LDAPModifyDNRequest createModifyDNRequest(String dn, String newRDN, boolean deleteOldRDN, String newSuperiorDN) throws LDAPException
dn
- the entry distinguished name for the modify DN operation. It must not be null.newRDN
- the new relative distinguished name for the modify DN operation. It must not be null.deleteOldRDN
- specifies whether the old relative distinguished name value should be removed
from the entry.newSuperiorDN
- the new superior distinguished name for the modify DN operation.LDAPException
- if failed to create a valid modify DN request for a given DN, newRDN,
deleteOldRDN indicator and newSuperiorDN.LDAPProvider.sendRequest(LDAPRequest)
LDAPSearchRequest createSearchRequest(String base, LDAPSearchScope scope, String filter, String... attributes) throws LDAPException
base
- the base distinguished name from which to search. It must not be null.scope
- the scope of the entries to search. It must not be null.filter
- the search filter specifying the search criteria. It must not be null.attributes
- the list of attributes to return in the search results.LDAPException
- if failed to create a valid search request for a given set of criteria.LDAPProvider.sendRequest(LDAPRequest)