mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Jean-Noel Rouvignac
06.04.2013 56bcc2f1b8abbaba6f695f07af3c5bf69dd60173
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2008-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2013 ForgeRock AS
 */
package org.opends.guitools.controlpanel.datamodel;
 
import static org.opends.messages.AdminToolMessages.*;
 
import java.net.InetAddress;
import java.util.Collection;
import java.util.Collections;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
 
import org.opends.messages.Message;
import org.opends.server.admin.std.meta.AdministrationConnectorCfgDefn;
 
/**
 * This class is used to represent a Listener and is aimed to be used by the
 * classes in the ListenersTableModel class.
 */
public class ConnectionHandlerDescriptor
{
  private Set<CustomSearchResult> monitoringEntries = Collections.emptySet();
 
  /**
   * Enumeration used to represent the state of the listener.
   */
  public enum State
  {
    /**
     * The listener is enabled.
     */
    ENABLED,
    /**
     * The listener is disabled.
     */
    DISABLED,
    /**
     * The state of the listener is unknown.
     */
    UNKNOWN
  };
 
  /**
   * Enumeration used to represent the Protocol of the listener.
   *
   */
  public enum Protocol
  {
    /**
     * LDAP protocol.
     */
    LDAP(INFO_CTRL_PANEL_CONN_HANDLER_LDAP.get()),
    /**
     * LDAP accepting Start TLS protocol.
     */
    LDAP_STARTTLS(INFO_CTRL_PANEL_CONN_HANDLER_LDAP_STARTTLS.get()),
    /**
     * LDAP secure protocol.
     */
    LDAPS(INFO_CTRL_PANEL_CONN_HANDLER_LDAPS.get()),
    /**
     * HTTP protocol.
     */
    HTTP(INFO_CTRL_PANEL_CONN_HANDLER_HTTP.get()),
    /**
     * HTTP secure protocol.
     */
    HTTPS(INFO_CTRL_PANEL_CONN_HANDLER_HTTPS.get()),
    /**
     * JMX protocol.
     */
    JMX(INFO_CTRL_PANEL_CONN_HANDLER_JMX.get()),
    /**
     * JMX secure protocol.
     */
    JMXS(INFO_CTRL_PANEL_CONN_HANDLER_JMXS.get()),
    /**
     * LDIF protocol.
     */
    LDIF(INFO_CTRL_PANEL_CONN_HANDLER_LDIF.get()),
    /**
     * SNMP protocol.
     */
    SNMP(INFO_CTRL_PANEL_CONN_HANDLER_SNMP.get()),
    /**
     * Replication protocol.  Even if in the configuration is not considered
     * as a listener, we display it on the table.
     */
    REPLICATION(INFO_CTRL_PANEL_CONN_HANDLER_REPLICATION.get()),
    /**
     * Secure replication protocol.
     */
    REPLICATION_SECURE(INFO_CTRL_PANEL_CONN_HANDLER_REPLICATION_SECURE.get()),
    /**
     * Admin connector protocol.
     */
    ADMINISTRATION_CONNECTOR(INFO_CTRL_PANEL_CONN_HANDLER_ADMINISTRATION.get()),
    /**
     * Other protocol.
     */
    OTHER(INFO_CTRL_PANEL_CONN_HANDLER_OTHER.get());
 
    private Message displayMessage;
 
    private Protocol(Message displayMessage)
    {
      this.displayMessage = displayMessage;
    }
 
    /**
     * Returns the display Message to be used for the protocol.
     * @return the display Message to be used for the protocol.
     */
    public Message getDisplayMessage()
    {
      return displayMessage;
    }
  }
 
  private State state;
  private SortedSet<InetAddress> addresses = new TreeSet<InetAddress>(
      AdministrationConnectorCfgDefn.getInstance().
      getListenAddressPropertyDefinition());
  private int port;
  private Protocol protocol;
  private String toString;
  private String name;
 
  private int hashCode;
 
  /**
   * Constructor for the connection handler..
   * @param addresses the list of InetAdresses of the listener.
   * @param port the port of the connection handler.
   * @param protocol the protocol of the listener.
   * @param state the state of the connection handler (enabled, disabled, etc.).
   * @param name the name of the listener.
   * @param monitoringEntries the LDAP entries containing the monitoring
   * information.
   */
  public ConnectionHandlerDescriptor(Collection<InetAddress> addresses,
      int port, Protocol protocol, State state, String name,
      Set<CustomSearchResult> monitoringEntries)
  {
    this.addresses.addAll(addresses);
    this.port = port;
    this.protocol = protocol;
    this.state = state;
    this.name = name;
    this.monitoringEntries = Collections.unmodifiableSet(monitoringEntries);
 
    StringBuilder builder = new StringBuilder();
    builder.append(getProtocol() + " " + getState() + " ");
    for (InetAddress address : addresses)
    {
      builder.append(address.toString());
    }
    builder.append(" Port: "+port);
    toString = builder.toString();
    hashCode = toString.hashCode();
  }
 
  /**
   * Returns the address port representation of the listener.
   * @return the address port representation of the listener.
   */
  public SortedSet<InetAddress> getAddresses()
  {
    return addresses;
  }
 
  /**
   * Returns the protocol of the listener.
   * @return the protocol of the listener.
   */
  public Protocol getProtocol()
  {
    return protocol;
  }
 
  /**
   * Returns the state of the listener.
   * @return the state of the listener.
   */
  public State getState()
  {
    return state;
  }
 
  /**
   * Returns the monitoring entries.
   * @return the monitoring entries.
   */
  public Set<CustomSearchResult> getMonitoringEntries()
  {
    return monitoringEntries;
  }
 
  /**
   * Sets the monitoring entries.
   * @param monitoringEntries the monitoring entries.
   */
  public void setMonitoringEntries(Set<CustomSearchResult> monitoringEntries)
  {
    this.monitoringEntries = Collections.unmodifiableSet(monitoringEntries);
  }
 
  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode()
  {
    return hashCode;
  }
 
  /**
   * {@inheritDoc}
   */
  @Override
  public String toString()
  {
    return toString;
  }
 
  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(Object o)
  {
    boolean equals = false;
    if (o == this)
    {
      equals = true;
    }
    else if (o instanceof ConnectionHandlerDescriptor)
    {
      equals = toString.equals(o.toString());
      if (equals)
      {
        ConnectionHandlerDescriptor ch =
          (ConnectionHandlerDescriptor)o;
        // Compare monitoring entries
        equals = (getMonitoringEntries().equals(ch.getMonitoringEntries()));
      }
    }
    return equals;
  }
 
  /**
   * Returns the port of the connection handler.
   * @return the port of the connection handler.
   */
  public int getPort()
  {
    return port;
  }
 
  /**
   * Returns the name of the connection handler.
   * @return the name of the connection handler.
   */
  public String getName()
  {
    return name;
  }
}