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