0003019: Add Registration Screen when Registering a Remote Node

symmetric-core/src/main/java/org/jumpmind/symmetric/ext/INodeRegistrationListener.java

@@ -0,0 +1,18 @@
+package org.jumpmind.symmetric.ext;
+
+import org.jumpmind.extension.IExtensionPoint;
+
+public interface INodeRegistrationListener extends IExtensionPoint {
+
+    public void registrationUrlUpdated(String url);
+
+    public void registrationNextAttemptUpdated(int seconds);
+
+    public void registrationStarting();
+
+    public void registrationFailed(String message);
+
+    public void registrationSyncTriggers();
+
+    public void registrationSuccessful();
+}

symmetric-core/src/main/java/org/jumpmind/symmetric/service/IRegistrationService.java

@@ -1,37 +1,37 @@
-/**
- * Licensed to JumpMind Inc under one or more contributor
- * license agreements.  See the NOTICE file distributed
- * with this work for additional information regarding
- * copyright ownership.  JumpMind Inc licenses this file
- * to you under the GNU General Public License, version 3.0 (GPLv3)
- * (the "License"); you may not use this file except in compliance
- * with the License.
- *
- * You should have received a copy of the GNU General Public License,
- * version 3.0 (GPLv3) along with this library; if not, see
- * <http://www.gnu.org/licenses/>.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-package org.jumpmind.symmetric.service;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.util.List;
-
-import org.jumpmind.symmetric.model.Node;
-import org.jumpmind.symmetric.model.RegistrationRequest;
-
+/**
+ * Licensed to JumpMind Inc under one or more contributor
+ * license agreements.  See the NOTICE file distributed
+ * with this work for additional information regarding
+ * copyright ownership.  JumpMind Inc licenses this file
+ * to you under the GNU General Public License, version 3.0 (GPLv3)
+ * (the "License"); you may not use this file except in compliance
+ * with the License.
+ *
+ * You should have received a copy of the GNU General Public License,
+ * version 3.0 (GPLv3) along with this library; if not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.jumpmind.symmetric.service;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.List;
+
+import org.jumpmind.symmetric.model.Node;
+import org.jumpmind.symmetric.model.RegistrationRequest;
+
 /**
  * This service provides an API that deals with {@link Node} registration
  */
-public interface IRegistrationService {
+public interface IRegistrationService {
 
 	/**
 	 * Register a "Pull Only" node.  This type of node has no Symmetric configuration and can only be used to PULL data from another node. 
@@ -51,8 +51,8 @@ public interface IRegistrationService {
      * @param isRequestedRegistration
      *            An indicator that registration has been requested by the
      *            remote client
-     */
-    public boolean registerNode(Node node, String remoteHost, String remoteAddress, OutputStream out, boolean isRequestedRegistration) throws IOException;
+     */
+    public boolean registerNode(Node node, String remoteHost, String remoteAddress, OutputStream out, boolean isRequestedRegistration) throws IOException;
 
     /**
      * Register a node for the given group name and external id if the
@@ -63,64 +63,71 @@ public interface IRegistrationService {
      *            remote client
      */
     public boolean registerNode(Node node, OutputStream out, boolean isRequestedRegistration) throws IOException;
-
-    /**
-     * Open registration for a single new node given a node group (f.e.,
-     * "STORE") and external ID (f.e., "00001"). The unique node ID and password
-     * are generated and stored in the node and node_security tables with the
-     * registration_enabled flag turned on. The next node to try registering for
-     * this node group and external ID will be given this information.
-     * @return the node id
-     */
-    public String openRegistration(String nodeGroupId, String externalId);
-
+
+    /**
+     * Open registration for a single new node given a node group (f.e.,
+     * "STORE") and external ID (f.e., "00001"). The unique node ID and password
+     * are generated and stored in the node and node_security tables with the
+     * registration_enabled flag turned on. The next node to try registering for
+     * this node group and external ID will be given this information.
+     * @return the node id
+     */
+    public String openRegistration(String nodeGroupId, String externalId);
+
     public String openRegistration(String nodeGroup, String externalId, String remoteHost, String remoteAddress);
 
     public String openRegistration(Node node);
 
-    public boolean isRegistrationOpen(String nodeGroupId, String externalId);
-
-    /**
-     * Re-open registration for a single node that already exists in the
-     * database. A new password is generated and the registration_enabled flag
-     * is turned on. The next node to try registering for this node group and
-     * external ID will be given this information.
-     */
-    public void reOpenRegistration(String nodeId);
-
-    /**
-     * Mark the passed in node as registered in node_security
-     * @param nodeId is the node that has just finished 'successfully' registering
-     */
-    public void markNodeAsRegistered(String nodeId);
-
-    public boolean isAutoRegistration();
-
-    /**
-     * Client method which attempts to register with the registration.url to
-     * pull configuration if the node has not already been registered. If the
-     * registration server cannot be reach this method will continue to try with
-     * random sleep periods up to one minute up until the registration succeeds
-     * or the maximum number of attempts has been reached.
-     */
+    public boolean isRegistrationOpen(String nodeGroupId, String externalId);
+
+    /**
+     * Re-open registration for a single node that already exists in the
+     * database. A new password is generated and the registration_enabled flag
+     * is turned on. The next node to try registering for this node group and
+     * external ID will be given this information.
+     */
+    public void reOpenRegistration(String nodeId);
+
+    /**
+     * Mark the passed in node as registered in node_security
+     * @param nodeId is the node that has just finished 'successfully' registering
+     */
+    public void markNodeAsRegistered(String nodeId);
+
+    public boolean isAutoRegistration();
+
+    /**
+     * Client method which attempts to register with the registration.url to
+     * pull configuration if the node has not already been registered. If the
+     * registration server cannot be reach this method will continue to try with
+     * random sleep periods up to one minute up until the registration succeeds
+     * or the maximum number of attempts has been reached.
+     */
     public void registerWithServer();
 
+    /**
+     * Client method which attempts to register with the registration.url to
+     * pull configuration if the node has not already been registered. 
+     * Returns true if registered successfully
+     */
+    public boolean attemptToRegisterWithServer(int maxNumberOfAttempts);
+
     public List<RegistrationRequest> getRegistrationRequests(boolean includeNodesWithOpenRegistrations);
 
     public boolean deleteRegistrationRequest(RegistrationRequest request);
 
-    public void saveRegistrationRequest(RegistrationRequest request);
-
-    public boolean isRegisteredWithServer();
-
-    /**
-     * Add an entry to the registation_redirect table so that if a node tries to register here.  It will be redirected to the correct node.
-     */
-    public void saveRegistrationRedirect(String externalIdToRedirect, String nodeIdToRedirectTo);   
-
-    public String getRedirectionUrlFor(String externalId);
-
+    public void saveRegistrationRequest(RegistrationRequest request);
+
+    public boolean isRegisteredWithServer();
+
+    /**
+     * Add an entry to the registation_redirect table so that if a node tries to register here.  It will be redirected to the correct node.
+     */
+    public void saveRegistrationRedirect(String externalIdToRedirect, String nodeIdToRedirectTo);   
+
+    public String getRedirectionUrlFor(String externalId);
+
     public void requestNodeCopy();
-
-
+
+
 }

symmetric-core/src/main/java/org/jumpmind/symmetric/service/impl/DataLoaderService.java

@@ -61,6 +61,7 @@
 import org.jumpmind.symmetric.common.Constants;
 import org.jumpmind.symmetric.common.ErrorConstants;
 import org.jumpmind.symmetric.common.ParameterConstants;
+import org.jumpmind.symmetric.ext.INodeRegistrationListener;
 import org.jumpmind.symmetric.io.IoConstants;
 import org.jumpmind.symmetric.io.data.Batch;
 import org.jumpmind.symmetric.io.data.Batch.BatchType;
@@ -273,6 +274,12 @@ public void loadDataFromPull(Node remote, RemoteNodeStatus status) throws IOExce
                 transport = transportManager.getRegisterTransport(local,
                         parameterService.getRegistrationUrl());
                 log.info("Using registration URL of {}", transport.getUrl());
+
+                List<INodeRegistrationListener> registrationListeners = extensionService.getExtensionPointList(INodeRegistrationListener.class);
+                for (INodeRegistrationListener l : registrationListeners) {
+                    l.registrationUrlUpdated(transport.getUrl());
+                }
+
                 remote = new Node();
                 remote.setSyncUrl(parameterService.getRegistrationUrl());
                 isRegisterTransport = true;