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 org.opends.server.admin.ConfigurationClient;
032    import org.opends.server.admin.IllegalPropertyValueException;
033    import org.opends.server.admin.ManagedObjectDefinition;
034    import org.opends.server.admin.std.server.AccessControlHandlerCfg;
035    
036    
037    
038    /**
039     * A client-side interface for reading and modifying Access Control
040     * Handler settings.
041     * <p>
042     * Access Control Handlers manage the application-wide access control.
043     * The OpenDS access control handler is defined through an extensible
044     * interface, so that alternate implementations can be created. Only
045     * one access control handler may be active in the server at any given
046     * time.
047     */
048    public interface AccessControlHandlerCfgClient extends ConfigurationClient {
049    
050      /**
051       * Get the configuration definition associated with this Access Control Handler.
052       *
053       * @return Returns the configuration definition associated with this Access Control Handler.
054       */
055      ManagedObjectDefinition<? extends AccessControlHandlerCfgClient, ? extends AccessControlHandlerCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "enabled" property.
061       * <p>
062       * Indicates whether the Access Control Handler is enabled. If set
063       * to FALSE, then no access control is enforced, and any client
064       * (including unauthenticated or anonymous clients) could be allowed
065       * to perform any operation if not subject to other restrictions,
066       * such as those enforced by the privilege subsystem.
067       *
068       * @return Returns the value of the "enabled" property.
069       */
070      Boolean isEnabled();
071    
072    
073    
074      /**
075       * Sets the "enabled" property.
076       * <p>
077       * Indicates whether the Access Control Handler is enabled. If set
078       * to FALSE, then no access control is enforced, and any client
079       * (including unauthenticated or anonymous clients) could be allowed
080       * to perform any operation if not subject to other restrictions,
081       * such as those enforced by the privilege subsystem.
082       *
083       * @param value The value of the "enabled" property.
084       * @throws IllegalPropertyValueException
085       *           If the new value is invalid.
086       */
087      void setEnabled(boolean value) throws IllegalPropertyValueException;
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 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 Access Control Handler implementation.
108       *
109       * @param value The value of the "java-class" property.
110       * @throws IllegalPropertyValueException
111       *           If the new value is invalid.
112       */
113      void setJavaClass(String value) throws IllegalPropertyValueException;
114    
115    }