Class FrameworkUtil.FilterImpl

  • All Implemented Interfaces:
    Filter
    Enclosing class:
    FrameworkUtil

    private static class FrameworkUtil.FilterImpl
    extends java.lang.Object
    implements Filter
    RFC 1960-based Filter. Filter objects can be created by calling the constructor with the desired filter string. A Filter object can be called numerous times to determine if the match argument matches the filter string that was used to create the Filter object.

    The syntax of a filter string is the string representation of LDAP search filters as defined in RFC 1960: A String Representation of LDAP Search Filters (available at http://www.ietf.org/rfc/rfc1960.txt). It should be noted that RFC 2254: A String Representation of LDAP Search Filters (available at http://www.ietf.org/rfc/rfc2254.txt) supersedes RFC 1960 but only adds extensible matching and is not applicable for this API.

    The string representation of an LDAP search filter is defined by the following grammar. It uses a prefix format.

       <filter> ::= '(' <filtercomp> ')'
       <filtercomp> ::= <and> | <or> | <not> | <item>
       <and> ::= '&' <filterlist>
       <or> ::= '|' <filterlist>
       <not> ::= '!' <filter>
       <filterlist> ::= <filter> | <filter> <filterlist>
       <item> ::= <simple> | <present> | <substring>
       <simple> ::= <attr> <filtertype> <value>
       <filtertype> ::= <equal> | <approx> | <greater> | <less>
       <equal> ::= '='
       <approx> ::= '˜='
       <greater> ::= '>='
       <less> ::= '<='
       <present> ::= <attr> '=*'
       <substring> ::= <attr> '=' <initial> <any> <final>
       <initial> ::= NULL | <value>
       <any> ::= '*' <starval>
       <starval> ::= NULL | <value> '*' <starval>
       <final> ::= NULL | <value>
     
    <attr> is a string representing an attribute, or key, in the properties objects of the registered services. Attribute names are not case sensitive; that is cn and CN both refer to the same attribute. <value> is a string representing the value, or part of one, of a key in the properties objects of the registered services. If a <value> must contain one of the characters ' *' or '(' or ')', these characters should be escaped by preceding them with the backslash '\' character. Note that although both the <substring> and <present> productions can produce the 'attr=*' construct, this construct is used only to denote a presence filter.

    Examples of LDAP filters are:

       "(cn=Babs Jensen)"
       "(!(cn=Tim Howes))"
       "(&(" + Constants.OBJECTCLASS + "=Person)(|(sn=Jensen)(cn=Babs J*)))"
       "(o=univ*of*mich*)"
     

    The approximate match (~=) is implementation specific but should at least ignore case and white space differences. Optional are codes like soundex or other smart "closeness" comparisons.

    Comparison of values is not straightforward. Strings are compared differently than numbers and it is possible for a key to have multiple values. Note that that keys in the match argument must always be strings. The comparison is defined by the object type of the key's value. The following rules apply for comparison:

    Property Value Type Comparison Type
    String String comparison
    Integer, Long, Float, Double, Byte, Short, BigInteger, BigDecimal numerical comparison
    Character character comparison
    Boolean equality comparisons only
    [] (array) recursively applied to values
    Collection recursively applied to values
    Note: arrays of primitives are also supported.
    A filter matches a key that has multiple values if it matches at least one of those values. For example,
     Dictionary d = new Hashtable();
     d.put("cn", new String[] {"a", "b", "c"});
     
    d will match (cn=a) and also (cn=b)

    A filter component that references a key having an unrecognizable data type will evaluate to false .

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  FrameworkUtil.FilterImpl.Parser
      Parser class for OSGi filter strings.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int AND  
      private static int APPROX  
      private java.lang.String attr
      filter attribute or null if operation AND, OR or NOT
      private static java.lang.Class[] constructorType  
      private static int EQUAL  
      private java.lang.String filterString  
      private static int GREATER  
      private static int LESS  
      private static int NOT  
      private int op
      filter operation
      private static int OR  
      private static int PRESENT  
      private static int SUBSTRING  
      private java.lang.Object value
      filter operands
    • Constructor Summary

      Constructors 
      Constructor Description
      FilterImpl​(int operation, java.lang.String attr, java.lang.Object value)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.lang.String approxString​(java.lang.String input)
      Map a string for an APPROX (~=) comparison.
      private boolean compare​(int operation, java.lang.Object value1, java.lang.Object value2)  
      private boolean compare_Boolean​(int operation, boolean boolval, java.lang.Object value2)  
      private boolean compare_Byte​(int operation, byte byteval, java.lang.Object value2)  
      private boolean compare_Character​(int operation, char charval, java.lang.Object value2)  
      private boolean compare_Collection​(int operation, java.util.Collection collection, java.lang.Object value2)  
      private boolean compare_Comparable​(int operation, java.lang.Comparable value1, java.lang.Object value2)  
      private boolean compare_Double​(int operation, double doubleval, java.lang.Object value2)  
      private boolean compare_Float​(int operation, float floatval, java.lang.Object value2)  
      private boolean compare_Integer​(int operation, int intval, java.lang.Object value2)  
      private boolean compare_Long​(int operation, long longval, java.lang.Object value2)  
      private boolean compare_ObjectArray​(int operation, java.lang.Object[] array, java.lang.Object value2)  
      private boolean compare_PrimitiveArray​(int operation, java.lang.Class type, java.lang.Object primarray, java.lang.Object value2)  
      private boolean compare_Short​(int operation, short shortval, java.lang.Object value2)  
      private boolean compare_String​(int operation, java.lang.String string, java.lang.Object value2)  
      private boolean compare_Unknown​(int operation, java.lang.Object value1, java.lang.Object value2)  
      private static java.lang.String encodeValue​(java.lang.String value)
      Encode the value string such that '(', '*', ')' and '\' are escaped.
      boolean equals​(java.lang.Object obj)
      Compares this Filter to another Filter.
      int hashCode()
      Returns the hashCode for this Filter.
      boolean match​(java.util.Dictionary dictionary)
      Filter using a Dictionary.
      boolean match​(ServiceReference reference)
      Filter using a service's properties.
      private boolean match0​(java.util.Dictionary properties)
      Internal match routine.
      boolean matchCase​(java.util.Dictionary dictionary)
      Filter with case sensitivity using a Dictionary.
      (package private) static FrameworkUtil.FilterImpl newInstance​(java.lang.String filterString)
      Constructs a FrameworkUtil.FilterImpl object.
      private java.lang.String normalize()
      Returns this Filter's normalized filter string.
      java.lang.String toString()
      Returns this Filter's filter string.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • FilterImpl

        FilterImpl​(int operation,
                   java.lang.String attr,
                   java.lang.Object value)
    • Method Detail

      • match

        public boolean match​(ServiceReference reference)
        Filter using a service's properties.

        This Filter is executed using the keys and values of the referenced service's properties. The keys are case insensitively matched with this Filter.

        Specified by:
        match in interface Filter
        Parameters:
        reference - The reference to the service whose properties are used in the match.
        Returns:
        true if the service's properties match this Filter; false otherwise.
      • match

        public boolean match​(java.util.Dictionary dictionary)
        Filter using a Dictionary. This Filter is executed using the specified Dictionary's keys and values. The keys are case insensitively matched with this Filter.
        Specified by:
        match in interface Filter
        Parameters:
        dictionary - The Dictionary whose keys are used in the match.
        Returns:
        true if the Dictionary's keys and values match this filter; false otherwise.
        Throws:
        java.lang.IllegalArgumentException - If dictionary contains case variants of the same key name.
      • matchCase

        public boolean matchCase​(java.util.Dictionary dictionary)
        Filter with case sensitivity using a Dictionary. This Filter is executed using the specified Dictionary's keys and values. The keys are case sensitively matched with this Filter.
        Specified by:
        matchCase in interface Filter
        Parameters:
        dictionary - The Dictionary whose keys are used in the match.
        Returns:
        true if the Dictionary's keys and values match this filter; false otherwise.
        Since:
        1.3
      • toString

        public java.lang.String toString()
        Returns this Filter's filter string.

        The filter string is normalized by removing whitespace which does not affect the meaning of the filter.

        Specified by:
        toString in interface Filter
        Overrides:
        toString in class java.lang.Object
        Returns:
        This Filter's filter string.
      • normalize

        private java.lang.String normalize()
        Returns this Filter's normalized filter string.

        The filter string is normalized by removing whitespace which does not affect the meaning of the filter.

        Returns:
        This Filter's filter string.
      • equals

        public boolean equals​(java.lang.Object obj)
        Compares this Filter to another Filter.

        This implementation returns the result of calling this.toString().equals(obj.toString().

        Specified by:
        equals in interface Filter
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - The object to compare against this Filter.
        Returns:
        If the other object is a Filter object, then returns the result of calling this.toString().equals(obj.toString(); false otherwise.
      • hashCode

        public int hashCode()
        Returns the hashCode for this Filter.

        This implementation returns the result of calling this.toString().hashCode().

        Specified by:
        hashCode in interface Filter
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hashCode of this Filter.
      • match0

        private boolean match0​(java.util.Dictionary properties)
        Internal match routine. Dictionary parameter must support case-insensitive get.
        Parameters:
        properties - A dictionary whose keys are used in the match.
        Returns:
        If the Dictionary's keys match the filter, return true. Otherwise, return false.
      • encodeValue

        private static java.lang.String encodeValue​(java.lang.String value)
        Encode the value string such that '(', '*', ')' and '\' are escaped.
        Parameters:
        value - unencoded value string.
        Returns:
        encoded value string.
      • compare

        private boolean compare​(int operation,
                                java.lang.Object value1,
                                java.lang.Object value2)
      • compare_Collection

        private boolean compare_Collection​(int operation,
                                           java.util.Collection collection,
                                           java.lang.Object value2)
      • compare_ObjectArray

        private boolean compare_ObjectArray​(int operation,
                                            java.lang.Object[] array,
                                            java.lang.Object value2)
      • compare_PrimitiveArray

        private boolean compare_PrimitiveArray​(int operation,
                                               java.lang.Class type,
                                               java.lang.Object primarray,
                                               java.lang.Object value2)
      • compare_String

        private boolean compare_String​(int operation,
                                       java.lang.String string,
                                       java.lang.Object value2)
      • compare_Integer

        private boolean compare_Integer​(int operation,
                                        int intval,
                                        java.lang.Object value2)
      • compare_Long

        private boolean compare_Long​(int operation,
                                     long longval,
                                     java.lang.Object value2)
      • compare_Byte

        private boolean compare_Byte​(int operation,
                                     byte byteval,
                                     java.lang.Object value2)
      • compare_Short

        private boolean compare_Short​(int operation,
                                      short shortval,
                                      java.lang.Object value2)
      • compare_Character

        private boolean compare_Character​(int operation,
                                          char charval,
                                          java.lang.Object value2)
      • compare_Boolean

        private boolean compare_Boolean​(int operation,
                                        boolean boolval,
                                        java.lang.Object value2)
      • compare_Float

        private boolean compare_Float​(int operation,
                                      float floatval,
                                      java.lang.Object value2)
      • compare_Double

        private boolean compare_Double​(int operation,
                                       double doubleval,
                                       java.lang.Object value2)
      • compare_Comparable

        private boolean compare_Comparable​(int operation,
                                           java.lang.Comparable value1,
                                           java.lang.Object value2)
      • compare_Unknown

        private boolean compare_Unknown​(int operation,
                                        java.lang.Object value1,
                                        java.lang.Object value2)
      • approxString

        private static java.lang.String approxString​(java.lang.String input)
        Map a string for an APPROX (~=) comparison. This implementation removes white spaces. This is the minimum implementation allowed by the OSGi spec.
        Parameters:
        input - Input string.
        Returns:
        String ready for APPROX comparison.