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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import java.util.SortedSet;
032 import org.opends.server.admin.Configuration;
033 import org.opends.server.admin.server.ConfigurationChangeListener;
034 import org.opends.server.types.AddressMask;
035
036
037
038 /**
039 * A server-side interface for querying Connection Handler settings.
040 * <p>
041 * Connection Handlers are responsible for handling all interaction
042 * with the clients, including accepting the connections, reading
043 * requests, and sending responses.
044 */
045 public interface ConnectionHandlerCfg extends Configuration {
046
047 /**
048 * Gets the configuration class associated with this Connection Handler.
049 *
050 * @return Returns the configuration class associated with this Connection Handler.
051 */
052 Class<? extends ConnectionHandlerCfg> configurationClass();
053
054
055
056 /**
057 * Register to be notified when this Connection Handler is changed.
058 *
059 * @param listener
060 * The Connection Handler configuration change listener.
061 */
062 void addChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener);
063
064
065
066 /**
067 * Deregister an existing Connection Handler configuration change listener.
068 *
069 * @param listener
070 * The Connection Handler configuration change listener.
071 */
072 void removeChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener);
073
074
075
076 /**
077 * Gets the "allowed-client" property.
078 * <p>
079 * Specifies a set of address masks that determines the addresses of
080 * the clients that are allowed to establish connections to this
081 * connection handler.
082 *
083 * @return Returns an unmodifiable set containing the values of the "allowed-client" property.
084 */
085 SortedSet<AddressMask> getAllowedClient();
086
087
088
089 /**
090 * Gets the "denied-client" property.
091 * <p>
092 * Specifies a set of address masks that determines the addresses of
093 * the clients that are not allowed to establish connections to this
094 * connection handler.
095 * <p>
096 * If both allowed and denied client masks are defined and a client
097 * connection matches one or more masks in both lists, then the
098 * connection is denied. If only a denied list is specified, then any
099 * client not matching a mask in that list is allowed.
100 *
101 * @return Returns an unmodifiable set containing the values of the "denied-client" property.
102 */
103 SortedSet<AddressMask> getDeniedClient();
104
105
106
107 /**
108 * Gets the "enabled" property.
109 * <p>
110 * Indicates whether the Connection Handler is enabled.
111 *
112 * @return Returns the value of the "enabled" property.
113 */
114 boolean isEnabled();
115
116
117
118 /**
119 * Gets the "java-class" property.
120 * <p>
121 * Specifies the fully-qualified name of the Java class that
122 * provides the Connection Handler implementation.
123 *
124 * @return Returns the value of the "java-class" property.
125 */
126 String getJavaClass();
127
128 }