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 */
026package org.opends.server.admin.std.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.server.DseeCompatAccessControlHandlerCfg;
035import org.opends.server.authorization.dseecompat.Aci;
036
037
038
039/**
040 * A client-side interface for reading and modifying Dsee Compat
041 * Access Control Handler settings.
042 * <p>
043 * The Dsee Compat Access Control Handler provides an implementation
044 * that uses syntax compatible with the Sun Java System Directory
045 * Server Enterprise Edition access control handlers.
046 */
047public interface DseeCompatAccessControlHandlerCfgClient extends AccessControlHandlerCfgClient {
048
049  /**
050   * Get the configuration definition associated with this Dsee Compat Access Control Handler.
051   *
052   * @return Returns the configuration definition associated with this Dsee Compat Access Control Handler.
053   */
054  ManagedObjectDefinition<? extends DseeCompatAccessControlHandlerCfgClient, ? extends DseeCompatAccessControlHandlerCfg> definition();
055
056
057
058  /**
059   * Gets the "global-aci" property.
060   * <p>
061   * Defines global access control rules.
062   * <p>
063   * Global access control rules apply to all entries anywhere in the
064   * data managed by the OpenDJ directory server. The global access
065   * control rules may be overridden by more specific access control
066   * rules placed in the data.
067   *
068   * @return Returns the values of the "global-aci" property.
069   */
070  SortedSet<Aci> getGlobalACI();
071
072
073
074  /**
075   * Sets the "global-aci" property.
076   * <p>
077   * Defines global access control rules.
078   * <p>
079   * Global access control rules apply to all entries anywhere in the
080   * data managed by the OpenDJ directory server. The global access
081   * control rules may be overridden by more specific access control
082   * rules placed in the data.
083   *
084   * @param values The values of the "global-aci" property.
085   * @throws PropertyException
086   *           If one or more of the new values are invalid.
087   */
088  void setGlobalACI(Collection<Aci> values) throws PropertyException;
089
090
091
092  /**
093   * Gets the "java-class" property.
094   * <p>
095   * Specifies the fully-qualified name of the Java class that
096   * provides the Dsee Compat Access Control Handler implementation.
097   *
098   * @return Returns the value of the "java-class" property.
099   */
100  String getJavaClass();
101
102
103
104  /**
105   * Sets the "java-class" property.
106   * <p>
107   * Specifies the fully-qualified name of the Java class that
108   * provides the Dsee Compat Access Control Handler implementation.
109   *
110   * @param value The value of the "java-class" property.
111   * @throws PropertyException
112   *           If the new value is invalid.
113   */
114  void setJavaClass(String value) throws PropertyException;
115
116}