001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2013-2015 ForgeRock AS.
016 */
017package org.opends.server.authorization.dseecompat;
018
019/**
020 * This interface represents a keyword  bind rule class
021 * that can evaluate an evaluation context. It defines a single
022 * function that each of the keyword functions implement (ip, dns,
023 * roledn, groupdn, ...)
024 */
025public interface KeywordBindRule
026{
027    /**
028     * Evaluate a bind rule using the passed in context.
029     * @param evalCtx An evaluation context to use in the evaluation.
030     * @return An enumeration evaluation result.
031     */
032    EnumEvalResult evaluate(AciEvalContext evalCtx);
033
034    /**
035     * Appends a string representation of this object to the provided buffer.
036     *
037     * @param buffer
038     *          The buffer into which a string representation of this object
039     *          should be appended.
040     */
041    void toString(StringBuilder buffer);
042}