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 org.opends.server.admin.server.ConfigurationChangeListener;
032 import org.opends.server.types.DN;
033
034
035
036 /**
037 * A server-side interface for querying JMX Connection Handler
038 * settings.
039 * <p>
040 * The JMX Connection Handler is used to interact with clients using
041 * the Java Management Extensions (JMX) protocol.
042 */
043 public interface JMXConnectionHandlerCfg extends ConnectionHandlerCfg {
044
045 /**
046 * Gets the configuration class associated with this JMX Connection Handler.
047 *
048 * @return Returns the configuration class associated with this JMX Connection Handler.
049 */
050 Class<? extends JMXConnectionHandlerCfg> configurationClass();
051
052
053
054 /**
055 * Register to be notified when this JMX Connection Handler is changed.
056 *
057 * @param listener
058 * The JMX Connection Handler configuration change listener.
059 */
060 void addJMXChangeListener(ConfigurationChangeListener<JMXConnectionHandlerCfg> listener);
061
062
063
064 /**
065 * Deregister an existing JMX Connection Handler configuration change listener.
066 *
067 * @param listener
068 * The JMX Connection Handler configuration change listener.
069 */
070 void removeJMXChangeListener(ConfigurationChangeListener<JMXConnectionHandlerCfg> listener);
071
072
073
074 /**
075 * Gets the "java-class" property.
076 * <p>
077 * Specifies the fully-qualified name of the Java class that
078 * provides the JMX Connection Handler implementation.
079 *
080 * @return Returns the value of the "java-class" property.
081 */
082 String getJavaClass();
083
084
085
086 /**
087 * Gets the "key-manager-provider" property.
088 * <p>
089 * Specifies the name of the key manager that should be used with
090 * this JMX Connection Handler .
091 *
092 * @return Returns the value of the "key-manager-provider" property.
093 */
094 String getKeyManagerProvider();
095
096
097
098 /**
099 * Gets the "key-manager-provider" property as a DN.
100 * <p>
101 * Specifies the name of the key manager that should be used with
102 * this JMX Connection Handler .
103 *
104 * @return Returns the DN value of the "key-manager-provider"
105 * property.
106 */
107 DN getKeyManagerProviderDN();
108
109
110
111 /**
112 * Gets the "listen-port" property.
113 * <p>
114 * Specifies the port number on which the JMX Connection Handler
115 * will listen for connections from clients.
116 * <p>
117 * Only a single port number may be provided.
118 *
119 * @return Returns the value of the "listen-port" property.
120 */
121 int getListenPort();
122
123
124
125 /**
126 * Gets the "ssl-cert-nickname" property.
127 * <p>
128 * Specifies the nickname (also called the alias) of the certificate
129 * that the JMX Connection Handler should use when performing SSL
130 * communication.
131 * <p>
132 * This is only applicable when the JMX Connection Handler is
133 * configured to use SSL.
134 *
135 * @return Returns the value of the "ssl-cert-nickname" property.
136 */
137 String getSSLCertNickname();
138
139
140
141 /**
142 * Gets the "use-ssl" property.
143 * <p>
144 * Indicates whether the JMX Connection Handler should use SSL.
145 * <p>
146 * If enabled, the JMX Connection Handler will use SSL to encrypt
147 * communication with the clients.
148 *
149 * @return Returns the value of the "use-ssl" property.
150 */
151 boolean isUseSSL();
152
153 }