microsoft · tracyboehrer · Feb 10, 2021 · Feb 10, 2021
diff --git a/...bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/Application.java b/...bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/Application.java
@@ -3,38 +3,62 @@
 
 package com.microsoft.bot.sample.authentication;
 
+import com.microsoft.bot.builder.Bot;
+import com.microsoft.bot.builder.ConversationState;
+import com.microsoft.bot.builder.UserState;
+import com.microsoft.bot.dialogs.Dialog;
 import com.microsoft.bot.integration.AdapterWithErrorHandler;
 import com.microsoft.bot.integration.BotFrameworkHttpAdapter;
 import com.microsoft.bot.integration.Configuration;
 import com.microsoft.bot.integration.spring.BotController;
 import com.microsoft.bot.integration.spring.BotDependencyConfiguration;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 
-/**
- * This is the starting point of the Sprint Boot Bot application.
- *
- * This class also provides overrides for dependency injections. A class that
- * extends the {@link com.microsoft.bot.builder.Bot} interface should be
- * annotated with @Component.
- *
- * @see RichCardsBot
- */
+//
+// This is the starting point of the Sprint Boot Bot application.
+//
 @SpringBootApplication
 
 // Use the default BotController to receive incoming Channel messages. A custom
 // controller could be used by eliminating this import and creating a new
-// RestController.
+// org.springframework.web.bind.annotation.RestController.
 // The default controller is created by the Spring Boot container using
 // dependency injection. The default route is /api/messages.
 @Import({BotController.class})
 
+/**
+ * This class extends the BotDependencyConfiguration which provides the default
+ * implementations for a Bot application.  The Application class should
+ * override methods in order to provide custom implementations.
+ */
 public class Application extends BotDependencyConfiguration {
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
 
+    /**
+     * Returns the Bot for this application.
+     *
+     * <p>
+     *     The @Component annotation could be used on the Bot class instead of this method
+     *     with the @Bean annotation.
+     * </p>
+     *
+     * @return The Bot implementation for this application.
+     */
+    @Bean
+    public Bot getBot(
+        Configuration configuration,
+        ConversationState conversationState,
+        UserState userState,
+        MainDialog dialog
+    ) {
+        return new AuthBot(conversationState, userState, new MainDialog(configuration));
+    }
+
     /**
      * Returns a custom Adapter that provides error handling.
      *

diff --git a/.../18.bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/AuthBot.java b/.../18.bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/AuthBot.java
@@ -13,16 +13,10 @@
 import com.microsoft.bot.dialogs.Dialog;
 import com.microsoft.bot.schema.ChannelAccount;
 
-import org.springframework.stereotype.Component;
 import com.codepoetics.protonpack.collectors.CompletableFutures;
 import com.microsoft.bot.schema.Activity;
 import org.apache.commons.lang3.StringUtils;
 
-
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-@Component
 public class AuthBot extends DialogBot<MainDialog> {
 
     public AuthBot(ConversationState conversationState, UserState userState, MainDialog dialog) {
@@ -49,7 +43,7 @@ protected CompletableFuture<Void> onMembersAdded(
     @Override
     protected CompletableFuture<Void> onTokenResponseEvent(TurnContext turnContext) {
         // Run the Dialog with the new Token Response Event Activity.
-         return Dialog.run(dialog, turnContext, conversationState.createProperty("DialogState"));
+        return Dialog.run(dialog, turnContext, conversationState.createProperty("DialogState"));
     }
 
 }
diff --git a/...8.bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/DialogBot.java b/...8.bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/DialogBot.java
@@ -12,15 +12,16 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * This Bot implementation can run any type of Dialog. The use of type parameterization is to
- * allows multiple different bots to be run at different endpoints within the same project. This
- * can be achieved by defining distinct Controller types each with dependency on distinct IBot
- * types, this way ASP Dependency Injection can glue everything together without ambiguity. The
- * ConversationState is used by the Dialog system. The UserState isn't, however, it might have
- * been used in a Dialog implementation, and the requirement is that all BotState objects are
- * saved at the end of a turn.
+ * This Bot implementation can run any type of Dialog. The use of type parameterization is to allows
+ * multiple different bots to be run at different endpoints within the same project. This can be
+ * achieved by defining distinct Controller types each with dependency on distinct IBot types, this
+ * way ASP Dependency Injection can glue everything together without ambiguity. The
+ * ConversationState is used by the Dialog system. The UserState isn't, however, it might have been
+ * used in a Dialog implementation, and the requirement is that all BotState objects are saved at
+ * the end of a turn.
  */
 public class DialogBot<T extends Dialog> extends ActivityHandler {
+
     protected Dialog dialog;
     protected BotState conversationState;
     protected BotState userState;

diff --git a/...ot-authentication/src/main/java/com/microsoft/bot/sample/authentication/LogoutDialog.java b/...ot-authentication/src/main/java/com/microsoft/bot/sample/authentication/LogoutDialog.java
@@ -23,8 +23,10 @@ public LogoutDialog(String id, String connectionName) {
 
 
     @Override
-    protected CompletableFuture<DialogTurnResult> onBeginDialog(DialogContext innerDc, Object options) {
-        DialogTurnResult result =  interrupt(innerDc).join();
+    protected CompletableFuture<DialogTurnResult> onBeginDialog(
+        DialogContext innerDc, Object options
+    ) {
+        DialogTurnResult result = interrupt(innerDc).join();
         if (result != null) {
             return CompletableFuture.completedFuture(result);
         }
@@ -34,7 +36,7 @@ protected CompletableFuture<DialogTurnResult> onBeginDialog(DialogContext innerD
 
     @Override
     protected CompletableFuture<DialogTurnResult> onContinueDialog(DialogContext innerDc) {
-        DialogTurnResult result =  interrupt(innerDc).join();
+        DialogTurnResult result = interrupt(innerDc).join();
         if (result != null) {
             return CompletableFuture.completedFuture(result);
         }
@@ -48,10 +50,12 @@ private CompletableFuture<DialogTurnResult> interrupt(DialogContext innerDc) {
 
             if (text.equals("logout")) {
                 // The bot adapter encapsulates the authentication processes.
-                BotFrameworkAdapter botAdapter = (BotFrameworkAdapter) innerDc.getContext().getAdapter();
+                BotFrameworkAdapter botAdapter = (BotFrameworkAdapter) innerDc.getContext()
+                    .getAdapter();
                 botAdapter.signOutUser(innerDc.getContext(), getConnectionName(), null).join();
-                innerDc.getContext().sendActivity(MessageFactory.text("You have been signed out.")).join();
-                return  innerDc.cancelAllDialogs();
+                innerDc.getContext().sendActivity(MessageFactory.text("You have been signed out."))
+                    .join();
+                return innerDc.cancelAllDialogs();
             }
         }
 

diff --git a/....bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/MainDialog.java b/....bot-authentication/src/main/java/com/microsoft/bot/sample/authentication/MainDialog.java
@@ -18,10 +18,7 @@
 import com.microsoft.bot.integration.Configuration;
 import com.microsoft.bot.schema.TokenResponse;
 
-import org.springframework.stereotype.Component;
-
-@Component
- class MainDialog extends LogoutDialog {
+class MainDialog extends LogoutDialog {
 
     public MainDialog(Configuration configuration) {
         super("MainDialog", configuration.getProperty("ConnectionName"));
@@ -51,28 +48,31 @@ public MainDialog(Configuration configuration) {
     }
 
     private CompletableFuture<DialogTurnResult> promptStep(WaterfallStepContext stepContext) {
-        return  stepContext.beginDialog("OAuthPrompt", null);
+        return stepContext.beginDialog("OAuthPrompt", null);
     }
 
     private CompletableFuture<DialogTurnResult> loginStep(WaterfallStepContext stepContext) {
         // Get the token from the previous step. Note that we could also have gotten the
         // token directly from the prompt itself. There instanceof an example of this in the next method.
-        TokenResponse tokenResponse = (TokenResponse)stepContext.getResult();
+        TokenResponse tokenResponse = (TokenResponse) stepContext.getResult();
         if (tokenResponse != null) {
             stepContext.getContext().sendActivity(MessageFactory.text("You are now logged in."));
             PromptOptions options = new PromptOptions();
             options.setPrompt(MessageFactory.text("Would you like to view your token?"));
             return stepContext.prompt("ConfirmPrompt", options);
         }
 
-         stepContext.getContext().sendActivity(MessageFactory.text("Login was not successful please try again."));
-        return  stepContext.endDialog();
+        stepContext.getContext()
+            .sendActivity(MessageFactory.text("Login was not successful please try again."));
+        return stepContext.endDialog();
     }
 
-    private CompletableFuture<DialogTurnResult> displayTokenPhase1(WaterfallStepContext stepContext) {
-         stepContext.getContext().sendActivity(MessageFactory.text("Thank you."));
+    private CompletableFuture<DialogTurnResult> displayTokenPhase1(
+        WaterfallStepContext stepContext
+    ) {
+        stepContext.getContext().sendActivity(MessageFactory.text("Thank you."));
 
-        boolean result = (boolean)stepContext.getResult();
+        boolean result = (boolean) stepContext.getResult();
         if (result) {
             // Call the prompt again because we need the token. The reasons for this are:
             // 1. If the user instanceof already logged in we do not need to store the token locally in the bot and worry
@@ -82,21 +82,23 @@ private CompletableFuture<DialogTurnResult> displayTokenPhase1(WaterfallStepCont
             //
             // There instanceof no reason to store the token locally in the bot because we can always just call
             // the OAuth prompt to get the token or get a new token if needed.
-            return  stepContext.beginDialog("OAuthPrompt");
+            return stepContext.beginDialog("OAuthPrompt");
         }
 
-        return  stepContext.endDialog();
+        return stepContext.endDialog();
     }
 
-    private CompletableFuture<DialogTurnResult> displayTokenPhase2(WaterfallStepContext stepContext) {
-        TokenResponse tokenResponse = (TokenResponse)stepContext.getResult();
+    private CompletableFuture<DialogTurnResult> displayTokenPhase2(
+        WaterfallStepContext stepContext
+    ) {
+        TokenResponse tokenResponse = (TokenResponse) stepContext.getResult();
         if (tokenResponse != null) {
-             stepContext.getContext().sendActivity(MessageFactory.text(
-                 String.format("Here instanceof your token %s", tokenResponse.getToken()
-                 )));
+            stepContext.getContext().sendActivity(MessageFactory.text(
+                String.format("Here instanceof your token %s", tokenResponse.getToken()
+                )));
         }
 
-        return  stepContext.endDialog();
+        return stepContext.endDialog();
     }
 }