org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil クラス

org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil 連携図

静的公開メンバ関数
static CompValueType	getCompValueType (ScimFilterParser.CompvalueContext compValueCtx)
static String	checkFilterConsistency (String attribute, Type attrType, CompValueType type, ScimOperator operator)
static void	logOperatorInconsistency (String operator, String type, String attrname)
static String	getOperatorInconsistencyError (String operator, String type, String attrname)
static String	preprocess (String filther, Class<? extends BaseScimResource > clazz) throws Exception
static Pair< String, Boolean >	getLdapAttributeOfResourceAttribute (String path, Class<? extends BaseScimResource > resourceClass)

静的非公開メンバ関数
static String	checkTypeConsistency (String attribute, Type attrType, CompValueType type)
static String	getTypeInconsistencyError (String attrname, String type1, String type2)
static int	startIndexParentAttr (String str)
static String	applyPrefix (String parent, String innerExpr, Class<? extends BaseScimResource > clazz)
static String	removeBrackets (String filther, Class<? extends BaseScimResource > clazz) throws Exception

静的非公開変数類
static Logger	log = LogManager.getLogger(FilterUtil.class)

詳解

著者

Val Pecaoco Updated by jgomer on 2017-12-12.

関数詳解

applyPrefix()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.applyPrefix ( String  parent, String  innerExpr, Class<? extends BaseScimResource >  clazz  )

inlinestaticprivate

                                                                                                               {

        SortedSet<String> validPaths= IntrospectUtil.allAttrs.get(clazz);
        //Find all those starting with parent
        for (String path : validPaths.tailSet(parent)){
            if (path.startsWith(parent)){
                String subAttr=path.substring(parent.length());
                if (subAttr.startsWith(".")){
                    subAttr=subAttr.substring(1);
                    //add parent prefix to all occurrences of subAttr in the expression
                    innerExpr=innerExpr.replaceAll(subAttr, parent + "." + subAttr);
                }
            }
            else
                break;
        }
        return innerExpr;
    }

checkFilterConsistency()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.checkFilterConsistency ( String  attribute, Type  attrType, CompValueType  type, ScimOperator  operator  )

inlinestatic

                                                                                                                           {

        String error=null;

        if (type.equals(CompValueType.NULL)) {
            if (!operator.equals(ScimOperator.EQUAL) && !operator.equals(ScimOperator.NOT_EQUAL)) {
                //Only makes sense if operator is eq or neq
                error=String.format("Cannot use null in a filter with operator '%s'", operator.getValue());
                log.error("checkFilterConsistency. {}", error);
            }
        }
        else
            error = checkTypeConsistency(attribute, attrType, type);

        return error;

    }

checkTypeConsistency()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.checkTypeConsistency ( String  attribute, Type  attrType, CompValueType  type  )

inlinestaticprivate

                                                                                                   {

        boolean pass;
        String error=null;

        if (Type.STRING.equals(attrType) || Type.REFERENCE.equals(attrType) || Type.DATETIME.equals(attrType))
            pass=type.equals(CompValueType.STRING);   //Here STRING refers to ScimFilter.g4 rules
        else
        if (Type.INTEGER.equals(attrType) || Type.DECIMAL.equals(attrType))
            pass=type.equals(CompValueType.NUMBER);   //Here NUMBER refers to ScimFilter.g4 rule
        else
        if (Type.BOOLEAN.equals(attrType))
            pass=type.equals(CompValueType.BOOLEAN);   //Here BOOLEAN refers to ScimFilter.g4 rule
        else {
            error=String.format("Filtering over attributes of type '%s' is not supported", attrType);
            log.error("checkTypeConsistency. {}", error);
            return error;
        }

        if (!pass) {
            error=getTypeInconsistencyError(attribute, attrType.toString(), type.toString());
            log.error("checkTypeConsistency. {}", error);
        }

        return error;

    }

getCompValueType()

static CompValueType org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.getCompValueType ( ScimFilterParser.CompvalueContext  compValueCtx )

inlinestatic

                                                                                                {

        CompValueType valueType=null;

        if (compValueCtx.BOOLEAN()!=null)
            valueType=CompValueType.BOOLEAN;
        else
        if (compValueCtx.NUMBER()!=null)
            valueType=CompValueType.NUMBER;
        else
        if (compValueCtx.NULL()!=null)
            valueType=CompValueType.NULL;
        else
        if (compValueCtx.STRING()!=null)
            valueType = CompValueType.STRING;

        return valueType;

    }

getLdapAttributeOfResourceAttribute()

static Pair<String, Boolean> org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.getLdapAttributeOfResourceAttribute ( String  path, Class<? extends BaseScimResource >  resourceClass  )

inlinestatic

                                                                                                                                         {

        log.trace("getLdapAttributeOfResourceAttribute. path={}", path);
        boolean inner=false;
        Map<String, String> refs=IntrospectUtil.storeRefs.get(resourceClass);
        String ldapAttribute=null;

        while (ldapAttribute==null && path.length()>0){
            ldapAttribute=refs.get(path);

            if (ldapAttribute==null) {
                int i = path.indexOf(".");
                inner = i >= 0;
                i = (i == -1) ? 0 : i;
                path = path.substring(0, i);
            }
        }
        return new Pair<String, Boolean>(ldapAttribute, inner);

    }

getOperatorInconsistencyError()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.getOperatorInconsistencyError ( String  operator, String  type, String  attrname  )

inlinestatic

                                                                                                     {
        return String.format("Operator '%s' is not consistent with type '%s' of attribute %s", operator, type, attrname);
    }

getTypeInconsistencyError()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.getTypeInconsistencyError ( String  attrname, String  type1, String  type2  )

inlinestaticprivate

                                                                                                {
        return String.format("Attribute %s is of type '%s' but compare value supplied is of type '%s'", attrname, type1, type2);
    }

logOperatorInconsistency()

static void org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.logOperatorInconsistency ( String  operator, String  type, String  attrname  )

inlinestatic

                                                                                              {
        log.error(getOperatorInconsistencyError(operator, type, attrname));
    }

preprocess()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.preprocess ( String  filther, Class<? extends BaseScimResource >  clazz  ) throws Exception

inlinestatic

引数

filther

Non-empty string

戻り値

                                                                                                             {

        filther = filther.replaceAll(ScimResourceUtil.getDefaultSchemaUrn(clazz) + ":", "");
        filther = removeBrackets(filther, clazz);
        log.debug("Filter transformed to: {}", filther);

        return filther;

    }

removeBrackets()

static String org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.removeBrackets ( String  filther, Class<? extends BaseScimResource >  clazz  ) throws Exception

inlinestaticprivate

Transalte a filter string such as emails[type eq "work" and value co "@example.com"] or ims[type eq "xmpp" and value co "@foo.com"] into (emails.type eq "work" and emails.value co "@example.com") or (ims.type eq "xmpp" and ims.value co "@foo.com")

引数

filther
clazz

戻り値

例外

Exception

                                                                                                                   {

        //Remove brackets: [] and adjust by prefixing accordingly
        int j, offset =0;
        int i= filther.indexOf("[");
        StringBuilder sb=new StringBuilder();

        while (i!=-1) {
            //find closing bracket:
            j= filther.indexOf("]", i);
            if (j==-1)
                throw new Exception("Invalid filter: closing bracket ']' expected");

            String str= filther.substring(i+1, j);
            int k=startIndexParentAttr(filther.substring(offset, i)) + offset;
            if (k==i)
                throw new Exception("Invalid filter: no parent attrPath found before opening braket '['");

            sb.append(filther.substring(offset, k)).append("(");
            sb.append(applyPrefix(filther.substring(k,i), str, clazz));
            sb.append(")");

            offset=j+1;
            i= filther.indexOf("[", offset);
        }
        //"Paste" the remaining unprocessed part
        sb.append(filther.substring(offset));
        return sb.toString();

    }

startIndexParentAttr()

static int org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.startIndexParentAttr ( String  str )

inlinestaticprivate

                                                       {

        int i;
        for (i=str.length(); i>0 && Pattern.matches("\\w", str.substring(i-1, i)); i--);
        return i;
    }

メンバ詳解

log

Logger org.gluu.oxtrust.service.antlr.scimFilter.util.FilterUtil.log = LogManager.getLogger(FilterUtil.class)

staticprivate

---

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

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