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 org.forgerock.opendj.config.server.ConfigurationChangeListener; 021 022 023 024/** 025 * A server-side interface for querying Rest2ldap Endpoint settings. 026 * <p> 027 * The Rest2ldap Endpoint provides RESTful access to LDAP application 028 * data using a set of customizable data transformations. 029 */ 030public interface Rest2ldapEndpointCfg extends HTTPEndpointCfg { 031 032 /** 033 * Gets the configuration class associated with this Rest2ldap Endpoint. 034 * 035 * @return Returns the configuration class associated with this Rest2ldap Endpoint. 036 */ 037 Class<? extends Rest2ldapEndpointCfg> configurationClass(); 038 039 040 041 /** 042 * Register to be notified when this Rest2ldap Endpoint is changed. 043 * 044 * @param listener 045 * The Rest2ldap Endpoint configuration change listener. 046 */ 047 void addRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener); 048 049 050 051 /** 052 * Deregister an existing Rest2ldap Endpoint configuration change listener. 053 * 054 * @param listener 055 * The Rest2ldap Endpoint configuration change listener. 056 */ 057 void removeRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener); 058 059 060 061 /** 062 * Gets the "config-directory" property. 063 * <p> 064 * The directory containing the Rest2Ldap configuration file(s) for 065 * this specific endpoint. 066 * <p> 067 * The directory must be readable by the server and may contain 068 * multiple configuration files, one for each supported version of 069 * the REST endpoint. If a relative path is used then it will be 070 * resolved against the server's instance directory. 071 * 072 * @return Returns the value of the "config-directory" property. 073 */ 074 String getConfigDirectory(); 075 076 077 078 /** 079 * Gets the "java-class" property. 080 * <p> 081 * Specifies the fully-qualified name of the Java class that 082 * provides the Rest2ldap Endpoint implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088}