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.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.AdminEndpointCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying Admin Endpoint 028 * settings. 029 * <p> 030 * The Admin Endpoint provides RESTful access to OpenDJ's monitoring 031 * and configuration backends. 032 */ 033public interface AdminEndpointCfgClient extends HTTPEndpointCfgClient { 034 035 /** 036 * Get the configuration definition associated with this Admin Endpoint. 037 * 038 * @return Returns the configuration definition associated with this Admin Endpoint. 039 */ 040 ManagedObjectDefinition<? extends AdminEndpointCfgClient, ? extends AdminEndpointCfg> definition(); 041 042 043 044 /** 045 * Gets the "java-class" property. 046 * <p> 047 * Specifies the fully-qualified name of the Java class that 048 * provides the Admin Endpoint implementation. 049 * 050 * @return Returns the value of the "java-class" property. 051 */ 052 String getJavaClass(); 053 054 055 056 /** 057 * Sets the "java-class" property. 058 * <p> 059 * Specifies the fully-qualified name of the Java class that 060 * provides the Admin Endpoint implementation. 061 * 062 * @param value The value of the "java-class" property. 063 * @throws PropertyException 064 * If the new value is invalid. 065 */ 066 void setJavaClass(String value) throws PropertyException; 067 068}