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 java.net.InetAddress; 031import java.util.Collection; 032import java.util.SortedSet; 033import org.opends.server.admin.ConfigurationClient; 034import org.opends.server.admin.ManagedObjectDefinition; 035import org.opends.server.admin.PropertyException; 036import org.opends.server.admin.std.server.AdministrationConnectorCfg; 037 038 039 040/** 041 * A client-side interface for reading and modifying Administration 042 * Connector settings. 043 * <p> 044 * The Administration Connector is used to interact with 045 * administration tools using LDAP. 046 */ 047public interface AdministrationConnectorCfgClient extends ConfigurationClient { 048 049 /** 050 * Get the configuration definition associated with this Administration Connector. 051 * 052 * @return Returns the configuration definition associated with this Administration Connector. 053 */ 054 ManagedObjectDefinition<? extends AdministrationConnectorCfgClient, ? extends AdministrationConnectorCfg> definition(); 055 056 057 058 /** 059 * Gets the "key-manager-provider" property. 060 * <p> 061 * Specifies the name of the key manager that is used with the 062 * Administration Connector . 063 * 064 * @return Returns the value of the "key-manager-provider" property. 065 */ 066 String getKeyManagerProvider(); 067 068 069 070 /** 071 * Sets the "key-manager-provider" property. 072 * <p> 073 * Specifies the name of the key manager that is used with the 074 * Administration Connector . 075 * 076 * @param value The value of the "key-manager-provider" property. 077 * @throws PropertyException 078 * If the new value is invalid. 079 */ 080 void setKeyManagerProvider(String value) throws PropertyException; 081 082 083 084 /** 085 * Gets the "listen-address" property. 086 * <p> 087 * Specifies the address or set of addresses on which this 088 * Administration Connector should listen for connections from LDAP 089 * clients. 090 * <p> 091 * Multiple addresses may be provided as separate values for this 092 * attribute. If no values are provided, then the Administration 093 * Connector listens on all interfaces. 094 * 095 * @return Returns the values of the "listen-address" property. 096 */ 097 SortedSet<InetAddress> getListenAddress(); 098 099 100 101 /** 102 * Sets the "listen-address" property. 103 * <p> 104 * Specifies the address or set of addresses on which this 105 * Administration Connector should listen for connections from LDAP 106 * clients. 107 * <p> 108 * Multiple addresses may be provided as separate values for this 109 * attribute. If no values are provided, then the Administration 110 * Connector listens on all interfaces. 111 * 112 * @param values The values of the "listen-address" property. 113 * @throws PropertyException 114 * If one or more of the new values are invalid. 115 */ 116 void setListenAddress(Collection<InetAddress> values) throws PropertyException; 117 118 119 120 /** 121 * Gets the "listen-port" property. 122 * <p> 123 * Specifies the port number on which the Administration Connector 124 * will listen for connections from clients. 125 * <p> 126 * Only a single port number may be provided. 127 * 128 * @return Returns the value of the "listen-port" property. 129 */ 130 Integer getListenPort(); 131 132 133 134 /** 135 * Sets the "listen-port" property. 136 * <p> 137 * Specifies the port number on which the Administration Connector 138 * will listen for connections from clients. 139 * <p> 140 * Only a single port number may be provided. 141 * 142 * @param value The value of the "listen-port" property. 143 * @throws PropertyException 144 * If the new value is invalid. 145 */ 146 void setListenPort(int value) throws PropertyException; 147 148 149 150 /** 151 * Gets the "ssl-cert-nickname" property. 152 * <p> 153 * Specifies the nickname (also called the alias) of the certificate 154 * that the Administration Connector will use when performing SSL 155 * communication. 156 * 157 * @return Returns the value of the "ssl-cert-nickname" property. 158 */ 159 String getSSLCertNickname(); 160 161 162 163 /** 164 * Sets the "ssl-cert-nickname" property. 165 * <p> 166 * Specifies the nickname (also called the alias) of the certificate 167 * that the Administration Connector will use when performing SSL 168 * communication. 169 * 170 * @param value The value of the "ssl-cert-nickname" property. 171 * @throws PropertyException 172 * If the new value is invalid. 173 */ 174 void setSSLCertNickname(String value) throws PropertyException; 175 176 177 178 /** 179 * Gets the "ssl-cipher-suite" property. 180 * <p> 181 * Specifies the names of the SSL cipher suites that are allowed for 182 * use in SSL communication. 183 * 184 * @return Returns the values of the "ssl-cipher-suite" property. 185 */ 186 SortedSet<String> getSSLCipherSuite(); 187 188 189 190 /** 191 * Sets the "ssl-cipher-suite" property. 192 * <p> 193 * Specifies the names of the SSL cipher suites that are allowed for 194 * use in SSL communication. 195 * 196 * @param values The values of the "ssl-cipher-suite" property. 197 * @throws PropertyException 198 * If one or more of the new values are invalid. 199 */ 200 void setSSLCipherSuite(Collection<String> values) throws PropertyException; 201 202 203 204 /** 205 * Gets the "ssl-protocol" property. 206 * <p> 207 * Specifies the names of the SSL protocols that are allowed for use 208 * in SSL or StartTLS communication. 209 * 210 * @return Returns the values of the "ssl-protocol" property. 211 */ 212 SortedSet<String> getSSLProtocol(); 213 214 215 216 /** 217 * Sets the "ssl-protocol" property. 218 * <p> 219 * Specifies the names of the SSL protocols that are allowed for use 220 * in SSL or StartTLS communication. 221 * 222 * @param values The values of the "ssl-protocol" property. 223 * @throws PropertyException 224 * If one or more of the new values are invalid. 225 */ 226 void setSSLProtocol(Collection<String> values) throws PropertyException; 227 228 229 230 /** 231 * Gets the "trust-manager-provider" property. 232 * <p> 233 * Specifies the name of the trust manager that is used with the 234 * Administration Connector . 235 * 236 * @return Returns the value of the "trust-manager-provider" property. 237 */ 238 String getTrustManagerProvider(); 239 240 241 242 /** 243 * Sets the "trust-manager-provider" property. 244 * <p> 245 * Specifies the name of the trust manager that is used with the 246 * Administration Connector . 247 * 248 * @param value The value of the "trust-manager-provider" property. 249 * @throws PropertyException 250 * If the new value is invalid. 251 */ 252 void setTrustManagerProvider(String value) throws PropertyException; 253 254}