|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.RawFilter
org.opends.server.protocols.ldap.LDAPFilter
public class LDAPFilter
This class defines the data structures and methods to use when interacting with an LDAP search filter, which defines a set of criteria for locating entries in a search request.
Constructor Summary | |
---|---|
LDAPFilter(FilterType filterType,
java.util.ArrayList<RawFilter> filterComponents,
RawFilter notComponent,
java.lang.String attributeType,
ByteString assertionValue,
ByteString subInitialElement,
java.util.ArrayList<ByteString> subAnyElements,
ByteString subFinalElement,
java.lang.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. |
Method Summary | |
---|---|
static LDAPFilter |
decode(java.lang.String filterString)
Decodes the provided string into an LDAP search filter. |
ByteString |
getAssertionValue()
Retrieves the assertion value for this search filter. |
java.lang.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. |
java.util.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. |
java.lang.String |
getMatchingRuleID()
Retrieves the matching rule ID for this extensible match filter. |
RawFilter |
getNOTComponent()
Retrieves the subordinate filter component for NOT searches. |
java.util.ArrayList<ByteString> |
getSubAnyElements()
Retrieves the set of subAny elements for this substring filter. |
ByteString |
getSubFinalElement()
Retrieves the subFinal element for this substring filter. |
ByteString |
getSubInitialElement()
Retrieves the subInitial component for this substring filter. |
void |
setAssertionValue(ByteString assertionValue)
Specifies the assertion value for this search filter. |
void |
setAttributeType(java.lang.String attributeType)
Specifies the attribute type for this search filter. |
void |
setDNAttributes(boolean dnAttributes)
Specifies the value of the DN attributes flag for this extensible match filter. |
void |
setFilterComponents(java.util.ArrayList<RawFilter> filterComponents)
Specifies the set of subordinate filter components for AND or OR searches. |
void |
setMatchingRuleID(java.lang.String matchingRuleID)
Specifies the matching rule ID for this extensible match filter. |
void |
setNOTComponent(RawFilter notComponent)
Specifies the subordinate filter component for NOT searches. |
void |
setSubAnyElements(java.util.ArrayList<ByteString> subAnyElements)
Specifies the set of subAny values for this substring filter. |
void |
setSubFinalElement(ByteString subFinalElement)
Specifies the subFinal element for this substring filter. |
void |
setSubInitialElement(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(java.lang.StringBuilder buffer)
Appends a string representation of this search filter to the provided buffer. |
Methods inherited from class org.opends.server.types.RawFilter |
---|
create, create, createANDFilter, createApproximateFilter, createEqualityFilter, createExtensibleFilter, createGreaterOrEqualFilter, createLessOrEqualFilter, createNOTFilter, createORFilter, createPresenceFilter, createSubstringFilter, decode, encode, toString, valueToFilterString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPFilter(FilterType filterType, java.util.ArrayList<RawFilter> filterComponents, RawFilter notComponent, java.lang.String attributeType, ByteString assertionValue, ByteString subInitialElement, java.util.ArrayList<ByteString> subAnyElements, ByteString subFinalElement, java.lang.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.Method Detail |
---|
public static LDAPFilter decode(java.lang.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 RawFilter
public java.util.ArrayList<RawFilter> getFilterComponents()
getFilterComponents
in class RawFilter
null
if this is not an AND or OR search.public void setFilterComponents(java.util.ArrayList<RawFilter> filterComponents)
setFilterComponents
in class RawFilter
filterComponents
- The set of subordinate filter components for AND
or OR searches.public RawFilter getNOTComponent()
getNOTComponent
in class RawFilter
null
if this is not a NOT search.public void setNOTComponent(RawFilter notComponent)
setNOTComponent
in class RawFilter
notComponent
- The subordinate filter component for NOT searches.public java.lang.String getAttributeType()
getAttributeType
in class RawFilter
null
if
there is none.public void setAttributeType(java.lang.String attributeType)
setAttributeType
in class RawFilter
attributeType
- The attribute type for this search filter.public ByteString getAssertionValue()
getAssertionValue
in class RawFilter
null
if there is none.public void setAssertionValue(ByteString assertionValue)
setAssertionValue
in class RawFilter
assertionValue
- The assertion value for this search filter.public ByteString getSubInitialElement()
getSubInitialElement
in class RawFilter
null
if there is none.public void setSubInitialElement(ByteString subInitialElement)
setSubInitialElement
in class RawFilter
subInitialElement
- The subInitial element for this substring
filter.public java.util.ArrayList<ByteString> getSubAnyElements()
getSubAnyElements
in class RawFilter
null
if there are none.public void setSubAnyElements(java.util.ArrayList<ByteString> subAnyElements)
setSubAnyElements
in class RawFilter
subAnyElements
- The set of subAny elements for this substring
filter.public ByteString getSubFinalElement()
getSubFinalElement
in class RawFilter
null
if there is none.public void setSubFinalElement(ByteString subFinalElement)
setSubFinalElement
in class RawFilter
subFinalElement
- The subFinal element for this substring filter.public java.lang.String getMatchingRuleID()
getMatchingRuleID
in class RawFilter
null
if there is none.public void setMatchingRuleID(java.lang.String matchingRuleID)
setMatchingRuleID
in class RawFilter
matchingRuleID
- The matching rule ID for this extensible match
filter.public boolean getDNAttributes()
getDNAttributes
in class RawFilter
public void setDNAttributes(boolean dnAttributes)
setDNAttributes
in class RawFilter
dnAttributes
- The value of the DN attributes flag for this
extensible match filter.public SearchFilter toSearchFilter() throws DirectoryException
toSearchFilter
in class RawFilter
DirectoryException
- If a problem occurs while attempting to
construct the search filter.public void toString(java.lang.StringBuilder buffer)
toString
in class RawFilter
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |