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