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