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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import java.util.SortedSet; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032import org.opends.server.authorization.dseecompat.Aci; 033 034 035 036/** 037 * A server-side interface for querying Dsee Compat Access Control 038 * Handler settings. 039 * <p> 040 * The Dsee Compat Access Control Handler provides an implementation 041 * that uses syntax compatible with the Sun Java System Directory 042 * Server Enterprise Edition access control handlers. 043 */ 044public interface DseeCompatAccessControlHandlerCfg extends AccessControlHandlerCfg { 045 046 /** 047 * Gets the configuration class associated with this Dsee Compat Access Control Handler. 048 * 049 * @return Returns the configuration class associated with this Dsee Compat Access Control Handler. 050 */ 051 Class<? extends DseeCompatAccessControlHandlerCfg> configurationClass(); 052 053 054 055 /** 056 * Register to be notified when this Dsee Compat Access Control Handler is changed. 057 * 058 * @param listener 059 * The Dsee Compat Access Control Handler configuration change listener. 060 */ 061 void addDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener); 062 063 064 065 /** 066 * Deregister an existing Dsee Compat Access Control Handler configuration change listener. 067 * 068 * @param listener 069 * The Dsee Compat Access Control Handler configuration change listener. 070 */ 071 void removeDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener); 072 073 074 075 /** 076 * Gets 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 OpenDJ directory server. The global access 082 * control rules may be overridden by more specific access control 083 * rules placed in the data. 084 * 085 * @return Returns an unmodifiable set containing the values of the "global-aci" property. 086 */ 087 SortedSet<Aci> getGlobalACI(); 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 Dsee Compat Access Control Handler implementation. 096 * 097 * @return Returns the value of the "java-class" property. 098 */ 099 String getJavaClass(); 100 101}