Package com.nimbusds.common.ldap
Class FilterTemplate
java.lang.Object
com.nimbusds.common.ldap.FilterTemplate
LDAP filter template. This class is immutable.
Example filter template with a "%u" placeholder:
(|(uid=%u)(mail=%u))
-
Constructor Summary
ConstructorDescriptionFilterTemplate
(String template) Creates a new filter template with a "%u" placeholder.FilterTemplate
(String template, String placeholder) Creates a new filter template. -
Method Summary
Modifier and TypeMethodDescriptionApplies the specified parameter to this filter template and returns the resulting LDAP filter string.Gets the placeholder.Gets the template.toString()
Returns a string representation of this filter template.
-
Constructor Details
-
FilterTemplate
Creates a new filter template.- Parameters:
template
- The filter template. Must contain one or more placeholders. Must not benull
.placeholder
- The placeholder, e.g. "%u". Must not benull
.- Throws:
IllegalArgumentException
- If the template doesn't contain at least one placeholder or doesn't represent a valid LDAP filter.
-
FilterTemplate
Creates a new filter template with a "%u" placeholder.- Parameters:
template
- The filter template. Must contain one or more "%u" placeholders. Must not benull
.- Throws:
IllegalArgumentException
- If the template doesn't contain at least one placeholder or doesn't represent a valid LDAP filter.
-
-
Method Details
-
getTemplate
Gets the template.- Returns:
- The template.
-
getPlaceholder
Gets the placeholder.- Returns:
- The placeholder.
-
apply
Applies the specified parameter to this filter template and returns the resulting LDAP filter string. Special filter characters in the parameter are escaped.Example:
Template: "(|(uid=%u)(mail=%u))"
Placeholder: "%u"
Parameter: "alice"
Resulting filter: "(|(uid=alice)(mail=alice))"
- Parameters:
param
- The parameter to apply. Must not benull
.- Returns:
- The resulting LDAP filter string.
-
toString
Returns a string representation of this filter template.
-