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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.client;
028    
029    
030    
031    import java.util.Collection;
032    import java.util.SortedSet;
033    import org.opends.server.admin.IllegalPropertyValueException;
034    import org.opends.server.admin.ManagedObjectDefinition;
035    import org.opends.server.admin.std.server.DseeCompatAccessControlHandlerCfg;
036    import org.opends.server.authorization.dseecompat.Aci;
037    
038    
039    
040    /**
041     * A client-side interface for reading and modifying Dsee Compat
042     * Access Control Handler settings.
043     * <p>
044     * The Dsee Compat Access Control Handler provides an implementation
045     * that uses syntax compatible with the Sun Java System Directory
046     * Server Enterprise Edition access control handlers.
047     */
048    public interface DseeCompatAccessControlHandlerCfgClient extends AccessControlHandlerCfgClient {
049    
050      /**
051       * Get the configuration definition associated with this Dsee Compat Access Control Handler.
052       *
053       * @return Returns the configuration definition associated with this Dsee Compat Access Control Handler.
054       */
055      ManagedObjectDefinition<? extends DseeCompatAccessControlHandlerCfgClient, ? extends DseeCompatAccessControlHandlerCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "global-aci" property.
061       * <p>
062       * Defines global access control rules.
063       * <p>
064       * Global access control rules apply to all entries anywhere in the
065       * data managed by the Directory Server. The global access control
066       * rules may be overridden by more specific access control rules
067       * placed in the data.
068       *
069       * @return Returns the values of the "global-aci" property.
070       */
071      SortedSet<Aci> getGlobalACI();
072    
073    
074    
075      /**
076       * Sets the "global-aci" property.
077       * <p>
078       * Defines global access control rules.
079       * <p>
080       * Global access control rules apply to all entries anywhere in the
081       * data managed by the Directory Server. The global access control
082       * rules may be overridden by more specific access control rules
083       * placed in the data.
084       *
085       * @param values The values of the "global-aci" property.
086       * @throws IllegalPropertyValueException
087       *           If one or more of the new values are invalid.
088       */
089      void setGlobalACI(Collection<Aci> values) throws IllegalPropertyValueException;
090    
091    
092    
093      /**
094       * Gets 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       * @return Returns the value of the "java-class" property.
100       */
101      String getJavaClass();
102    
103    
104    
105      /**
106       * Sets the "java-class" property.
107       * <p>
108       * Specifies the fully-qualified name of the Java class that
109       * provides the Dsee Compat Access Control Handler implementation.
110       *
111       * @param value The value of the "java-class" property.
112       * @throws IllegalPropertyValueException
113       *           If the new value is invalid.
114       */
115      void setJavaClass(String value) throws IllegalPropertyValueException;
116    
117    }