org.elasticsearch.xpack.core.security.authc.support.mapper.expressiondsl.RoleMapperExpression Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of x-pack-core Show documentation

Elasticsearch Expanded Pack Plugin - Core

There is a newer version: 8.13.2

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */
package org.elasticsearch.xpack.core.security.authc.support.mapper.expressiondsl;

import org.elasticsearch.common.io.stream.NamedWriteable;
import org.elasticsearch.common.xcontent.ToXContentObject;

import java.util.function.Predicate;

/**
 * Implementations of this interface represent an expression over a simple object that resolves to
 * a boolean value. The "simple object" is provided as a {@link ExpressionModel}.
 */
public interface RoleMapperExpression extends ToXContentObject, NamedWriteable {

    /**
     * Determines whether this expression matches against the provided object.
     * @param model the {@link ExpressionModel}
     */
    boolean match(ExpressionModel model);

    /**
     * Adapt this expression to a standard {@link Predicate}
     */
    default Predicate asPredicate() {
        return this::match;
    }

    /**
     * Creates an inverted predicate that can test whether an expression matches
     * a fixed object. Its purpose is for cases where there is a {@link java.util.stream.Stream} of
     * expressions, that need to be filtered against a single map.
     */
    static Predicate predicate(ExpressionModel map) {
        return expr -> expr.match(map);
    }

}