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.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Dsee Compat Access Control 027 * Handler settings. 028 * <p> 029 * The Dsee Compat Access Control Handler provides an implementation 030 * that uses syntax compatible with the Sun Java System Directory 031 * Server Enterprise Edition access control handlers. 032 */ 033public interface DseeCompatAccessControlHandlerCfg extends AccessControlHandlerCfg { 034 035 /** 036 * Gets the configuration class associated with this Dsee Compat Access Control Handler. 037 * 038 * @return Returns the configuration class associated with this Dsee Compat Access Control Handler. 039 */ 040 Class<? extends DseeCompatAccessControlHandlerCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this Dsee Compat Access Control Handler is changed. 046 * 047 * @param listener 048 * The Dsee Compat Access Control Handler configuration change listener. 049 */ 050 void addDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener); 051 052 053 054 /** 055 * Deregister an existing Dsee Compat Access Control Handler configuration change listener. 056 * 057 * @param listener 058 * The Dsee Compat Access Control Handler configuration change listener. 059 */ 060 void removeDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener); 061 062 063 064 /** 065 * Gets 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 * @return Returns an unmodifiable set containing the values of the "global-aci" property. 075 */ 076 SortedSet<String> getGlobalACI(); 077 078 079 080 /** 081 * Gets the "java-class" property. 082 * <p> 083 * Specifies the fully-qualified name of the Java class that 084 * provides the Dsee Compat Access Control Handler implementation. 085 * 086 * @return Returns the value of the "java-class" property. 087 */ 088 String getJavaClass(); 089 090}