aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/plugin/jabberaccregwizz/IceConfigPanel.java
blob: 79865699b89913f1d8e569cda3e7cab10ef73685 (plain)
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.plugin.jabberaccregwizz;

import java.awt.*;
import java.awt.event.*;
import java.util.*;
import java.util.List;

import javax.swing.*;
import javax.swing.table.*;

import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.util.*;
import net.java.sip.communicator.util.swing.*;

/**
 * ICE configuration panel.
 *
 * @author Yana Stamcheva
 */
public class IceConfigPanel
    extends TransparentPanel
{
    /**
     * Serial version UID.
     */
    private static final long serialVersionUID = 0L;

    /**
     * The check box allowing the user to choose to use ICE.
     */
    private final JCheckBox iceBox = new SIPCommCheckBox(
        Resources.getString("plugin.jabberaccregwizz.USE_ICE"));

    /**
     * The check box allowing the user to choose to automatically discover
     * STUN servers.
     */
    private final JCheckBox autoDiscoverBox = new SIPCommCheckBox(
        Resources.getString("plugin.jabberaccregwizz.AUTO_DISCOVER_STUN"));

    /**
     * The check box allowing the user to choose to use the default
     * SIP Communicator STUN server.
     */
    private final JCheckBox defaultStunBox = new SIPCommCheckBox(
        Resources.getResources().getI18NString(
                "plugin.jabberaccregwizz.USE_DEFAULT_STUN_SERVER",
                new String[]{Resources.getResources().getSettingsString(
                        "service.gui.APPLICATION_NAME")}));

    /**
     * The table model for our additional stun servers table.
     */
    private final ServerTableModel tableModel = new ServerTableModel();

    /**
     * The stun server table.
     */
    private final JTable table = new JTable(tableModel);

    /**
     * The check box allowing the user to choose to use JingleNodes.
     */
    private final JCheckBox jnBox = new SIPCommCheckBox(
        Resources.getString("plugin.jabberaccregwizz.USE_JINGLE_NODES"));

    /**
     * The check box allowing the user to choose to automatically discover
     * JingleNodes relays.
     */
    private final JCheckBox jnAutoDiscoverBox = new SIPCommCheckBox(
        Resources.getString("plugin.jabberaccregwizz.AUTO_DISCOVER_JN"));

    /**
     * The table model for our additional stun servers table.
     */
    private final ServerTableModel jnTableModel =
        new ServerTableModel();

    /**
     * The JingleNodes server table.
     */
    private final JTable jnTable = new JTable(jnTableModel);

    /**
     * Creates an instance of <tt>IceConfigPanel</tt>.
     */
    public IceConfigPanel()
    {
        this.setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));

        iceBox.setAlignmentX(Component.LEFT_ALIGNMENT);
        autoDiscoverBox.setAlignmentX(Component.LEFT_ALIGNMENT);
        defaultStunBox.setAlignmentX(Component.LEFT_ALIGNMENT);

        /* ICE and STUN/TURN discovery are enabled by default for a new account,
         * these properties will be overridden for existing account when
         * they get loaded
         */
        iceBox.setSelected(true);
        autoDiscoverBox.setSelected(true);
        defaultStunBox.setSelected(true);

        //jnBox.setSelected(true);
        //jnAutoDiscoverBox.setSelected(true);

        JPanel checkBoxPanel = new TransparentPanel(new GridLayout(0, 1));
        checkBoxPanel.add(iceBox);
        checkBoxPanel.add(autoDiscoverBox);
        checkBoxPanel.add(defaultStunBox);

        add(checkBoxPanel);
        add(Box.createVerticalStrut(10));
        add(createAdditionalServersComponent());

        checkBoxPanel = new TransparentPanel(new GridLayout(0, 1));
        checkBoxPanel.add(jnBox);
        checkBoxPanel.add(jnAutoDiscoverBox);

        add(checkBoxPanel);
        add(Box.createVerticalStrut(10));
        add(createAdditionalJingleNodesComponent());
    }

    /**
     * Creates the list of additional STUN/TURN servers that are added by the
     * user.
     * @return the created component
     */
    private Component createAdditionalServersComponent()
    {
        table.setPreferredScrollableViewportSize(new Dimension(450, 60));

        tableModel.addColumn(
            Resources.getString("plugin.jabberaccregwizz.IP_ADDRESS")
            + "/" + Resources.getString("service.gui.PORT"));
        tableModel.addColumn(
            Resources.getString("plugin.jabberaccregwizz.SUPPORT_TURN"));

        table.setDefaultRenderer(   StunServerDescriptor.class,
                                    new ServerCellRenderer());

        //Create the scroll pane and add the table to it.
        JScrollPane scrollPane = new JScrollPane(table);

        JButton addButton
            = new JButton(Resources.getString("service.gui.ADD"));
        addButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                StunConfigDialog stunDialog = new StunConfigDialog(false);

                stunDialog.setVisible(true);
            }
        });

        JButton editButton
            = new JButton(Resources.getString("service.gui.EDIT"));
        editButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if(table.getSelectedRow() < 0)
                    return;

                StunServerDescriptor stunServer
                    = (StunServerDescriptor) tableModel.getValueAt(
                        table.getSelectedRow(), 0);

                if (stunServer != null)
                {
                    StunConfigDialog dialog = new StunConfigDialog(
                                    stunServer.getAddress(),
                                    stunServer.getPort(),
                                    stunServer.isTurnSupported(),
                                    StringUtils.getUTF8String(
                                                    stunServer.getUsername()),
                                    StringUtils.getUTF8String(
                                                    stunServer.getPassword()));

                    dialog.setVisible(true);
                }
            }
        });

        JButton deleteButton
            = new JButton(Resources.getString("service.gui.DELETE"));
        deleteButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                tableModel.removeRow(table.getSelectedRow());
            }
        });

        TransparentPanel buttonsPanel
            = new TransparentPanel(new FlowLayout(FlowLayout.RIGHT));

        buttonsPanel.add(addButton);
        buttonsPanel.add(editButton);
        buttonsPanel.add(deleteButton);

        TransparentPanel mainPanel = new TransparentPanel(new BorderLayout());
        mainPanel.setBorder(BorderFactory.createTitledBorder(
            Resources.getString(
                "plugin.jabberaccregwizz.ADDITIONAL_STUN_SERVERS")));
        mainPanel.add(scrollPane);
        mainPanel.add(buttonsPanel, BorderLayout.SOUTH);

        return mainPanel;
    }

    /**
     * The STUN configuration window.
     */
    private class StunConfigDialog extends SIPCommDialog
    {
        /**
         * Serial version UID.
         */
        private static final long serialVersionUID = 0L;

        /**
         * The main panel
         */
        private final JPanel mainPanel
                                = new TransparentPanel(new BorderLayout());

        /**
         * The address of the stun server.
         */
        private final JTextField addressField = new JTextField();

        /**
         * The port number field
         */
        private final JTextField portField = new JTextField();

        /**
         * The input verifier that we will be using to validate port numbers.
         */
        private final PortVerifier portVerifier = new PortVerifier();

        /**
         * The check box where user would indicate whether a STUN server is also
         * a TURN server.
         */
        private final JCheckBox supportTurnCheckBox = new JCheckBox(
            Resources.getString("plugin.jabberaccregwizz.SUPPORT_TURN"));

        /**
         * The user name field
         */
        private final JTextField usernameField = new JTextField();

        /**
         * The password field.
         */
        private final JPasswordField passwordField = new JPasswordField();

        /**
         * The pane where we show errors.
         */
        private JEditorPane errorMessagePane;

        /**
         * If the dialog is open via "edit" button.
         */
        private final boolean isEditMode;

        /**
         * Default STUN/TURN port.
         */
        private static final String DEFAULT_STUN_PORT = "3478";

        /**
         * Creates a new StunConfigDialog with filled in values.
         *
         * @param address the IP or FQDN of the server
         * @param port the port number
         * @param isSupportTurn a <tt>boolean</tt> indicating whether the server
         * is also a TURN relay
         * @param username the username we should use with this server
         * @param password the password we should use with this server
         */
        public StunConfigDialog(String  address,
                                int     port,
                                boolean isSupportTurn,
                                String  username,
                                String  password)
        {
            this(true);

            addressField.setText(address);
            portField.setText(Integer.toString( port ));
            supportTurnCheckBox.setSelected(isSupportTurn);
            usernameField.setText(username);
            passwordField.setText(password);

            if(isSupportTurn)
            {
                usernameField.setEnabled(true);
                passwordField.setEnabled(true);
            }
        }

        /**
         * Creates an empty dialog.
         *
         * @param editMode true if the dialog is in "edit" state, false means
         * "add" state
         */
        public StunConfigDialog(boolean editMode)
        {
            super(false);

            this.isEditMode = editMode;

            setTitle(Resources.getString(
                "plugin.jabberaccregwizz.ADD_STUN_SERVER"));

            JLabel addressLabel = new JLabel(
                Resources.getString("plugin.jabberaccregwizz.IP_ADDRESS"));
            JLabel portLabel = new JLabel(
                Resources.getString("service.gui.PORT"));
            JLabel usernameLabel = new JLabel(
                Resources.getString("plugin.jabberaccregwizz.TURN_USERNAME"));
            JLabel passwordLabel = new JLabel(
                Resources.getString("service.gui.PASSWORD"));

            TransparentPanel labelsPanel
                = new TransparentPanel(new GridLayout(0, 1));

            labelsPanel.add(new JLabel());
            labelsPanel.add(addressLabel);
            labelsPanel.add(portLabel);
            labelsPanel.add(usernameLabel);
            labelsPanel.add(passwordLabel);

            TransparentPanel valuesPanel
                = new TransparentPanel(new GridLayout(0, 1));

            usernameField.setEnabled(false);
            passwordField.setEnabled(false);

            portField.setText(DEFAULT_STUN_PORT);
            valuesPanel.add(supportTurnCheckBox);
            valuesPanel.add(addressField);
            valuesPanel.add(portField);
            valuesPanel.add(usernameField);
            valuesPanel.add(passwordField);

            //register an input verifier so that we would only accept valid
            //port numbers.
            portField.setInputVerifier(portVerifier);

            JButton addButton
                = new JButton(Resources.getString(isEditMode ?
                        "service.gui.EDIT" : "service.gui.ADD"));
            JButton cancelButton
                = new JButton(Resources.getString("service.gui.CANCEL"));

            addButton.addActionListener(new ActionListener()
            {
                public void actionPerformed(ActionEvent e)
                {
                    String address = addressField.getText();
                    String portStr = portField.getText();
                    StunServerDescriptor stunServer = null;

                    int port = -1;
                    if(portStr != null && portStr.trim().length() > 0)
                        port = Integer.parseInt( portField.getText() );

                    String username = usernameField.getText();
                    char[] password = passwordField.getPassword();

                    String errorMessage = null;
                    if (address == null || address.length() <= 0)
                        errorMessage = Resources.getString(
                            "plugin.jabberaccregwizz.NO_STUN_ADDRESS");

                    if ((username == null || username.length() <= 0) &&
                            supportTurnCheckBox.isSelected())
                        errorMessage = Resources.getString(
                            "plugin.jabberaccregwizz.NO_STUN_USERNAME");

                    stunServer = getStunServer(address, port);

                    if(stunServer != null && !isEditMode)
                    {
                        errorMessage = Resources.getString(
                            "plugin.jabberaccregwizz.STUN_ALREADY_EXIST");
                    }

                    if (errorMessage != null)
                    {
                        loadErrorMessage(errorMessage);
                        return;
                    }

                    if(!isEditMode)
                    {
                        stunServer = new StunServerDescriptor(
                                address, port, supportTurnCheckBox.isSelected(),
                                username, new String( password ));

                        addStunServer(stunServer);
                    }
                    else
                    {
                        /* edit an existing STUN/TURN server */
                        stunServer.setAddress(address);
                        stunServer.setPort(port);
                        stunServer.setTurnSupported(
                                supportTurnCheckBox.isSelected());
                        stunServer.setUsername(username);
                        stunServer.setPassword(new String(password));

                        modifyStunServer(stunServer);
                    }
                    dispose();
                }
            });

            cancelButton.addActionListener(new ActionListener()
            {
                public void actionPerformed(ActionEvent e)
                {
                    dispose();
                }
            });

            supportTurnCheckBox.addItemListener(new ItemListener()
            {
                public void itemStateChanged(ItemEvent evt)
                {
                    if(evt.getStateChange() == ItemEvent.SELECTED)
                    {
                        /* show TURN user/password textfield */
                        usernameField.setEnabled(true);
                        passwordField.setEnabled(true);
                    }
                    else
                    {
                        /* hide TURN user/password textfield */
                        usernameField.setEnabled(false);
                        passwordField.setEnabled(false);
                    }
                }
            });

            TransparentPanel buttonsPanel
                = new TransparentPanel(new FlowLayout(FlowLayout.RIGHT));
            buttonsPanel.add(addButton);
            buttonsPanel.add(cancelButton);

            mainPanel.add(labelsPanel, BorderLayout.WEST);
            mainPanel.add(valuesPanel, BorderLayout.CENTER);
            mainPanel.add(buttonsPanel, BorderLayout.SOUTH);

            mainPanel.setBorder(BorderFactory.createEmptyBorder(20, 20, 20, 20));
            getContentPane().add(mainPanel, BorderLayout.NORTH);
            pack();
        }

        /**
         * Loads the given error message in the current dialog, by re-validating
         * the content.
         *
         * @param errorMessage The error message to load.
         */
        private void loadErrorMessage(String errorMessage)
        {
            if (errorMessagePane == null)
            {
                errorMessagePane = new JEditorPane();

                errorMessagePane.setOpaque(false);
                errorMessagePane.setForeground(Color.RED);

                mainPanel.add(errorMessagePane, BorderLayout.NORTH);
            }

            errorMessagePane.setText(errorMessage);
            mainPanel.revalidate();
            mainPanel.repaint();

            this.pack();

            //WORKAROUND: there's something wrong happening in this pack and
            //components get cluttered, partially hiding the password text field.
            //I am under the impression that this has something to do with the
            //message pane preferred size being ignored (or being 0) which is
            //why I am adding it's height to the dialog. It's quite ugly so
            //please fix if you have something better in mind.
            this.setSize(getWidth(), getHeight() +
                    errorMessagePane.getHeight());
        }

        /**
         * Dummy implementation that we are not using.
         *
         * @param escaped unused
         */
        @Override
        protected void close(boolean escaped) {}
    }

    /**
     * A custom cell renderer used in the cell containing the
     * <tt>StunServer</tt> instance.
     */
    private static class ServerCellRenderer
        extends DefaultTableCellRenderer
    {
        /**
         * Serial version UID.
         */
        private static final long serialVersionUID = 0L;

        // We need a place to store the color the JLabel should be returned
        // to after its foreground and background colors have been set
        // to the selection background color.
        // These vars will be made protected when their names are finalized.
        /** the fore ground color to use when not selected */
        private Color unselectedForeground;

        /** the fore ground color to use when selected */
        private Color unselectedBackground;

        /**
         * Overrides <code>JComponent.setForeground</code> to assign
         * the unselected-foreground color to the specified color.
         *
         * @param c set the foreground color to this value
         */
        public void setForeground(Color c)
        {
            super.setForeground(c);
            unselectedForeground = c;
        }

        /**
         * Overrides <code>JComponent.setBackground</code> to assign
         * the unselected-background color to the specified color.
         *
         * @param c set the background color to this value
         */
        public void setBackground(Color c)
        {
            super.setBackground(c);
            unselectedBackground = c;
        }

        /**
         * Returns a cell renderer for the specified cell.
         *
         * @param table the {@link JTable} that the cell belongs to.
         * @param value the cell value
         * @param isSelected indicates whether the cell is selected
         * @param hasFocus indicates whether the cell is currently on focus.
         * @param row the row index
         * @param column the column index
         *
         * @return the cell renderer
         */
        public Component getTableCellRendererComponent( JTable table,
                                                        Object value,
                                                        boolean isSelected,
                                                        boolean hasFocus,
                                                        int row,
                                                        int column)
        {

            if (value instanceof StunServerDescriptor)
            {
                StunServerDescriptor stunServer = (StunServerDescriptor) value;

                this.setText(   stunServer.getAddress()
                                + "/" + stunServer.getPort());

                if (isSelected)
                {
                    super.setForeground(table.getSelectionForeground());
                    super.setBackground(table.getSelectionBackground());
                }
                else
                {
                     super.setForeground((unselectedForeground != null)
                         ? unselectedForeground
                         : table.getForeground());
                     super.setBackground((unselectedBackground != null)
                         ? unselectedBackground
                         : table.getBackground());
                }
            }
            else if(value instanceof JingleNodeDescriptor)
            {
                JingleNodeDescriptor jn = (JingleNodeDescriptor) value;

                this.setText(jn.getJID());

                if (isSelected)
                {
                    super.setForeground(table.getSelectionForeground());
                    super.setBackground(table.getSelectionBackground());
                }
                else
                {
                     super.setForeground((unselectedForeground != null)
                         ? unselectedForeground
                         : table.getForeground());
                     super.setBackground((unselectedBackground != null)
                         ? unselectedBackground
                         : table.getBackground());
                }
            }
            else
                return super.getTableCellRendererComponent(table, value,
                    isSelected, hasFocus, row, column);

            return this;
        }
    }

    /**
     * A custom table model, with a non editable cells and a custom class column
     * objects.
     */
    private class ServerTableModel
        extends DefaultTableModel
    {
        /**
         * Serial version UID.
         */
        private static final long serialVersionUID = 0L;

        /**
         * Returns the class of the objects contained in the column given by
         * the index. The class is used to distinguish which renderer should be
         * used.
         *
         * @param columnIndex  the column being queried
         * @return the class of objects contained in the column
         */
        public Class<?> getColumnClass(int columnIndex)
        {
            return getValueAt(0, columnIndex).getClass();
        }

        /**
         * Returns <tt>false</tt> to indicate that none of the columns is
         * editable.
         *
         * @param row the row whose value is to be queried
         * @param column the column whose value is to be queried
         * @return false
         */
        public boolean isCellEditable(int row, int column)
        {
            return false;
        }
    }

    /**
     * Indicates if ice should be used for this account.
     * @return <tt>true</tt> if ICE should be used for this account, otherwise
     * returns <tt>false</tt>
     */
    protected boolean isUseIce()
    {
        return iceBox.isSelected();
    }

    /**
     * Sets the <tt>useIce</tt> property.
     * @param isUseIce <tt>true</tt> to indicate that ICE should be used for
     * this account, <tt>false</tt> - otherwise.
     */
    protected void setUseIce(boolean isUseIce)
    {
        iceBox.setSelected(isUseIce);
    }

    /**
     * Indicates if the stun server should be automatically discovered.
     * @return <tt>true</tt> if the stun server should be automatically
     * discovered, otherwise returns <tt>false</tt>.
     */
    protected boolean isAutoDiscoverStun()
    {
        return autoDiscoverBox.isSelected();
    }

    /**
     * Sets the <tt>autoDiscoverStun</tt> property.
     * @param isAutoDiscover <tt>true</tt> to indicate that stun server should
     * be auto-discovered, <tt>false</tt> - otherwise.
     */
    protected void setAutoDiscoverStun(boolean isAutoDiscover)
    {
        autoDiscoverBox.setSelected(isAutoDiscover);
    }

    /**
     * Indicates if the default stun server should be used
     * @return <tt>true</tt> if the default stun server should be used,
     * otherwise returns <tt>false</tt>.
     */
    protected boolean isUseDefaultStunServer()
    {
        return defaultStunBox.isSelected();
    }

    /**
     * Sets the <tt>defaultStun</tt> property.
     * @param isDefaultStun <tt>true</tt> to indicate that the default stun
     * server should be used, <tt>false</tt> otherwise.
     */
    protected void setUseDefaultStunServer(boolean isDefaultStun)
    {
        defaultStunBox.setSelected(isDefaultStun);
    }

    /**
     * Returns the list of additional stun servers entered by the user.
     *
     * @return the list of additional stun servers entered by the user
     */
    @SuppressWarnings("unchecked")//getDataVector() is simply not parameterized
    protected List<StunServerDescriptor> getAdditionalStunServers()
    {
        LinkedList<StunServerDescriptor> serversList
                                    = new LinkedList<StunServerDescriptor>();

        Vector<Vector<StunServerDescriptor>> serverRows
                                    = tableModel.getDataVector();

        for(Vector<StunServerDescriptor> row : serverRows)
            serversList.add(row.elementAt(0));

        return serversList;
    }

    /**
     * Adds the given <tt>stunServer</tt> to the list of additional stun
     * servers.
     * @param stunServer the stun server to add
     */
    protected void addStunServer(StunServerDescriptor stunServer)
    {
        tableModel.addRow(new Object[]{stunServer,
            stunServer.isTurnSupported()});
    }

    /**
     * Modify the given <tt>stunServer</tt> from the list of stun servers.
     *
     * @param stunServer the stun server to modify
     */
    protected void modifyStunServer(StunServerDescriptor stunServer)
    {
        for (int i = 0; i < tableModel.getRowCount(); i++)
        {
            StunServerDescriptor server
                = (StunServerDescriptor) tableModel.getValueAt(i, 0);

            if(stunServer == server)
            {
                tableModel.setValueAt(stunServer, i, 0);
                tableModel.setValueAt(stunServer.isTurnSupported(), i, 1);
                return;
            }
        }
    }

    /**
     * Indicates if a stun server with the given <tt>address</tt> and
     * <tt>port</tt> already exists in the additional stun servers table.
     *
     * @param address the STUN server address to check
     * @param port the STUN server port to check
     *
     * @return <tt>StunServerDescriptor</tt> if a STUN server with the given
     * <tt>address</tt> and <tt>port</tt> already exists in the table, otherwise
     *  returns <tt>null</tt>
     */
    protected StunServerDescriptor getStunServer(String address, int port)
    {
        for (int i = 0; i < tableModel.getRowCount(); i++)
        {
            StunServerDescriptor stunServer
                = (StunServerDescriptor) tableModel.getValueAt(i, 0);

            if (stunServer.getAddress().equalsIgnoreCase(address)
                && stunServer.getPort() == port)
                return stunServer;
        }
        return null;
    }

    /**
     * The input verifier that we use to verify port numbers.
     */
    private static class PortVerifier extends InputVerifier
    {
        /**
         * Checks whether the JComponent's input is a valid port number. This
         * has no side effects. It returns a boolean indicating
         * the status of the argument's input.
         *
         * @param input the JComponent to verify
         * @return <tt>true</tt> when valid, <tt>false</tt> when invalid or when
         * <tt>input</tt> is not a {@link JTextField} instance.
         */
        public boolean verify(JComponent input)
        {
            if ( !( input instanceof JTextField ) )
                return false;

            JTextField portField = (JTextField)input;

            String portStr = portField.getText();

            int port = -1;

            //we accept empty strings as that would mean the default port.
            if( portStr== null || portStr.trim().length() == 0)
                return true;

            try
            {
                 port = Integer.parseInt(portStr);
            }
            catch(Throwable t)
            {
                //something's wrong and whatever it is - we don't care we
                //simply return false.
                return false;
            }

            return NetworkUtils.isValidPortNumber(port);
        }
    }

    /**
     * Creates the list of additional JingleNodes that are added by the user.
     *
     * @return the created component
     */
    private Component createAdditionalJingleNodesComponent()
    {
        jnTable.setPreferredScrollableViewportSize(new Dimension(450, 60));

        jnTableModel.addColumn(
            Resources.getString("plugin.jabberaccregwizz.JID_ADDRESS"));
        jnTableModel.addColumn(
            Resources.getString("plugin.jabberaccregwizz.RELAY_SUPPORT"));

        jnTable.setDefaultRenderer(JingleNodeDescriptor.class,
                                    new ServerCellRenderer());

        //Create the scroll pane and add the table to it.
        JScrollPane scrollPane = new JScrollPane(jnTable);

        JButton addButton
            = new JButton(Resources.getString("service.gui.ADD"));
        addButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                JNConfigDialog jnDialog = new JNConfigDialog(false);

                jnDialog.setVisible(true);
            }
        });

        JButton editButton
            = new JButton(Resources.getString("service.gui.EDIT"));
        editButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if(jnTable.getSelectedRow() < 0)
                    return;

                JingleNodeDescriptor jn
                    = (JingleNodeDescriptor) jnTableModel.getValueAt(
                        jnTable.getSelectedRow(), 0);

                if (jn != null)
                {
                    JNConfigDialog dialog = new JNConfigDialog(
                                    jn.getJID(), jn.isRelaySupported());

                    dialog.setVisible(true);
                }
            }
        });

        JButton deleteButton
            = new JButton(Resources.getString("service.gui.DELETE"));
        deleteButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                jnTableModel.removeRow(jnTable.getSelectedRow());
            }
        });

        TransparentPanel buttonsPanel
            = new TransparentPanel(new FlowLayout(FlowLayout.RIGHT));

        buttonsPanel.add(addButton);
        buttonsPanel.add(editButton);
        buttonsPanel.add(deleteButton);

        TransparentPanel mainPanel = new TransparentPanel(new BorderLayout());
        mainPanel.setBorder(BorderFactory.createTitledBorder(
            Resources.getString(
                "plugin.jabberaccregwizz.ADDITIONAL_JINGLE_NODES")));
        mainPanel.add(scrollPane);
        mainPanel.add(buttonsPanel, BorderLayout.SOUTH);

        return mainPanel;
    }

    /**
     * The JingleNodes configuration window.
     */
    private class JNConfigDialog extends SIPCommDialog
    {
        /**
         * Serial version UID.
         */
        private static final long serialVersionUID = 0L;

        /**
         * The main panel
         */
        private final JPanel mainPanel
                                = new TransparentPanel(new BorderLayout());

        /**
         * The address of the stun server.
         */
        private final JTextField addressField = new JTextField();

        /**
         * The check box where user would indicate whether a STUN server is also
         * a TURN server.
         */
        private final JCheckBox supportRelayCheckBox = new JCheckBox(
            Resources.getString("plugin.jabberaccregwizz.RELAY_SUPPORT"));

        /**
         * The pane where we show errors.
         */
        private JEditorPane errorMessagePane;

        /**
         * If the dialog is open via "edit" button.
         */
        private final boolean isEditMode;

        /**
         * Creates a new JNConfigDialog with filled in values.
         *
         * @param address the IP or FQDN of the server
         * @param isRelaySupport a <tt>boolean</tt> indicating whether the node
         * supports relay
         */
        public JNConfigDialog(String  address, boolean isRelaySupport)
        {
            this(true);

            addressField.setText(address);
            supportRelayCheckBox.setSelected(isRelaySupport);
        }

        /**
         * Creates an empty dialog.
         *
         * @param editMode true if the dialog is in "edit" state, false means
         * "add" state
         */
        public JNConfigDialog(boolean editMode)
        {
            super(false);

            this.isEditMode = editMode;

            setTitle(Resources.getString(
                "plugin.jabberaccregwizz.ADD_JINGLE_NODE"));

            JLabel addressLabel = new JLabel(
                Resources.getString("plugin.jabberaccregwizz.JID_ADDRESS"));

            TransparentPanel labelsPanel
                = new TransparentPanel(new GridLayout(0, 1));

            labelsPanel.add(addressLabel);
            labelsPanel.add(new JLabel());

            TransparentPanel valuesPanel
                = new TransparentPanel(new GridLayout(0, 1));

            valuesPanel.add(addressField);
            valuesPanel.add(supportRelayCheckBox);

            JButton addButton
                = new JButton(Resources.getString(isEditMode ?
                        "service.gui.EDIT" : "service.gui.ADD"));
            JButton cancelButton
                = new JButton(Resources.getString("service.gui.CANCEL"));

            addButton.addActionListener(new ActionListener()
            {
                public void actionPerformed(ActionEvent e)
                {
                    String address = addressField.getText();
                    JingleNodeDescriptor jnServer = null;

                    String errorMessage = null;
                    if (address == null || address.length() <= 0)
                        errorMessage = Resources.getString(
                            "plugin.jabberaccregwizz.NO_STUN_ADDRESS");

                    jnServer = getJingleNodes(address);

                    if(jnServer != null && !isEditMode)
                    {
                        errorMessage = Resources.getString(
                            "plugin.jabberaccregwizz.STUN_ALREADY_EXIST");
                    }

                    if (errorMessage != null)
                    {
                        loadErrorMessage(errorMessage);
                        return;
                    }

                    if(!isEditMode)
                    {
                        jnServer = new JingleNodeDescriptor(
                                address, supportRelayCheckBox.isSelected());

                        addJingleNodes(jnServer);
                    }
                    else
                    {
                        /* edit an existing Jingle Node */
                        jnServer.setAddress(address);

                        jnServer.setRelay(supportRelayCheckBox.isSelected());
                        modifyJingleNodes(jnServer);
                    }
                    dispose();
                }
            });

            cancelButton.addActionListener(new ActionListener()
            {
                public void actionPerformed(ActionEvent e)
                {
                    dispose();
                }
            });

            TransparentPanel buttonsPanel
                = new TransparentPanel(new FlowLayout(FlowLayout.RIGHT));
            buttonsPanel.add(addButton);
            buttonsPanel.add(cancelButton);

            mainPanel.add(labelsPanel, BorderLayout.WEST);
            mainPanel.add(valuesPanel, BorderLayout.CENTER);
            mainPanel.add(buttonsPanel, BorderLayout.SOUTH);

            mainPanel.setBorder(BorderFactory.createEmptyBorder(20, 20, 20,
                    20));
            getContentPane().add(mainPanel, BorderLayout.NORTH);
            pack();
        }

        /**
         * Loads the given error message in the current dialog, by re-validating
         * the content.
         *
         * @param errorMessage The error message to load.
         */
        private void loadErrorMessage(String errorMessage)
        {
            if (errorMessagePane == null)
            {
                errorMessagePane = new JEditorPane();

                errorMessagePane.setOpaque(false);
                errorMessagePane.setForeground(Color.RED);

                mainPanel.add(errorMessagePane, BorderLayout.NORTH);
            }

            errorMessagePane.setText(errorMessage);
            mainPanel.revalidate();
            mainPanel.repaint();

            this.pack();

            //WORKAROUND: there's something wrong happening in this pack and
            //components get cluttered, partially hiding the password text field.
            //I am under the impression that this has something to do with the
            //message pane preferred size being ignored (or being 0) which is
            //why I am adding it's height to the dialog. It's quite ugly so
            //please fix if you have something better in mind.
            this.setSize(getWidth(), getHeight() +
                    errorMessagePane.getHeight());
        }

        /**
         * Dummy implementation that we are not using.
         *
         * @param escaped unused
         */
        @Override
        protected void close(boolean escaped) {}
    }

    /**
     * Indicates if Jingle Nodes should be used for this account.
     *
     * @return <tt>true</tt> if Jingle Nodes should be used for this account,
     * otherwise returns <tt>false</tt>
     */
    protected boolean isUseJingleNodes()
    {
        return jnBox.isSelected();
    }

    /**
     * Sets the <tt>useJingleNodes</tt> property.
     *
     * @param isUseJN <tt>true</tt> to indicate that Jingle Nodes should be
     * used for this account, <tt>false</tt> - otherwise.
     */
    protected void setUseJingleNodes(boolean isUseJN)
    {
        jnBox.setSelected(isUseJN);
    }

    /**
     * Indicates if the Jingle Nodes relays should be automatically discovered.
     *
     * @return <tt>true</tt> if the Jingle Nodes relays should be automatically
     * discovered, otherwise returns <tt>false</tt>.
     */
    protected boolean isAutoDiscoverJingleNodes()
    {
        return jnAutoDiscoverBox.isSelected();
    }

    /**
     * Sets the <tt>autoDiscoverJingleNodes</tt> property.
     *
     * @param isAutoDiscover <tt>true</tt> to indicate that Jingle Nodes relays
     * should be auto-discovered, <tt>false</tt> - otherwise.
     */
    protected void setAutoDiscoverJingleNodes(boolean isAutoDiscover)
    {
        jnAutoDiscoverBox.setSelected(isAutoDiscover);
    }

    /**
     * Returns the list of additional Jingle Nodes entered by the user.
     *
     * @return the list of additional Jingle Nodes entered by the user
     */
    @SuppressWarnings("unchecked")//getDataVector() is simply not parameterized
    protected List<JingleNodeDescriptor> getAdditionalJingleNodes()
    {
        LinkedList<JingleNodeDescriptor> serversList
                                    = new LinkedList<JingleNodeDescriptor>();

        Vector<Vector<JingleNodeDescriptor>> serverRows
                                    = jnTableModel.getDataVector();

        for(Vector<JingleNodeDescriptor> row : serverRows)
            serversList.add(row.elementAt(0));

        return serversList;
    }

    /**
     * Indicates if a JingleNodes with the given <tt>address</tt> already exists
     * in the additional stun servers table.
     *
     * @param address the JingleNodes address to check
     *
     * @return <tt>JingleNodesDescriptor</tt> if a Jingle Node with the given
     * <tt>address</tt> already exists in the table, otherwise returns
     * <tt>null</tt>
     */
    protected JingleNodeDescriptor getJingleNodes(String address)
    {
        for (int i = 0; i < jnTableModel.getRowCount(); i++)
        {
            JingleNodeDescriptor jn
                = (JingleNodeDescriptor) jnTableModel.getValueAt(i, 0);

            if (jn.getJID().equalsIgnoreCase(address))
                return jn;
        }
        return null;
    }

    /**
     * Adds the given <tt>jingleNode</tt> to the list of additional JingleNodes
     *
     * @param jingleNode the Jingle Node server to add
     */
    protected void addJingleNodes(JingleNodeDescriptor jingleNode)
    {
        jnTableModel.addRow(new Object[]{jingleNode,
            jingleNode.isRelaySupported()});
    }

    /**
     * Modify the given <tt>jingleNode</tt> from the list of Jingle Nodes.
     *
     * @param jingleNode the Jingle Node to modify
     */
    protected void modifyJingleNodes(JingleNodeDescriptor jingleNode)
    {
        for (int i = 0; i < jnTableModel.getRowCount(); i++)
        {
            JingleNodeDescriptor node
                = (JingleNodeDescriptor) jnTableModel.getValueAt(i, 0);

            if(jingleNode == node)
            {
                jnTableModel.setValueAt(jingleNode, i, 0);
                jnTableModel.setValueAt(jingleNode.isRelaySupported(), i, 1);
                return;
            }
        }
    }
}