address comment

Author: rpdome

common/src/main/java/com/microsoft/identity/common/adal/internal/BatteryOptimizationStatus.kt

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+package com.microsoft.identity.common.adal.internal
+
+/**
+ * Enum representing the battery optimization status of the application.
+ */
+enum class BatteryOptimizationStatus {
+    OptOut,
+    NotOptOut,
+    CannotRetrievePowerManager,
+    UnknownError
+}

common/src/main/java/com/microsoft/identity/common/adal/internal/DeviceDozeModeStatus.kt

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+package com.microsoft.identity.common.adal.internal
+
+enum class DeviceDozeModeStatus {
+    NotInDozeMode,
+    Idle,
+    LightIdle,
+    CannotRetrievePowerManager,
+    UnknownError
+}

common/src/main/java/com/microsoft/identity/common/adal/internal/PowerManagerWrapper.java

@@ -109,6 +109,38 @@ public String getDeviceIdleMode(@NonNull final Context context){
         return "";
     }
 
+    /**
+     * Gets the Device Doze Mode Status.
+     *
+     * @param context The context to use for PowerManager.
+     * @return a {@link DeviceDozeModeStatus}
+     */
+    @NonNull
+    public DeviceDozeModeStatus getDeviceDozeModeStatus(@NonNull final Context context){
+        final String methodTag = TAG + ":getDeviceIdleMode";
+
+        try {
+            final PowerManager powerManager = ((PowerManager) context.getSystemService(Context.POWER_SERVICE));
+            if (powerManager == null) {
+                Logger.error(methodTag, "PowerManager is null", null);
+                return DeviceDozeModeStatus.CannotRetrievePowerManager;
+            }
+            if (powerManager.isDeviceIdleMode()) {
+                return DeviceDozeModeStatus.Idle;
+            }
+
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
+                    powerManager.isDeviceLightIdleMode()) {
+                return DeviceDozeModeStatus.LightIdle;
+            }
+
+            return DeviceDozeModeStatus.NotInDozeMode;
+        } catch (Exception e){
+            Logger.error(methodTag, "Unknown Exception when checking doze mode status", e);
+            return DeviceDozeModeStatus.UnknownError;
+        }
+    }
+
     /**
      * Gets a string representing Power Optimization settings of the calling app
      * Will return an empty string if the app isn't opting out.
@@ -156,28 +188,18 @@ public BatteryOptimizationStatus isAppOptedOutFromBatteryOptimization(@NonNull f
             try {
                 final PowerManager powerManager = (PowerManager) context.getSystemService(Context.POWER_SERVICE);
                 if (powerManager == null) {
-                    Logger.error(methodTag, "PowerManager is null for package: " + packageName, null);
+                    Logger.error(methodTag, "PowerManager is null", null);
                     return BatteryOptimizationStatus.CannotRetrievePowerManager;
                 }
 
                 if (powerManager.isIgnoringBatteryOptimizations(key)) {
                     return BatteryOptimizationStatus.OptOut;
-                } else
-                {
+                } else {
                     return BatteryOptimizationStatus.NotOptOut;
                 }
-            } catch (NullPointerException e) {
-                Logger.error(methodTag, "NullPointerException when checking battery optimization status for package: " + packageName, e);
-                return BatteryOptimizationStatus.NullPointerException;
-            } catch (SecurityException e) {
-                Logger.error(methodTag, "SecurityException when checking battery optimization status for package: " + packageName, e);
-                return BatteryOptimizationStatus.SecurityException;
-            } catch (IllegalArgumentException e) {
-                Logger.error(methodTag, "IllegalArgumentException when checking battery optimization status for package: " + packageName, e);
-                return BatteryOptimizationStatus.IllegalArgumentException;
             } catch (Exception e) {
                 Logger.error(methodTag, "Unknown Exception when checking battery optimization status for package: " + packageName, e);
-                return BatteryOptimizationStatus.UnknownException;
+                return BatteryOptimizationStatus.UnknownError;
             }
         });
     }