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.Rest2ldapEndpointCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying Rest2ldap 028 * Endpoint settings. 029 * <p> 030 * The Rest2ldap Endpoint provides RESTful access to LDAP application 031 * data using a set of customizable data transformations. 032 */ 033public interface Rest2ldapEndpointCfgClient extends HTTPEndpointCfgClient { 034 035 /** 036 * Get the configuration definition associated with this Rest2ldap Endpoint. 037 * 038 * @return Returns the configuration definition associated with this Rest2ldap Endpoint. 039 */ 040 ManagedObjectDefinition<? extends Rest2ldapEndpointCfgClient, ? extends Rest2ldapEndpointCfg> definition(); 041 042 043 044 /** 045 * Gets the "config-directory" property. 046 * <p> 047 * The directory containing the Rest2Ldap configuration file(s) for 048 * this specific endpoint. 049 * <p> 050 * The directory must be readable by the server and may contain 051 * multiple configuration files, one for each supported version of 052 * the REST endpoint. If a relative path is used then it will be 053 * resolved against the server's instance directory. 054 * 055 * @return Returns the value of the "config-directory" property. 056 */ 057 String getConfigDirectory(); 058 059 060 061 /** 062 * Sets 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 * @param value The value of the "config-directory" property. 073 * @throws PropertyException 074 * If the new value is invalid. 075 */ 076 void setConfigDirectory(String value) throws PropertyException; 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 Rest2ldap Endpoint implementation. 085 * 086 * @return Returns the value of the "java-class" property. 087 */ 088 String getJavaClass(); 089 090 091 092 /** 093 * Sets the "java-class" property. 094 * <p> 095 * Specifies the fully-qualified name of the Java class that 096 * provides the Rest2ldap Endpoint implementation. 097 * 098 * @param value The value of the "java-class" property. 099 * @throws PropertyException 100 * If the new value is invalid. 101 */ 102 void setJavaClass(String value) throws PropertyException; 103 104}