Add a way to customize behavior on failure during a bootstrap session

richzzp · Jul 19, 2019 · 22fbc99 · 22fbc99
1 parent f8cb8d2
commit 22fbc99
Show file tree

Hide file tree

Showing 5 changed files with 198 additions and 52 deletions.
diff --git a/...-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/BootstrapFailureCause.java b/...-server-core/src/main/java/org/eclipse/leshan/server/bootstrap/BootstrapFailureCause.java
@@ -46,9 +46,5 @@ public enum BootstrapFailureCause {
     /**
      * 'Bootstrap Finish' message count not be sent to the device
      */
-    SEND_FINISH_FAILED,
-    /**
-     * The device responded to 'Bootstrap Finish' with an error code
-     */
-    FINISHED_WITH_ERROR
+    FINISH_FAILED,
 }
diff --git a/...erver-core/src/main/java/org/eclipse/leshan/server/bootstrap/BootstrapSessionManager.java b/...erver-core/src/main/java/org/eclipse/leshan/server/bootstrap/BootstrapSessionManager.java
@@ -15,7 +15,6 @@
  *******************************************************************************/
 package org.eclipse.leshan.server.bootstrap;
 
-import org.eclipse.leshan.core.request.DownlinkRequest;
 import org.eclipse.leshan.core.request.Identity;
 import org.eclipse.leshan.core.request.LwM2mRequest;
 import org.eclipse.leshan.core.response.LwM2mResponse;
@@ -32,6 +31,29 @@
  */
 public interface BootstrapSessionManager {
 
+    public enum BootstrapPolicy {
+        /**
+         * Continue bootstrap session ignoring failure.
+         */
+        CONTINUE,
+        /**
+         * Try to resend the failed request.
+         */
+        RETRY,
+        /**
+         * Retry the bootstrap session from the beginning generally.
+         */
+        RETRYALL,
+        /**
+         * Stop to try to write bootstrap config and directly send a "Bootstrap Finished" request.
+         */
+        SEND_FINISHED,
+        /**
+         * Stop the bootstrap session. The session is considered as failure.
+         */
+        STOP
+    }
+
     /**
      * Starts a bootstrapping session for an endpoint. In particular, this is responsible for authorizing the endpoint
      * if applicable
@@ -55,16 +77,20 @@ public interface BootstrapSessionManager {
      * 
      * @param request The request for which we get a error response.
      * @param response The response received.
+     * 
+     * @return a {@link BootstrapPolicy} given the way to continue the bootstrap session.
      */
-    public void onResponseError(LwM2mRequest<? extends LwM2mResponse> request, LwM2mResponse response);
+    public BootstrapPolicy onResponseError(LwM2mRequest<? extends LwM2mResponse> request, LwM2mResponse response);
 
     /**
      * Called when a request failed to be sent.
      * 
      * @param request The request which failed to be sent.
      * @param exception The cause of the failure. Can be null.
+     * 
+     * @return a {@link BootstrapPolicy} given the way to continue the bootstrap session.
      */
-    public void onRequestFailure(LwM2mRequest<? extends LwM2mResponse> request, Throwable cause);
+    public BootstrapPolicy onRequestFailure(LwM2mRequest<? extends LwM2mResponse> request, Throwable cause);
 
     /**
      * Performs any housekeeping related to the successful ending of a Bootstrapping session.
@@ -78,8 +104,6 @@ public interface BootstrapSessionManager {
      * 
      * @param bsSession the bootstrap session which failed.
      * @param cause why the bootstrap failed.
-     * @param request last request sent to the device. Can be null.
      */
-    public void failed(BootstrapSession bsSession, BootstrapFailureCause cause,
-            DownlinkRequest<? extends LwM2mResponse> request);
+    public void failed(BootstrapSession bsSession, BootstrapFailureCause cause);
 }