public class LDAPFilter extends RawFilter
| Constructor and Description |
|---|
LDAPFilter(FilterType filterType,
ArrayList<RawFilter> filterComponents,
RawFilter notComponent,
String attributeType,
org.forgerock.opendj.ldap.ByteString assertionValue,
org.forgerock.opendj.ldap.ByteString subInitialElement,
ArrayList<org.forgerock.opendj.ldap.ByteString> subAnyElements,
org.forgerock.opendj.ldap.ByteString subFinalElement,
String matchingRuleID,
boolean dnAttributes)
Creates a new LDAP filter with the provided information.
|
LDAPFilter(SearchFilter filter)
Creates a new LDAP filter from the provided search filter.
|
| Modifier and Type | Method and Description |
|---|---|
static LDAPFilter |
decode(String filterString)
Decodes the provided string into an LDAP search filter.
|
org.forgerock.opendj.ldap.ByteString |
getAssertionValue()
Retrieves the assertion value for this search filter.
|
String |
getAttributeType()
Retrieves the attribute type for this search filter.
|
boolean |
getDNAttributes()
Retrieves the value of the DN attributes flag for this extensible match
filter, which indicates whether to perform matching on the components of
the DN.
|
ArrayList<RawFilter> |
getFilterComponents()
Retrieves the set of subordinate filter components for AND or OR searches.
|
FilterType |
getFilterType()
Retrieves the filter type for this search filter.
|
String |
getMatchingRuleID()
Retrieves the matching rule ID for this extensible match filter.
|
RawFilter |
getNOTComponent()
Retrieves the subordinate filter component for NOT searches.
|
ArrayList<org.forgerock.opendj.ldap.ByteString> |
getSubAnyElements()
Retrieves the set of subAny elements for this substring filter.
|
org.forgerock.opendj.ldap.ByteString |
getSubFinalElement()
Retrieves the subFinal element for this substring filter.
|
org.forgerock.opendj.ldap.ByteString |
getSubInitialElement()
Retrieves the subInitial component for this substring filter.
|
static LDAPFilter |
objectClassPresent()
Returns the
objectClass presence filter (objectClass=*). |
void |
setSubInitialElement(org.forgerock.opendj.ldap.ByteString subInitialElement)
Specifies the subInitial element for this substring filter.
|
SearchFilter |
toSearchFilter()
Converts this LDAP filter to a search filter that may be used by the
Directory Server's core processing.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this search filter to the provided
buffer.
|
create, create, createANDFilter, createApproximateFilter, createEqualityFilter, createExtensibleFilter, createGreaterOrEqualFilter, createLessOrEqualFilter, createNOTFilter, createORFilter, createPresenceFilter, createSubstringFilter, decode, toString, valueToFilterString, writepublic LDAPFilter(FilterType filterType, ArrayList<RawFilter> filterComponents, RawFilter notComponent, String attributeType, org.forgerock.opendj.ldap.ByteString assertionValue, org.forgerock.opendj.ldap.ByteString subInitialElement, ArrayList<org.forgerock.opendj.ldap.ByteString> subAnyElements, org.forgerock.opendj.ldap.ByteString subFinalElement, String matchingRuleID, boolean dnAttributes)
RawFilter class and any
use of this constructor outside of that class must be very careful to
ensure that all of the appropriate element types have been provided for the
associated filter type.filterType - The filter type for this filter.filterComponents - The filter components for AND and OR filters.notComponent - The filter component for NOT filters.attributeType - The attribute type for this filter.assertionValue - The assertion value for this filter.subInitialElement - The subInitial element for substring filters.subAnyElements - The subAny elements for substring filters.subFinalElement - The subFinal element for substring filters.matchingRuleID - The matching rule ID for extensible filters.dnAttributes - The dnAttributes flag for extensible filters.public LDAPFilter(SearchFilter filter)
filter - The search filter to use to create this LDAP filter.public static LDAPFilter decode(String filterString) throws LDAPException
filterString - The string representation of the search filter to
decode.LDAPException - If the provided string does not represent a valid
LDAP search filter.public FilterType getFilterType()
getFilterType in class RawFilterpublic ArrayList<RawFilter> getFilterComponents()
getFilterComponents in class RawFilternull if this is not an AND or OR search.public RawFilter getNOTComponent()
getNOTComponent in class RawFilternull if this is not a NOT search.public String getAttributeType()
getAttributeType in class RawFilternull if
there is none.public org.forgerock.opendj.ldap.ByteString getAssertionValue()
getAssertionValue in class RawFilternull
if there is none.public org.forgerock.opendj.ldap.ByteString getSubInitialElement()
getSubInitialElement in class RawFilternull if there is none.public void setSubInitialElement(org.forgerock.opendj.ldap.ByteString subInitialElement)
subInitialElement - The subInitial element for this substring
filter.public ArrayList<org.forgerock.opendj.ldap.ByteString> getSubAnyElements()
getSubAnyElements in class RawFilternull if there are none.public org.forgerock.opendj.ldap.ByteString getSubFinalElement()
getSubFinalElement in class RawFilternull if there is none.public String getMatchingRuleID()
getMatchingRuleID in class RawFilternull if there is none.public boolean getDNAttributes()
getDNAttributes in class RawFilterpublic SearchFilter toSearchFilter() throws DirectoryException
toSearchFilter in class RawFilterDirectoryException - If a problem occurs while attempting to
construct the search filter.public void toString(StringBuilder buffer)
public static LDAPFilter objectClassPresent()
objectClass presence filter (objectClass=*).objectClass presence filter (objectClass=*).Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.