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.server;
027
028
029
030import java.net.InetAddress;
031import java.util.SortedSet;
032import org.opends.server.admin.Configuration;
033import org.opends.server.admin.server.ConfigurationChangeListener;
034import org.opends.server.types.DN;
035
036
037
038/**
039 * A server-side interface for querying Administration Connector
040 * settings.
041 * <p>
042 * The Administration Connector is used to interact with
043 * administration tools using LDAP.
044 */
045public interface AdministrationConnectorCfg extends Configuration {
046
047  /**
048   * Gets the configuration class associated with this Administration Connector.
049   *
050   * @return Returns the configuration class associated with this Administration Connector.
051   */
052  Class<? extends AdministrationConnectorCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Administration Connector is changed.
058   *
059   * @param listener
060   *          The Administration Connector configuration change listener.
061   */
062  void addChangeListener(ConfigurationChangeListener<AdministrationConnectorCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Administration Connector configuration change listener.
068   *
069   * @param listener
070   *          The Administration Connector configuration change listener.
071   */
072  void removeChangeListener(ConfigurationChangeListener<AdministrationConnectorCfg> listener);
073
074
075
076  /**
077   * Gets the "key-manager-provider" property.
078   * <p>
079   * Specifies the name of the key manager that is used with the
080   * Administration Connector .
081   *
082   * @return Returns the value of the "key-manager-provider" property.
083   */
084  String getKeyManagerProvider();
085
086
087
088  /**
089   * Gets the "key-manager-provider" property as a DN.
090   * <p>
091   * Specifies the name of the key manager that is used with the
092   * Administration Connector .
093   *
094   * @return Returns the DN value of the "key-manager-provider"
095   *         property.
096   */
097  DN getKeyManagerProviderDN();
098
099
100
101  /**
102   * Gets 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   * @return Returns an unmodifiable set containing the values of the "listen-address" property.
113   */
114  SortedSet<InetAddress> getListenAddress();
115
116
117
118  /**
119   * Gets the "listen-port" property.
120   * <p>
121   * Specifies the port number on which the Administration Connector
122   * will listen for connections from clients.
123   * <p>
124   * Only a single port number may be provided.
125   *
126   * @return Returns the value of the "listen-port" property.
127   */
128  int getListenPort();
129
130
131
132  /**
133   * Gets the "ssl-cert-nickname" property.
134   * <p>
135   * Specifies the nickname (also called the alias) of the certificate
136   * that the Administration Connector will use when performing SSL
137   * communication.
138   *
139   * @return Returns the value of the "ssl-cert-nickname" property.
140   */
141  String getSSLCertNickname();
142
143
144
145  /**
146   * Gets the "ssl-cipher-suite" property.
147   * <p>
148   * Specifies the names of the SSL cipher suites that are allowed for
149   * use in SSL communication.
150   *
151   * @return Returns an unmodifiable set containing the values of the "ssl-cipher-suite" property.
152   */
153  SortedSet<String> getSSLCipherSuite();
154
155
156
157  /**
158   * Gets the "ssl-protocol" property.
159   * <p>
160   * Specifies the names of the SSL protocols that are allowed for use
161   * in SSL or StartTLS communication.
162   *
163   * @return Returns an unmodifiable set containing the values of the "ssl-protocol" property.
164   */
165  SortedSet<String> getSSLProtocol();
166
167
168
169  /**
170   * Gets the "trust-manager-provider" property.
171   * <p>
172   * Specifies the name of the trust manager that is used with the
173   * Administration Connector .
174   *
175   * @return Returns the value of the "trust-manager-provider" property.
176   */
177  String getTrustManagerProvider();
178
179
180
181  /**
182   * Gets the "trust-manager-provider" property as a DN.
183   * <p>
184   * Specifies the name of the trust manager that is used with the
185   * Administration Connector .
186   *
187   * @return Returns the DN value of the "trust-manager-provider"
188   *         property.
189   */
190  DN getTrustManagerProviderDN();
191
192}