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