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.client; 027 028 029 030import org.opends.server.admin.ManagedObjectDefinition; 031import org.opends.server.admin.PropertyException; 032import org.opends.server.admin.std.server.EntryCacheMonitorProviderCfg; 033 034 035 036/** 037 * A client-side interface for reading and modifying Entry Cache 038 * Monitor Provider settings. 039 * <p> 040 * The Entry Cache Monitor Provider exposes monitor information about 041 * the state of OpenDJ directory server entry caches. 042 */ 043public interface EntryCacheMonitorProviderCfgClient extends MonitorProviderCfgClient { 044 045 /** 046 * Get the configuration definition associated with this Entry Cache Monitor Provider. 047 * 048 * @return Returns the configuration definition associated with this Entry Cache Monitor Provider. 049 */ 050 ManagedObjectDefinition<? extends EntryCacheMonitorProviderCfgClient, ? extends EntryCacheMonitorProviderCfg> definition(); 051 052 053 054 /** 055 * Gets the "java-class" property. 056 * <p> 057 * Specifies the fully-qualified name of the Java class that 058 * provides the Entry Cache Monitor Provider implementation. 059 * 060 * @return Returns the value of the "java-class" property. 061 */ 062 String getJavaClass(); 063 064 065 066 /** 067 * Sets the "java-class" property. 068 * <p> 069 * Specifies the fully-qualified name of the Java class that 070 * provides the Entry Cache Monitor Provider implementation. 071 * 072 * @param value The value of the "java-class" property. 073 * @throws PropertyException 074 * If the new value is invalid. 075 */ 076 void setJavaClass(String value) throws PropertyException; 077 078}