org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener クラス

org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener の継承関係図

org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener 連携図

公開メンバ関数
	LdapFilterListener (Class<? extends BaseScimResource > resourceClass)
void	enterAndFilter (ScimFilterParser.AndFilterContext ctx)
void	enterAttrexp (ScimFilterParser.AttrexpContext ctx)
void	enterNegatedFilter (ScimFilterParser.NegatedFilterContext ctx)
void	enterOrFilter (ScimFilterParser.OrFilterContext ctx)
void	exitAndFilter (ScimFilterParser.AndFilterContext ctx)
void	exitNegatedFilter (ScimFilterParser.NegatedFilterContext ctx)
void	exitOrFilter (ScimFilterParser.OrFilterContext ctx)
String	getError ()
Filter	getFilter ()
void	enterAttrpath (ScimFilterParser.AttrpathContext ctx)
void	exitAttrpath (ScimFilterParser.AttrpathContext ctx)
void	enterCompareop (ScimFilterParser.CompareopContext ctx)
void	exitCompareop (ScimFilterParser.CompareopContext ctx)
void	enterCompvalue (ScimFilterParser.CompvalueContext ctx)
void	exitCompvalue (ScimFilterParser.CompvalueContext ctx)
void	exitAttrexp (ScimFilterParser.AttrexpContext ctx)
void	enterSimpleExpr (ScimFilterParser.SimpleExprContext ctx)
void	exitSimpleExpr (ScimFilterParser.SimpleExprContext ctx)
void	enterEveryRule (ParserRuleContext ctx)
void	exitEveryRule (ParserRuleContext ctx)
void	visitTerminal (TerminalNode node)
void	visitErrorNode (ErrorNode node)

非公開メンバ関数
void	close ()
String	escapeLdapString (String string)
String	getSubFilter (String subAttribute, String ldapAttribute, String compValue, Type attrType, CompValueType type, ScimOperator operator)
String	getSubFilterBoolean (String subAttribute, String ldapAttribute, String value, ScimOperator operator, Type attrType)
String	getSubFilterDateTime (String subAttribute, String ldapAttribute, String value, ScimOperator operator, Type attrType)
String	getSubFilterNumeric (String subAttribute, String ldapAttribute, String value, ScimOperator operator, Type attrType)
String	getSubFilterString (String subAttribute, String ldapAttribute, String value, ScimOperator operator)
void	open ()

非公開変数類
Logger	log = LogManager.getLogger(getClass())
StringBuilder	filter
Class<? extends BaseScimResource >	resourceClass
String	error
ExtensionService	extService

詳解

Created by jgomer on 2017-12-09.

構築子と解体子

LdapFilterListener()

org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.LdapFilterListener ( Class<? extends BaseScimResource >  resourceClass )

inline

                                                                              {
        filter=new StringBuilder();
        extService=CdiUtil.bean(ExtensionService.class);
        this.resourceClass=resourceClass;
    }

関数詳解

close()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.close ( )

inlineprivate

                        {
        filter.append(")");
    }

enterAndFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.enterAndFilter ( ScimFilterParser.AndFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                      {
        open();
        filter.append("&");
    }

enterAttrexp()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.enterAttrexp ( ScimFilterParser.AttrexpContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                  {

        if (StringUtils.isEmpty(error)) {
            log.trace("enterAttrexp.");

            String path = ctx.attrpath().getText();
            ScimFilterParser.CompvalueContext compValueCtx = ctx.compvalue();
            boolean isPrRule = compValueCtx == null && ctx.getChild(1).getText().equals("pr");

            Type attrType=null;
            Attribute attrAnnot = IntrospectUtil.getFieldAnnotation(path, resourceClass, Attribute.class);
            String ldapAttribute = null;
            boolean isNested = false;

            if (attrAnnot==null) {
                ExtensionField field=extService.getFieldOfExtendedAttribute(resourceClass, path);

                if (field==null)
                    error=String.format("Attribute path '%s' is not recognized in %s", path, resourceClass.getSimpleName());
                else {
                    attrType = field.getAttributeDefinitionType();
                    ldapAttribute = path.substring(path.lastIndexOf(":")+1);
                }
            }
            else {
                attrType = attrAnnot.type();
                Pair<String, Boolean> pair=FilterUtil.getLdapAttributeOfResourceAttribute(path, resourceClass);
                ldapAttribute=pair.getFirst();
                isNested=pair.getSecond();
            }

            if (error!=null)
                ;   //Intentionally left empty
            else
            if (attrType==null)
                error=String.format("Could not determine type of attribute path '%s' in %s", path, resourceClass.getSimpleName());
            else
            if (ldapAttribute==null)
                error=String.format("Could not determine LDAP attribute for path '%s' in %s", path, resourceClass.getSimpleName());
            else{
                String subattr=isNested ? path.substring(path.lastIndexOf(".")+1) : null;
                String subFilth;
                CompValueType type;
                ScimOperator operator;

                if (isPrRule) {
                    type=CompValueType.NULL;
                    operator=ScimOperator.NOT_EQUAL;
                }
                else {
                    type=FilterUtil.getCompValueType(compValueCtx);
                    operator=ScimOperator.getByValue(ctx.compareop().getText());
                }

                error=FilterUtil.checkFilterConsistency(path, attrType, type, operator);
                if (error==null) {
                    subFilth = getSubFilter(subattr, ldapAttribute, isPrRule ? null : compValueCtx.getText(), attrType, type, operator);

                    if (subFilth == null){
                        if (error==null)
                            error = String.format("Operator '%s' is not supported for attribute %s", operator.getValue(), path);
                    }
                    else
                        filter.append(subFilth);
                }
            }
        }
    }

enterAttrpath()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.enterAttrpath ( ScimFilterParser.AttrpathContext  ctx )

inlineinherited

Enter a parse tree produced by ScimFilterParser#attrpath.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

enterCompareop()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.enterCompareop ( ScimFilterParser.CompareopContext  ctx )

inlineinherited

Enter a parse tree produced by ScimFilterParser#compareop.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

enterCompvalue()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.enterCompvalue ( ScimFilterParser.CompvalueContext  ctx )

inlineinherited

Enter a parse tree produced by ScimFilterParser#compvalue.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

enterEveryRule()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.enterEveryRule ( ParserRuleContext  ctx )

inlineinherited

The default implementation does nothing.

{ }

enterNegatedFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.enterNegatedFilter ( ScimFilterParser.NegatedFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                              {
        if (ctx.getText().startsWith("not(")) {
            open();
            filter.append("!");
        }
    }

enterOrFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.enterOrFilter ( ScimFilterParser.OrFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                    {
        open();
        filter.append("|");
    }

enterSimpleExpr()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.enterSimpleExpr ( ScimFilterParser.SimpleExprContext  ctx )

inlineinherited

Enter a parse tree produced by the

simpleExpr 

labeled alternative in ScimFilterParser#filter.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

escapeLdapString()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.escapeLdapString ( String  string )

inlineprivate

                                                  {
        //See section 4 of RFC 2254
        return string.replace("\\", "\\5c").replace("*", "\\2a")
                .replace("(", "\\28").replace(")", "\\29")
                .replace("\0", "\\00");
    }

exitAndFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.exitAndFilter ( ScimFilterParser.AndFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                     {
        close();
    }

exitAttrexp()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitAttrexp ( ScimFilterParser.AttrexpContext  ctx )

inlineinherited

Exit a parse tree produced by ScimFilterParser#attrexp.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

exitAttrpath()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitAttrpath ( ScimFilterParser.AttrpathContext  ctx )

inlineinherited

Exit a parse tree produced by ScimFilterParser#attrpath.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

exitCompareop()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitCompareop ( ScimFilterParser.CompareopContext  ctx )

inlineinherited

Exit a parse tree produced by ScimFilterParser#compareop.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

exitCompvalue()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitCompvalue ( ScimFilterParser.CompvalueContext  ctx )

inlineinherited

Exit a parse tree produced by ScimFilterParser#compvalue.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

exitEveryRule()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitEveryRule ( ParserRuleContext  ctx )

inlineinherited

The default implementation does nothing.

{ }

exitNegatedFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.exitNegatedFilter ( ScimFilterParser.NegatedFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                             {
        if (ctx.getText().startsWith("not("))
            close();
    }

exitOrFilter()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.exitOrFilter ( ScimFilterParser.OrFilterContext  ctx )

inline

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

                                                                   {
        close();
    }

exitSimpleExpr()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.exitSimpleExpr ( ScimFilterParser.SimpleExprContext  ctx )

inlineinherited

Exit a parse tree produced by the

simpleExpr 

labeled alternative in ScimFilterParser#filter.

引数

ctx	the parse tree

The default implementation does nothing.

org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterListenerを実装しています。

{ }

getError()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getError ( )

inline

                             {
        return error;
    }

getFilter()

Filter org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getFilter ( )

inline

                              {
        if (StringUtils.isEmpty(error)) {
            if (filter.charAt(0)!='(' || filter.charAt(filter.length()-1)!=')')
                filter.insert(0, "(").append(")");

            log.info("LDAP filter expression computed was {}", filter.toString());
            return Filter.create(filter.toString());
        }
        else
            return null;
    }

getSubFilter()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getSubFilter ( String  subAttribute, String  ldapAttribute, String  compValue, Type  attrType, CompValueType  type, ScimOperator  operator  )

inlineprivate

                                                                                                                                                      {

        String filth=null;

        if (type.equals(CompValueType.NULL)){
            if (subAttribute==null) {
                filth = NULL_NOT_EQUALS.get(ldapAttribute);
                if (operator.equals(ScimOperator.EQUAL))
                    filth= "(!" + filth + ")";
            }
            else {
                filth = NULL_EQUALS_INNER.get(ldapAttribute, subAttribute);
                if (operator.equals(ScimOperator.NOT_EQUAL))
                    filth= "(!" + filth + ")";
            }
        }
        else
        if (Type.STRING.equals(attrType) || Type.REFERENCE.equals(attrType)){
            compValue=escapeLdapString(compValue.substring(1, compValue.length()-1));     //Drop double quotes and encode
            filth=getSubFilterString(subAttribute, ldapAttribute, compValue, operator);
        }
        else
        if (Type.INTEGER.equals(attrType) || Type.DECIMAL.equals(attrType))
            filth=getSubFilterNumeric(subAttribute, ldapAttribute, compValue, operator, attrType);
        else
        if (Type.BOOLEAN.equals(attrType))
            filth=getSubFilterBoolean(subAttribute, ldapAttribute, compValue, operator, attrType);
        else
        if (Type.DATETIME.equals(attrType)){
            compValue=escapeLdapString(compValue.substring(1, compValue.length()-1));
            filth=getSubFilterDateTime(subAttribute, ldapAttribute, compValue, operator, attrType);
        }

        log.trace("getSubFilter. {}", filth);
        return filth;

    }

getSubFilterBoolean()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getSubFilterBoolean ( String  subAttribute, String  ldapAttribute, String  value, ScimOperator  operator, Type  attrType  )

inlineprivate

                                                                                                                                      {

        String subfilter=null;
        log.trace("getSubFilterBoolean");

        if (operator.equals(ScimOperator.EQUAL) || operator.equals(ScimOperator.NOT_EQUAL)) {
            if (subAttribute==null)
                //should be TRUE or FALSE (uppercase) to work: boolean syntax 1.3.6.1.4.1.1466.115.121.1.7 with booleanMatch equality
                subfilter=BOOLEAN_EQUALS.get(ldapAttribute, value.toUpperCase());
            else
                //When it's inside json, the underlying attribute is not a boolean LDAP but a string so no conversion is needed
                subfilter=BOOLEAN_EQUALS_INNER.get(ldapAttribute, subAttribute, value);

            if (operator.equals(ScimOperator.NOT_EQUAL))
                subfilter= "(!" + subfilter + ")";
        }
        else
            error=FilterUtil.getOperatorInconsistencyError(operator.getValue(), attrType.toString(), subAttribute);

        return subfilter;

    }

getSubFilterDateTime()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getSubFilterDateTime ( String  subAttribute, String  ldapAttribute, String  value, ScimOperator  operator, Type  attrType  )

inlineprivate

                                                                                                                                       {

        log.trace("getSubFilterDateTime");
        String generalizedStringDate= DateUtil.ISOToGeneralizedStringDate(value);
        if (generalizedStringDate==null) {
            error=String.format("Value passed for date comparison \"%s\" is not in ISO format", value);
            return null;
        }
        else
            //happily the same rules and templates apply
            return getSubFilterNumeric(subAttribute, ldapAttribute, generalizedStringDate, operator, attrType);

    }

getSubFilterNumeric()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getSubFilterNumeric ( String  subAttribute, String  ldapAttribute, String  value, ScimOperator  operator, Type  attrType  )

inlineprivate

                                                                                                                                      {

        String subfilter=null;
        StringBuilder subfilter2=new StringBuilder();
        log.trace("getSubFilterNumeric");

        switch (operator){
            case EQUAL:
            case NOT_EQUAL:
                if (subAttribute==null)
                    subfilter=NUMERIC_EQUALS.get(ldapAttribute, value);
                else
                    subfilter=NUMERIC_EQUALS_INNER.get(ldapAttribute, subAttribute, value);

                if (operator.equals(ScimOperator.NOT_EQUAL))
                    subfilter= "(!" + subfilter + ")";
                break;
            case GREATER_THAN:
                if (subAttribute==null) {
                    subfilter2.append("(&")
                            .append("(!").append(NUMERIC_EQUALS.get(ldapAttribute, value)).append(")")
                            .append(NUMERIC_GREATER_THAN_OR_EQ.get(ldapAttribute, value))
                            .append(")");
                    subfilter = subfilter2.toString();
                }
                break;
            case GREATER_THAN_OR_EQUAL:
                if (subAttribute==null)
                    subfilter=NUMERIC_GREATER_THAN_OR_EQ.get(ldapAttribute, value);
                break;
            case LESS_THAN:
                if (subAttribute==null) {
                    subfilter2.append("(&")
                            .append("(!").append(NUMERIC_EQUALS.get(ldapAttribute, value)).append(")")
                            .append(NUMERIC_LESS_THAN_OR_EQ.get(ldapAttribute, value))
                            .append(")");
                    subfilter = subfilter2.toString();
                }
                break;
            case LESS_THAN_OR_EQUAL:
                if (subAttribute==null)
                    subfilter=NUMERIC_LESS_THAN_OR_EQ.get(ldapAttribute, value);
                break;
            default:
                error= FilterUtil.getOperatorInconsistencyError(operator.getValue(), attrType.toString(), subAttribute);
        }
        return subfilter;

    }

getSubFilterString()

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.getSubFilterString ( String  subAttribute, String  ldapAttribute, String  value, ScimOperator  operator  )

inlineprivate

                                                                                                                      {

        String subfilter=null;
        StringBuilder subfilter2=new StringBuilder();
        log.trace("getSubFilterString");

        switch (operator){
            case EQUAL:
            case NOT_EQUAL:
                if (subAttribute==null)
                    subfilter=STRING_EQUALS.get(ldapAttribute, value);
                else
                    subfilter=STRING_EQUALS_INNER.get(ldapAttribute, subAttribute, value);

                if (operator.equals(ScimOperator.NOT_EQUAL))
                    subfilter= "(!" + subfilter + ")";
                break;
            case CONTAINS:
                if (subAttribute==null)
                    subfilter=STRING_CONTAINS.get(ldapAttribute, value);
                else
                    subfilter=STRING_CONTAINS_INNER.get(ldapAttribute, subAttribute, value);
                break;
            case STARTS_WITH:
                if (subAttribute==null)
                    subfilter=STRING_STARTSWITH.get(ldapAttribute, value);
                else
                    subfilter=STRING_STARTSWITH_INNER.get(ldapAttribute, subAttribute, value);
                break;
            case ENDS_WITH:
                if (subAttribute==null)
                    subfilter=STRING_ENDSWITH.get(ldapAttribute, value);
                else
                    subfilter=STRING_ENDSWITH_INNER.get(ldapAttribute, subAttribute, value);
                break;
            case GREATER_THAN:  //LDAP does not support greater than operator
                if (subAttribute==null) {
                    subfilter2.append("(&")
                            .append("(!").append(STRING_EQUALS.get(ldapAttribute, value)). append(")")
                            .append(STRING_GREATER_THAN_OR_EQ.get(ldapAttribute, value))
                            .append(")");
                    subfilter=subfilter2.toString();
                }
                break;
            case GREATER_THAN_OR_EQUAL:
                if (subAttribute==null)
                    subfilter=STRING_GREATER_THAN_OR_EQ.get(ldapAttribute, value);
                break;
            case LESS_THAN:  //LDAP does not support less than operator
                if (subAttribute==null) {
                    subfilter2.append("(&")
                            .append("(!").append(STRING_EQUALS.get(ldapAttribute, value)). append(")")
                            .append(STRING_LESS_THAN_OR_EQ.get(ldapAttribute, value))
                            .append(")");
                    subfilter = subfilter2.toString();
                }
                break;
            case LESS_THAN_OR_EQUAL:
                if (subAttribute==null)
                    subfilter=STRING_LESS_THAN_OR_EQ.get(ldapAttribute, value);
                break;
        }
        return subfilter;

    }

open()

void org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.open ( )

inlineprivate

                       {
        filter.append("(");
    }

visitErrorNode()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.visitErrorNode ( ErrorNode  node )

inlineinherited

The default implementation does nothing.

{ }

visitTerminal()

void org.gluu.oxtrust.service.antlr.scimFilter.antlr4.ScimFilterBaseListener.visitTerminal ( TerminalNode  node )

inlineinherited

The default implementation does nothing.

{ }

メンバ詳解

error

String org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.error

private

extService

ExtensionService org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.extService

private

filter

StringBuilder org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.filter

private

log

Logger org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.log = LogManager.getLogger(getClass())

private

resourceClass

Class<? extends BaseScimResource> org.gluu.oxtrust.service.antlr.scimFilter.LdapFilterListener.resourceClass

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/service/antlr/scimFilter/LdapFilterListener.java