aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/vaadin/ui/ConnectorTracker.java
diff options
context:
space:
mode:
authorArtur Signell <artur@vaadin.com>2012-08-13 18:34:33 +0300
committerArtur Signell <artur@vaadin.com>2012-08-13 19:18:33 +0300
commite85d933b25cc3c5cc85eb7eb4b13b950fd8e1569 (patch)
tree9ab6f13f7188cab44bbd979b1cf620f15328a03f /src/com/vaadin/ui/ConnectorTracker.java
parent14dd4d0b28c76eb994b181a4570f3adec53342e6 (diff)
downloadvaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.tar.gz
vaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.zip
Moved server files to a server src folder (#9299)
Diffstat (limited to 'src/com/vaadin/ui/ConnectorTracker.java')
-rw-r--r--src/com/vaadin/ui/ConnectorTracker.java320
1 files changed, 0 insertions, 320 deletions
diff --git a/src/com/vaadin/ui/ConnectorTracker.java b/src/com/vaadin/ui/ConnectorTracker.java
deleted file mode 100644
index e3d1bf86db..0000000000
--- a/src/com/vaadin/ui/ConnectorTracker.java
+++ /dev/null
@@ -1,320 +0,0 @@
-/*
-@VaadinApache2LicenseForJavaFiles@
- */
-package com.vaadin.ui;
-
-import java.io.Serializable;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.Set;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-import com.vaadin.terminal.AbstractClientConnector;
-import com.vaadin.terminal.gwt.client.ServerConnector;
-import com.vaadin.terminal.gwt.server.ClientConnector;
-
-/**
- * A class which takes care of book keeping of {@link ClientConnector}s for a
- * Root.
- * <p>
- * Provides {@link #getConnector(String)} which can be used to lookup a
- * connector from its id. This is for framework use only and should not be
- * needed in applications.
- * </p>
- * <p>
- * Tracks which {@link ClientConnector}s are dirty so they can be updated to the
- * client when the following response is sent. A connector is dirty when an
- * operation has been performed on it on the server and as a result of this
- * operation new information needs to be sent to its {@link ServerConnector}.
- * </p>
- *
- * @author Vaadin Ltd
- * @version @VERSION@
- * @since 7.0.0
- *
- */
-public class ConnectorTracker implements Serializable {
-
- private final HashMap<String, ClientConnector> connectorIdToConnector = new HashMap<String, ClientConnector>();
- private Set<ClientConnector> dirtyConnectors = new HashSet<ClientConnector>();
-
- private Root root;
-
- /**
- * Gets a logger for this class
- *
- * @return A logger instance for logging within this class
- *
- */
- public static Logger getLogger() {
- return Logger.getLogger(ConnectorTracker.class.getName());
- }
-
- /**
- * Creates a new ConnectorTracker for the given root. A tracker is always
- * attached to a root and the root cannot be changed during the lifetime of
- * a {@link ConnectorTracker}.
- *
- * @param root
- * The root to attach to. Cannot be null.
- */
- public ConnectorTracker(Root root) {
- this.root = root;
- }
-
- /**
- * Register the given connector.
- * <p>
- * The lookup method {@link #getConnector(String)} only returns registered
- * connectors.
- * </p>
- *
- * @param connector
- * The connector to register.
- */
- public void registerConnector(ClientConnector connector) {
- String connectorId = connector.getConnectorId();
- ClientConnector previouslyRegistered = connectorIdToConnector
- .get(connectorId);
- if (previouslyRegistered == null) {
- connectorIdToConnector.put(connectorId, connector);
- getLogger().fine(
- "Registered " + connector.getClass().getSimpleName() + " ("
- + connectorId + ")");
- } else if (previouslyRegistered != connector) {
- throw new RuntimeException("A connector with id " + connectorId
- + " is already registered!");
- } else {
- getLogger().warning(
- "An already registered connector was registered again: "
- + connector.getClass().getSimpleName() + " ("
- + connectorId + ")");
- }
-
- }
-
- /**
- * Unregister the given connector.
- *
- * <p>
- * The lookup method {@link #getConnector(String)} only returns registered
- * connectors.
- * </p>
- *
- * @param connector
- * The connector to unregister
- */
- public void unregisterConnector(ClientConnector connector) {
- String connectorId = connector.getConnectorId();
- if (!connectorIdToConnector.containsKey(connectorId)) {
- getLogger().warning(
- "Tried to unregister "
- + connector.getClass().getSimpleName() + " ("
- + connectorId + ") which is not registered");
- return;
- }
- if (connectorIdToConnector.get(connectorId) != connector) {
- throw new RuntimeException("The given connector with id "
- + connectorId
- + " is not the one that was registered for that id");
- }
-
- getLogger().fine(
- "Unregistered " + connector.getClass().getSimpleName() + " ("
- + connectorId + ")");
- connectorIdToConnector.remove(connectorId);
- }
-
- /**
- * Gets a connector by its id.
- *
- * @param connectorId
- * The connector id to look for
- * @return The connector with the given id or null if no connector has the
- * given id
- */
- public ClientConnector getConnector(String connectorId) {
- return connectorIdToConnector.get(connectorId);
- }
-
- /**
- * Cleans the connector map from all connectors that are no longer attached
- * to the application. This should only be called by the framework.
- */
- public void cleanConnectorMap() {
- // remove detached components from paintableIdMap so they
- // can be GC'ed
- Iterator<String> iterator = connectorIdToConnector.keySet().iterator();
-
- while (iterator.hasNext()) {
- String connectorId = iterator.next();
- ClientConnector connector = connectorIdToConnector.get(connectorId);
- if (getRootForConnector(connector) != root) {
- // If connector is no longer part of this root,
- // remove it from the map. If it is re-attached to the
- // application at some point it will be re-added through
- // registerConnector(connector)
-
- // This code should never be called as cleanup should take place
- // in detach()
- getLogger()
- .warning(
- "cleanConnectorMap unregistered connector "
- + getConnectorAndParentInfo(connector)
- + "). This should have been done when the connector was detached.");
- iterator.remove();
- }
- }
-
- }
-
- /**
- * Finds the root that the connector is attached to.
- *
- * @param connector
- * The connector to lookup
- * @return The root the connector is attached to or null if it is not
- * attached to any root.
- */
- private Root getRootForConnector(ClientConnector connector) {
- if (connector == null) {
- return null;
- }
- if (connector instanceof Component) {
- return ((Component) connector).getRoot();
- }
-
- return getRootForConnector(connector.getParent());
- }
-
- /**
- * Mark the connector as dirty.
- *
- * @see #getDirtyConnectors()
- *
- * @param connector
- * The connector that should be marked clean.
- */
- public void markDirty(ClientConnector connector) {
- if (getLogger().isLoggable(Level.FINE)) {
- if (!dirtyConnectors.contains(connector)) {
- getLogger().fine(
- getConnectorAndParentInfo(connector) + " "
- + "is now dirty");
- }
- }
-
- dirtyConnectors.add(connector);
- }
-
- /**
- * Mark the connector as clean.
- *
- * @param connector
- * The connector that should be marked clean.
- */
- public void markClean(ClientConnector connector) {
- if (getLogger().isLoggable(Level.FINE)) {
- if (dirtyConnectors.contains(connector)) {
- getLogger().fine(
- getConnectorAndParentInfo(connector) + " "
- + "is no longer dirty");
- }
- }
-
- dirtyConnectors.remove(connector);
- }
-
- /**
- * Returns {@link #getConnectorString(ClientConnector)} for the connector
- * and its parent (if it has a parent).
- *
- * @param connector
- * The connector
- * @return A string describing the connector and its parent
- */
- private String getConnectorAndParentInfo(ClientConnector connector) {
- String message = getConnectorString(connector);
- if (connector.getParent() != null) {
- message += " (parent: " + getConnectorString(connector.getParent())
- + ")";
- }
- return message;
- }
-
- /**
- * Returns a string with the connector name and id. Useful mostly for
- * debugging and logging.
- *
- * @param connector
- * The connector
- * @return A string that describes the connector
- */
- private String getConnectorString(ClientConnector connector) {
- if (connector == null) {
- return "(null)";
- }
-
- String connectorId;
- try {
- connectorId = connector.getConnectorId();
- } catch (RuntimeException e) {
- // This happens if the connector is not attached to the application.
- // SHOULD not happen in this case but theoretically can.
- connectorId = "@" + Integer.toHexString(connector.hashCode());
- }
- return connector.getClass().getName() + "(" + connectorId + ")";
- }
-
- /**
- * Mark all connectors in this root as dirty.
- */
- public void markAllConnectorsDirty() {
- markConnectorsDirtyRecursively(root);
- getLogger().fine("All connectors are now dirty");
- }
-
- /**
- * Mark all connectors in this root as clean.
- */
- public void markAllConnectorsClean() {
- dirtyConnectors.clear();
- getLogger().fine("All connectors are now clean");
- }
-
- /**
- * Marks all visible connectors dirty, starting from the given connector and
- * going downwards in the hierarchy.
- *
- * @param c
- * The component to start iterating downwards from
- */
- private void markConnectorsDirtyRecursively(ClientConnector c) {
- if (c instanceof Component && !((Component) c).isVisible()) {
- return;
- }
- markDirty(c);
- for (ClientConnector child : AbstractClientConnector
- .getAllChildrenIterable(c)) {
- markConnectorsDirtyRecursively(child);
- }
- }
-
- /**
- * Returns a collection of all connectors which have been marked as dirty.
- * <p>
- * The state and pending RPC calls for dirty connectors are sent to the
- * client in the following request.
- * </p>
- *
- * @return A collection of all dirty connectors for this root. This list may
- * contain invisible connectors.
- */
- public Collection<ClientConnector> getDirtyConnectors() {
- return dirtyConnectors;
- }
-
-}