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.server; 028 029 030 031 import org.opends.server.admin.Configuration; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 034 035 036 /** 037 * A server-side interface for querying Access Control Handler 038 * settings. 039 * <p> 040 * Access Control Handlers manage the application-wide access control. 041 * The OpenDS access control handler is defined through an extensible 042 * interface, so that alternate implementations can be created. Only 043 * one access control handler may be active in the server at any given 044 * time. 045 */ 046 public interface AccessControlHandlerCfg extends Configuration { 047 048 /** 049 * Gets the configuration class associated with this Access Control Handler. 050 * 051 * @return Returns the configuration class associated with this Access Control Handler. 052 */ 053 Class<? extends AccessControlHandlerCfg> configurationClass(); 054 055 056 057 /** 058 * Register to be notified when this Access Control Handler is changed. 059 * 060 * @param listener 061 * The Access Control Handler configuration change listener. 062 */ 063 void addChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener); 064 065 066 067 /** 068 * Deregister an existing Access Control Handler configuration change listener. 069 * 070 * @param listener 071 * The Access Control Handler configuration change listener. 072 */ 073 void removeChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener); 074 075 076 077 /** 078 * Gets the "enabled" property. 079 * <p> 080 * Indicates whether the Access Control Handler is enabled. If set 081 * to FALSE, then no access control is enforced, and any client 082 * (including unauthenticated or anonymous clients) could be allowed 083 * to perform any operation if not subject to other restrictions, 084 * such as those enforced by the privilege subsystem. 085 * 086 * @return Returns the value of the "enabled" property. 087 */ 088 boolean isEnabled(); 089 090 091 092 /** 093 * Gets the "java-class" property. 094 * <p> 095 * Specifies the fully-qualified name of the Java class that 096 * provides the Access Control Handler implementation. 097 * 098 * @return Returns the value of the "java-class" property. 099 */ 100 String getJavaClass(); 101 102 }