com.zeroc.IceGridGUI.Application.AdapterEditor.java Source code

Java tutorial

Introduction

Here is the source code for com.zeroc.IceGridGUI.Application.AdapterEditor.java

Source

// **********************************************************************
//
// Copyright (c) 2003-2016 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

package com.zeroc.IceGridGUI.Application;

import java.awt.event.ActionEvent;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

import com.jgoodies.forms.builder.DefaultFormBuilder;
import com.jgoodies.forms.layout.CellConstraints;

import com.zeroc.IceGrid.*;
import com.zeroc.IceGridGUI.*;

@SuppressWarnings("unchecked")
class AdapterEditor extends CommunicatorChildEditor {
    AdapterEditor() {
        _objects = new ArrayMapField(this, true, "Identity", "Type", "Property", "Proxy Options");
        _allocatables = new ArrayMapField(this, true, "Identity", "Type", "Property", "Proxy Options");

        //
        // Create buttons
        //

        //
        // _replicaGroupButton
        //
        Action gotoReplicaGroup = new AbstractAction("", Utils.getIcon("/icons/16x16/goto.png")) {
            @Override
            public void actionPerformed(ActionEvent e) {
                Object obj = _replicaGroupId.getSelectedItem();
                Adapter adapter = getAdapter();

                ReplicaGroup rg = null;
                if (obj instanceof ReplicaGroup) {
                    rg = (ReplicaGroup) obj;
                } else {
                    String replicaGroupId = Utils.substitute(obj.toString(), adapter.getResolver());

                    rg = adapter.getRoot().findReplicaGroup(replicaGroupId);
                }

                //
                // The button is enabled therefore rg should be != null
                //
                if (rg != null) {
                    adapter.getRoot().setSelectedNode(rg);
                }
            }
        };
        gotoReplicaGroup.putValue(Action.SHORT_DESCRIPTION, "Goto the definition of this replica group");
        _replicaGroupButton = new JButton(gotoReplicaGroup);

        Action checkRegisterProcess = new AbstractAction("Register Process") {
            @Override
            public void actionPerformed(ActionEvent e) {
                updated();
            }
        };
        _registerProcess = new JCheckBox(checkRegisterProcess);
        _registerProcess.setToolTipText("<html>This setting is ignored for servers running Ice<br>"
                + "version 3.3 or greater.<br>" + "During activation, create a Process object<br>"
                + "in this adapter and register it with IceGrid<br>"
                + "to enable clean shutdown; you should register<br>"
                + "exactly one Process object per server.</html>");

        Action checkServerLifetime = new AbstractAction("Server Lifetime") {
            @Override
            public void actionPerformed(ActionEvent e) {
                updated();
            }
        };
        _serverLifetime = new JCheckBox(checkServerLifetime);
        _serverLifetime.setToolTipText("<html>Is the adapter lifetime the same as the server<br>"
                + "lifetime? The server is considered to be active<br>"
                + "only if all the adapters with this attribute set<br>" + "to true are active.</html>");
        //
        // Associate updateListener with various fields
        //
        _name.getDocument().addDocumentListener(new DocumentListener() {
            @Override
            public void changedUpdate(DocumentEvent e) {
                update();
            }

            @Override
            public void insertUpdate(DocumentEvent e) {
                update();
            }

            @Override
            public void removeUpdate(DocumentEvent e) {
                update();
            }

            private void update() {
                updated();
                //
                // Recompute default id
                //
                _defaultAdapterId = getAdapter().getDefaultAdapterId(_name.getText().trim());
                refreshId();
            }
        });

        _name.setToolTipText("Identifies this object adapter within an Ice communicator");

        _endpoints.getDocument().addDocumentListener(_updateListener);
        _endpoints
                .setToolTipText("<html>The network interface(s) on which this object adapter receives requests;<br>"
                        + "for example:<br>" + " tcp (listen on all local interfaces using a random port)<br>"
                        + " tcp -h venus.foo.com (listen on just one interface)<br>"
                        + " tcp -t 10000 (sets a timeout of 10,000 milliseconds)<br>"
                        + " ssl -h venus.foo.com (accepts SSL connections instead of plain TCP)" + "</html>");

        _proxyOptions.getDocument().addDocumentListener(_updateListener);
        _proxyOptions
                .setToolTipText("<html>The proxy options used for proxies created by the object adapter.</html>");

        _description.getDocument().addDocumentListener(_updateListener);
        _description.setToolTipText("An optional description for this object adapter");

        JTextField idTextField = (JTextField) _id.getEditor().getEditorComponent();
        idTextField.getDocument().addDocumentListener(_updateListener);
        _id.setToolTipText("Identifies this object adapter within an IceGrid deployment");

        JTextField replicaGroupIdTextField = (JTextField) _replicaGroupId.getEditor().getEditorComponent();
        replicaGroupIdTextField.getDocument().addDocumentListener(_updateListener);
        _replicaGroupId.setToolTipText("Select a replica group");

        _priority.getDocument().addDocumentListener(_updateListener);
        _priority.setToolTipText(
                "The priority of this adapter; see the Ordered load-balancing " + "policy in Replica Groups");

        JTextField publishedEndpointsTextField = (JTextField) _publishedEndpoints.getEditor().getEditorComponent();
        publishedEndpointsTextField.getDocument().addDocumentListener(_updateListener);
        _publishedEndpoints.setToolTipText(
                "Endpoints registered with the IceGrid Registry during the activation of this adapter.");
    }

    //
    // From CommunicatorChildEditor
    //

    @Override
    void writeDescriptor() {
        AdapterDescriptor descriptor = (AdapterDescriptor) getAdapter().getDescriptor();
        descriptor.name = _name.getText().trim();
        descriptor.description = _description.getText();
        descriptor.id = getIdAsString();
        descriptor.replicaGroupId = getReplicaGroupIdAsString();
        descriptor.priority = _priority.getText().trim();
        descriptor.registerProcess = _registerProcess.isSelected();
        descriptor.serverLifetime = _serverLifetime.isSelected();
        descriptor.objects = _objectList;
        descriptor.allocatables = _allocatableList;
    }

    @Override
    boolean isSimpleUpdate() {
        AdapterDescriptor descriptor = (AdapterDescriptor) getAdapter().getDescriptor();

        return descriptor.name.equals(_name.getText().trim());
    }

    @Override
    Communicator.ChildList getChildList() {
        return ((Communicator) _target.getParent()).getAdapters();
    }

    @Override
    protected void appendProperties(DefaultFormBuilder builder) {
        builder.append("Adapter Name");
        builder.append(_name, 3);
        builder.nextLine();

        builder.append("Description");
        builder.nextLine();
        builder.append("");
        builder.nextRow(-2);
        CellConstraints cc = new CellConstraints();
        JScrollPane scrollPane = new JScrollPane(_description);
        builder.add(scrollPane, cc.xywh(builder.getColumn(), builder.getRow(), 3, 3));
        builder.nextRow(2);
        builder.nextLine();

        builder.append("Adapter ID");
        builder.append(_id, 3);
        builder.nextLine();

        builder.append("Replica Group", _replicaGroupId);
        builder.append(_replicaGroupButton);
        builder.nextLine();

        builder.append("Priority");
        builder.append(_priority, 3);
        builder.nextLine();

        builder.append("Endpoints");
        builder.append(_endpoints, 3);
        builder.nextLine();

        builder.append("Published Endpoints");
        builder.append(_publishedEndpoints, 3);
        builder.nextLine();

        builder.append("Proxy Options");
        builder.append(_proxyOptions, 3);
        builder.nextLine();

        builder.append("", _registerProcess);
        builder.nextLine();
        builder.append("", _serverLifetime);
        builder.nextLine();

        builder.append("Well-known Objects");
        builder.nextLine();
        builder.append("");
        builder.nextLine();
        builder.append("");
        builder.nextLine();
        builder.append("");
        builder.nextRow(-6);
        scrollPane = new JScrollPane(_objects);
        builder.add(scrollPane, cc.xywh(builder.getColumn(), builder.getRow(), 3, 7));
        builder.nextRow(6);
        builder.nextLine();

        builder.append("Allocatable Objects");
        builder.nextLine();
        builder.append("");
        builder.nextLine();
        builder.append("");
        builder.nextLine();
        builder.append("");
        builder.nextRow(-6);
        scrollPane = new JScrollPane(_allocatables);
        builder.add(scrollPane, cc.xywh(builder.getColumn(), builder.getRow(), 3, 7));
        builder.nextRow(6);
        builder.nextLine();
    }

    @Override
    protected void buildPropertiesPanel() {
        super.buildPropertiesPanel();
        _propertiesPanel.setName("Adapter Properties");
    }

    @Override
    void postUpdate() {
        //
        // Change enclosing properties after successful update
        //
        String name = _name.getText().trim();
        Adapter adapter = getAdapter();
        if (!name.equals(_oldName)) {
            adapter.removeProperty(_oldName + ".Endpoints");
            adapter.removeProperty(_oldName + ".PublishedEndpoints");
            adapter.removeProperty(_oldName + ".ProxyOptions");
            _oldName = name;
        }

        adapter.setProperty(name + ".Endpoints", _endpoints.getText().trim());

        Object published = _publishedEndpoints.getSelectedItem();
        if (published == PUBLISH_ACTUAL) {
            adapter.removeProperty(name + ".PublishedEndpoints");
        } else {
            adapter.setProperty(name + ".PublishedEndpoints", published.toString().trim());
        }

        if (!_proxyOptions.getText().trim().isEmpty()) {
            adapter.setProperty(name + ".ProxyOptions", _proxyOptions.getText().trim());
        }

        //
        // Set all objects and allocatables properties
        //
        java.util.Map<String, String[]> map = _objects.get();
        for (java.util.Map.Entry<String, String[]> p : map.entrySet()) {
            String key = p.getKey();
            String[] value = p.getValue();
            if (!value[1].equals("")) {
                adapter.setProperty(value[1], key);
            }
        }

        map = _allocatables.get();
        for (java.util.Map.Entry<String, String[]> p : map.entrySet()) {
            String key = p.getKey();
            String[] value = p.getValue();
            if (!value[1].equals("")) {
                adapter.setProperty(value[1], key);
            }
        }
    }

    private void setId(String id) {
        if (id.equals(_defaultAdapterId)) {
            _id.setSelectedItem(DEFAULT_ADAPTER_ID);
        } else {
            _id.setSelectedItem(id);
        }
    }

    private void refreshId() {
        Object id = _id.getSelectedItem();
        _id.setModel(new DefaultComboBoxModel(new Object[] { DEFAULT_ADAPTER_ID }));
        _id.setSelectedItem(id);
    }

    private String getIdAsString() {
        Object obj = _id.getSelectedItem();
        return obj.toString().trim();
    }

    private void setReplicaGroupId(String replicaGroupId) {
        if (replicaGroupId.equals("")) {
            _replicaGroupId.setSelectedItem(NOT_REPLICATED);
        } else {
            ReplicaGroups replicaGroups = getAdapter().getRoot().getReplicaGroups();

            ReplicaGroup replicaGroup = (ReplicaGroup) replicaGroups.findChild(replicaGroupId);

            if (replicaGroup != null) {
                _replicaGroupId.setSelectedItem(replicaGroup);
            } else {
                _replicaGroupId.setSelectedItem(replicaGroupId);
            }
        }
    }

    private String getReplicaGroupIdAsString() {
        Object obj = _replicaGroupId.getSelectedItem();
        if (obj == NOT_REPLICATED) {
            return "";
        } else {
            return obj.toString().trim();
        }
    }

    @Override
    protected boolean validate() {
        //
        // First validate stringified identities
        //
        _objectList = mapToObjectDescriptorSeq(_objects.get());

        if (_objectList == null) {
            return false;
        }

        _allocatableList = mapToObjectDescriptorSeq(_allocatables.get());

        if (_allocatableList == null) {
            return false;
        }

        return check(new String[] { "Adapter Name", _name.getText().trim(), "Adapter ID", getIdAsString(),
                "Endpoints", _endpoints.getText().trim() });
    }

    void show(Adapter adapter) {
        detectUpdates(false);
        _target = adapter;

        AdapterDescriptor descriptor = (AdapterDescriptor) adapter.getDescriptor();

        final Utils.Resolver resolver = adapter.getCoordinator().substitute() ? adapter.getResolver() : null;

        boolean isEditable = resolver == null;

        _oldName = descriptor.name;

        _name.setText(Utils.substitute(descriptor.name, resolver));
        _name.setEditable(isEditable);

        String oaPrefix = descriptor.name + ".";

        _description.setText(Utils.substitute(descriptor.description, resolver));
        _description.setEditable(isEditable);
        _description.setOpaque(isEditable);

        //
        // Need to make control editable & enabled before changing it
        //
        _id.setEnabled(true);
        _id.setEditable(true);
        _defaultAdapterId = adapter.getDefaultAdapterId();
        refreshId();
        if (descriptor.id == null) {
            descriptor.id = _defaultAdapterId;
        }

        setId(Utils.substitute(descriptor.id, resolver));
        _id.setEnabled(isEditable);
        _id.setEditable(isEditable);

        _replicaGroupId.setEnabled(true);
        _replicaGroupId.setEditable(true);

        final ReplicaGroups replicaGroups = adapter.getRoot().getReplicaGroups();
        _replicaGroupId.setModel(replicaGroups.createComboBoxModel(NOT_REPLICATED));

        _replicaGroupId.addItemListener(new ItemListener() {
            @Override
            public void itemStateChanged(ItemEvent e) {
                if (e.getStateChange() == ItemEvent.SELECTED) {
                    Object item = e.getItem();
                    boolean enabled = (item instanceof ReplicaGroup);
                    if (!enabled && item != NOT_REPLICATED) {
                        if (resolver != null) {
                            String replicaGroupId = resolver.substitute(item.toString().trim());
                            enabled = (replicaGroups.findChild(replicaGroupId) != null);
                        }
                    }
                    _replicaGroupButton.setEnabled(enabled);
                }
            }
        });

        setReplicaGroupId(Utils.substitute(descriptor.replicaGroupId, resolver));

        _replicaGroupId.setEnabled(isEditable);
        _replicaGroupId.setEditable(isEditable);

        _priority.setText(Utils.substitute(descriptor.priority, resolver));
        _priority.setEditable(isEditable);

        String endpoints = Utils.substitute(adapter.getProperty(oaPrefix + "Endpoints"), resolver);

        if (adapter.isEphemeral() && (endpoints == null || endpoints.equals(""))) {
            _endpoints.setText("default");
        } else {
            _endpoints.setText(endpoints);
        }
        _endpoints.setEditable(isEditable);

        _publishedEndpoints.setEnabled(true);
        _publishedEndpoints.setEditable(true);
        String published = Utils.substitute(adapter.getProperty(oaPrefix + "PublishedEndpoints"), resolver);
        if (published == null || published.equals("")) {
            _publishedEndpoints.setSelectedItem(PUBLISH_ACTUAL);
        } else {
            _publishedEndpoints.setSelectedItem(published);
        }
        _publishedEndpoints.setEnabled(isEditable);
        _publishedEndpoints.setEditable(isEditable);

        _proxyOptions.setEnabled(true);
        _proxyOptions.setEditable(true);
        _proxyOptions.setText(Utils.substitute(adapter.getProperty(oaPrefix + "ProxyOptions"), resolver));

        //
        // Objects
        //
        _objects.set(objectDescriptorSeqToMap(descriptor.objects), resolver, isEditable);
        _allocatables.set(objectDescriptorSeqToMap(descriptor.allocatables), resolver, isEditable);

        _registerProcess.setSelected(descriptor.registerProcess);
        _registerProcess.setEnabled(isEditable);

        _serverLifetime.setSelected(descriptor.serverLifetime);
        _serverLifetime.setEnabled(isEditable);

        _applyButton.setEnabled(adapter.isEphemeral());
        _discardButton.setEnabled(adapter.isEphemeral());
        detectUpdates(true);

        if (adapter.isEphemeral()) {
            updated();
        }
    }

    Adapter getAdapter() {
        return (Adapter) _target;
    }

    private java.util.Map<String, String[]> objectDescriptorSeqToMap(java.util.List<ObjectDescriptor> objects) {
        java.util.Map<String, String[]> result = new java.util.TreeMap<>();
        for (ObjectDescriptor p : objects) {
            String k = com.zeroc.Ice.Util.identityToString(p.id);
            result.put(k, new String[] { p.type, getAdapter().lookupPropertyValue(k), p.proxyOptions });
        }
        return result;
    }

    private java.util.LinkedList<ObjectDescriptor> mapToObjectDescriptorSeq(java.util.Map<String, String[]> map) {
        String badIdentities = "";
        java.util.LinkedList<ObjectDescriptor> result = new java.util.LinkedList<>();
        for (java.util.Map.Entry<String, String[]> p : map.entrySet()) {
            try {
                com.zeroc.Ice.Identity id = com.zeroc.Ice.Util.stringToIdentity(p.getKey());
                String[] val = p.getValue();
                result.add(new ObjectDescriptor(id, val[0], val[2]));
            } catch (com.zeroc.Ice.IdentityParseException ex) {
                badIdentities += "- " + p.getKey() + "\n";
            }
        }

        if (!badIdentities.equals("")) {
            JOptionPane.showMessageDialog(_target.getCoordinator().getMainFrame(),
                    "The following identities could not be parsed properly:\n" + badIdentities, "Validation failed",
                    JOptionPane.ERROR_MESSAGE);

            return null;
        } else {
            return result;
        }
    }

    private String _defaultAdapterId = "";

    private final Object DEFAULT_ADAPTER_ID = new Object() {
        @Override
        public String toString() {
            return _defaultAdapterId;
        }
    };

    private String _oldName;

    private JTextField _name = new JTextField(20);
    private JTextArea _description = new JTextArea(3, 20);

    private JComboBox _id = new JComboBox(new Object[] { DEFAULT_ADAPTER_ID });
    private JComboBox _replicaGroupId = new JComboBox();
    private JButton _replicaGroupButton;

    private JTextField _priority = new JTextField(20);

    private JTextField _endpoints = new JTextField(20);
    private JComboBox _publishedEndpoints = new JComboBox(new Object[] { PUBLISH_ACTUAL });
    private JTextField _proxyOptions = new JTextField(20);

    private JTextField _currentStatus = new JTextField(20);
    private JTextField _currentEndpoints = new JTextField(20);

    private JCheckBox _registerProcess;
    private JCheckBox _serverLifetime;

    private ArrayMapField _objects;
    private java.util.LinkedList<ObjectDescriptor> _objectList;
    private ArrayMapField _allocatables;
    private java.util.LinkedList<ObjectDescriptor> _allocatableList;

    static private final Object PUBLISH_ACTUAL = new Object() {
        @Override
        public String toString() {
            return "Actual endpoints";
        }
    };

    static private final Object NOT_REPLICATED = new Object() {
        @Override
        public String toString() {
            return "Does not belong to a replica group";
        }
    };
}