Add AJO Basic push notification template support

code/notificationbuilder/build.gradle.kts

@@ -38,6 +38,6 @@ aepLibrary {
 
 dependencies {
     implementation("com.adobe.marketing.mobile:core:$mavenCoreVersion")
-    testImplementation("org.robolectric:robolectric:4.7")
+    testImplementation("org.robolectric:robolectric:4.11.1")
     testImplementation("io.mockk:mockk:1.13.11")
 }

code/notificationbuilder/src/main/java/com/adobe/marketing/mobile/notificationbuilder/NotificationBuilder.kt

@@ -21,6 +21,7 @@ import com.adobe.marketing.mobile.notificationbuilder.NotificationBuilderConstan
 import com.adobe.marketing.mobile.notificationbuilder.NotificationBuilderConstants.VERSION
 import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.LOG_TAG
 import com.adobe.marketing.mobile.notificationbuilder.internal.PushTemplateType
+import com.adobe.marketing.mobile.notificationbuilder.internal.ajo.builders.AJOBasicNotificationBuilder
 import com.adobe.marketing.mobile.notificationbuilder.internal.builders.AutoCarouselNotificationBuilder
 import com.adobe.marketing.mobile.notificationbuilder.internal.builders.BasicNotificationBuilder
 import com.adobe.marketing.mobile.notificationbuilder.internal.builders.InputBoxNotificationBuilder
@@ -32,6 +33,7 @@ import com.adobe.marketing.mobile.notificationbuilder.internal.builders.ProductR
 import com.adobe.marketing.mobile.notificationbuilder.internal.builders.TimerNotificationBuilder
 import com.adobe.marketing.mobile.notificationbuilder.internal.builders.ZeroBezelNotificationBuilder
 import com.adobe.marketing.mobile.notificationbuilder.internal.templates.AEPPushTemplate
+import com.adobe.marketing.mobile.notificationbuilder.internal.templates.AJOBasicPushTemplate
 import com.adobe.marketing.mobile.notificationbuilder.internal.templates.AutoCarouselPushTemplate
 import com.adobe.marketing.mobile.notificationbuilder.internal.templates.BasicPushTemplate
 import com.adobe.marketing.mobile.notificationbuilder.internal.templates.CarouselPushTemplate
@@ -222,6 +224,15 @@ object NotificationBuilder {
                 )
             }
 
+            PushTemplateType.AJO_BASIC -> {
+                return AJOBasicNotificationBuilder.construct(
+                    context,
+                    AJOBasicPushTemplate(notificationData),
+                    trackerActivityClass,
+                    broadcastReceiverClass
+                )
+            }
+
             PushTemplateType.UNKNOWN -> {
                 return LegacyNotificationBuilder.construct(
                     context,

code/notificationbuilder/src/main/java/com/adobe/marketing/mobile/notificationbuilder/PushTemplateConstants.kt

@@ -92,6 +92,7 @@ object PushTemplateConstants {
 
     object PushPayloadKeys {
         const val TEMPLATE_TYPE = "adb_template_type"
+        const val AJO_TEMPLATE_PROPERTIES = "adb_template_properties"
         const val TITLE = "adb_title"
         const val BODY = "adb_body"
         const val SOUND = "adb_sound"
@@ -197,4 +198,16 @@ object PushTemplateConstants {
         const val URI = "uri"
         const val TYPE = "type"
     }
+
+    // Keys for parsing the adb_template_properties JSON blob for AJO templates.
+    // These are NOT top-level FCM keys — they are keys inside the parsed JSON object.
+    internal object AJOTemplatePropertyKeys {
+        // Basic template: scale type applied to the expanded hero image.
+        internal const val IMAGE_SCALE_TYPE = "adb_image_scale_type"
+
+        internal object ScaleType {
+            internal const val CENTER_CROP = "center_crop"
+            internal const val FIT_CENTER = "fit_center"
+        }
+    }
 }

code/notificationbuilder/src/main/java/com/adobe/marketing/mobile/notificationbuilder/internal/PushTemplateType.kt

@@ -23,6 +23,7 @@ internal enum class PushTemplateType(val value: String) {
     PRODUCT_CATALOG("cat"),
     MULTI_ICON("icon"),
     TIMER("timer"),
+    AJO_BASIC("ajo_basic"),
     UNKNOWN("unknown");
 
     companion object {
@@ -42,6 +43,7 @@ internal enum class PushTemplateType(val value: String) {
                 "rate" -> PRODUCT_RATING
                 "icon" -> MULTI_ICON
                 "timer" -> TIMER
+                "ajo_basic" -> AJO_BASIC
                 else -> UNKNOWN
             }
         }

code/notificationbuilder/src/main/java/com/adobe/marketing/mobile/notificationbuilder/internal/ajo/builders/AJOBasicNotificationBuilder.kt

@@ -0,0 +1,197 @@
+/*
+  Copyright 2024 Adobe. All rights reserved.
+  This file is licensed to you under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License. You may obtain a copy
+  of the License at http://www.apache.org/licenses/LICENSE-2.0
+  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 REPRESENTATIONS
+  OF ANY KIND, either express or implied. See the License for the specific language
+  governing permissions and limitations under the License.
+*/
+
+package com.adobe.marketing.mobile.notificationbuilder.internal.ajo.builders
+
+import android.app.Activity
+import android.app.NotificationChannel
+import android.app.NotificationManager
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.media.RingtoneManager
+import android.os.Build
+import android.view.View
+import android.widget.RemoteViews
+import androidx.core.app.NotificationCompat
+import com.adobe.marketing.mobile.notificationbuilder.NotificationConstructionFailedException
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.AJOTemplatePropertyKeys
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.LOG_TAG
+import com.adobe.marketing.mobile.notificationbuilder.R
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.addActionButtons
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.getSoundUriForResourceName
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.setNotificationClickAction
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.setNotificationDeleteAction
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.setRemoteViewImage
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.setSmallIcon
+import com.adobe.marketing.mobile.notificationbuilder.internal.extensions.setSound
+import com.adobe.marketing.mobile.notificationbuilder.internal.templates.AJOBasicPushTemplate
+import com.adobe.marketing.mobile.services.Log
+
+/**
+ * Object responsible for constructing a [NotificationCompat.Builder] object containing an
+ * AJO basic ("ajo_basic") push template notification.
+ *
+ * This builder is segregated from the out-of-the-box (ACC) builders. It reuses the shared
+ * primitive RemoteViews / NotificationCompat.Builder extension functions for rendering, but
+ * keeps its own orchestration and channel creation so AJO concerns evolve independently and no
+ * existing code is modified.
+ */
+internal object AJOBasicNotificationBuilder {
+    private const val SELF_TAG = "AJOBasicNotificationBuilder"
+
+    @Throws(NotificationConstructionFailedException::class)
+    fun construct(
+        context: Context,
+        pushTemplate: AJOBasicPushTemplate,
+        trackerActivityClass: Class<out Activity>?,
+        broadcastReceiverClass: Class<out BroadcastReceiver>?
+    ): NotificationCompat.Builder {
+        Log.trace(LOG_TAG, SELF_TAG, "Building an AJO basic template push notification.")
+        val packageName = context.packageName
+        val smallLayout = RemoteViews(packageName, R.layout.ajo_push_template_collapsed)
+        val expandedLayout = RemoteViews(packageName, R.layout.ajo_basic_push_template_expanded)
+
+        val notificationManager =
+            context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
+        val channelIdToUse = createChannelIfRequired(context, notificationManager, pushTemplate)
+
+        // set the title and body text
+        smallLayout.setTextViewText(R.id.notification_title, pushTemplate.title)
+        smallLayout.setTextViewText(R.id.notification_body, pushTemplate.body)
+        expandedLayout.setTextViewText(R.id.notification_title, pushTemplate.title)
+        expandedLayout.setTextViewText(R.id.notification_body_expanded, pushTemplate.body)
+
+        // the basic template has no large side icon — hide the container in both layouts
+        smallLayout.setViewVisibility(R.id.large_icon_container, View.GONE)
+        expandedLayout.setViewVisibility(R.id.large_icon_container, View.GONE)
+
+        // set the expanded image with the correct scale type view, hide the other
+        val (expandedImageVisibleId, expandedImageGoneId) =
+            if (pushTemplate.imgScaleType == AJOTemplatePropertyKeys.ScaleType.FIT_CENTER) {
+                R.id.expanded_image_fit_center to R.id.expanded_image_center_crop
+            } else {
+                R.id.expanded_image_center_crop to R.id.expanded_image_fit_center
+            }
+        expandedLayout.setViewVisibility(expandedImageGoneId, View.GONE)
+        expandedLayout.setViewVisibility(expandedImageVisibleId, View.VISIBLE)
+        expandedLayout.setRemoteViewImage(pushTemplate.imageUrl, expandedImageVisibleId)
+
+        val builder = NotificationCompat.Builder(context, channelIdToUse)
+            .setTicker(pushTemplate.ticker)
+            .setNumber(pushTemplate.badgeCount)
+            .setAutoCancel(!pushTemplate.isNotificationSticky)
+            .setOngoing(pushTemplate.isNotificationSticky)
+            .setStyle(NotificationCompat.DecoratedCustomViewStyle())
+            .setCustomContentView(smallLayout)
+            .setCustomBigContentView(expandedLayout)
+            // small icon must be present, otherwise the notification will not be displayed.
+            .setSmallIcon(context, pushTemplate.smallIcon, null)
+            .setVisibility(pushTemplate.visibility.value)
+            .setNotificationClickAction(
+                context,
+                trackerActivityClass,
+                pushTemplate.actionUri,
+                pushTemplate.actionType,
+                pushTemplate.data.getBundle()
+            )
+            .setNotificationDeleteAction(context, trackerActivityClass)
+
+        // if not from intent, set custom sound. applies to API 25 and lower only as
+        // API 26 and up set the sound on the notification channel.
+        if (!pushTemplate.isFromIntent) {
+            builder.setSound(context, pushTemplate.sound)
+        }
+
+        // below API 26 (no notification channels) priority is set on the builder
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
+            builder.setPriority(NotificationCompat.PRIORITY_HIGH)
+                .setVibrate(LongArray(0))
+        }
+
+        // add any action buttons defined for the notification
+        builder.addActionButtons(
+            context,
+            trackerActivityClass,
+            pushTemplate.actionButtonsList,
+            pushTemplate.data.getBundle()
+        )
+
+        return builder
+    }
+
+    /**
+     * Creates a notification channel if required. Logic mirrors the shared
+     * `NotificationManager.createNotificationChannelIfRequired` extension but is kept local so
+     * the AJO builder does not depend on or modify the AEPPushTemplate-typed shared extension.
+     *
+     * @param context the application [Context]
+     * @param notificationManager the [NotificationManager] used to create / look up channels
+     * @param pushTemplate the [AJOBasicPushTemplate] providing channel id, sound and importance
+     * @return the channel ID to use for the notification
+     */
+    private fun createChannelIfRequired(
+        context: Context,
+        notificationManager: NotificationManager,
+        pushTemplate: AJOBasicPushTemplate
+    ): String {
+        val channelIdToUse =
+            if (pushTemplate.isFromIntent) {
+                PushTemplateConstants.DefaultValues.SILENT_NOTIFICATION_CHANNEL_ID
+            } else {
+                pushTemplate.channelId ?: PushTemplateConstants.DefaultValues.DEFAULT_CHANNEL_ID
+            }
+
+        // no channel creation required below API 26
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
+            return channelIdToUse
+        }
+
+        // don't create a channel if it already exists
+        if (notificationManager.getNotificationChannel(channelIdToUse) != null) {
+            Log.trace(
+                LOG_TAG,
+                SELF_TAG,
+                "Using previously created notification channel: $channelIdToUse."
+            )
+            return channelIdToUse
+        }
+
+        val channel = NotificationChannel(
+            channelIdToUse,
+            if (pushTemplate.isFromIntent) {
+                PushTemplateConstants.DefaultValues.SILENT_CHANNEL_NAME
+            } else {
+                PushTemplateConstants.DefaultValues.DEFAULT_CHANNEL_NAME
+            },
+            pushTemplate.getNotificationImportance()
+        )
+
+        if (pushTemplate.isFromIntent) {
+            channel.setSound(null, null)
+        } else {
+            val soundUri = if (pushTemplate.sound.isNullOrEmpty()) {
+                RingtoneManager.getDefaultUri(RingtoneManager.TYPE_NOTIFICATION)
+            } else {
+                context.getSoundUriForResourceName(pushTemplate.sound)
+            }
+            channel.setSound(soundUri, null)
+        }
+
+        Log.trace(
+            LOG_TAG,
+            SELF_TAG,
+            "Creating a new notification channel with ID: $channelIdToUse."
+        )
+        notificationManager.createNotificationChannel(channel)
+        return channelIdToUse
+    }
+}

code/notificationbuilder/src/main/java/com/adobe/marketing/mobile/notificationbuilder/internal/templates/AJOBasicPushTemplate.kt

@@ -0,0 +1,103 @@
+/*
+  Copyright 2024 Adobe. All rights reserved.
+  This file is licensed to you under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License. You may obtain a copy
+  of the License at http://www.apache.org/licenses/LICENSE-2.0
+  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 REPRESENTATIONS
+  OF ANY KIND, either express or implied. See the License for the specific language
+  governing permissions and limitations under the License.
+*/
+
+package com.adobe.marketing.mobile.notificationbuilder.internal.templates
+
+import androidx.annotation.VisibleForTesting
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.AJOTemplatePropertyKeys
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.LOG_TAG
+import com.adobe.marketing.mobile.notificationbuilder.PushTemplateConstants.PushPayloadKeys
+import com.adobe.marketing.mobile.notificationbuilder.internal.util.NotificationData
+import com.adobe.marketing.mobile.services.Log
+import org.json.JSONArray
+import org.json.JSONException
+import org.json.JSONObject
+
+/**
+ * Parses the raw [adb_template_properties] blob into a [JSONObject], returning null when the blob
+ * is missing or malformed. Shared by the AJO template subclasses.
+ */
+internal fun parseAjoTemplateProperties(raw: String?): JSONObject? {
+    if (raw.isNullOrEmpty()) return null
+    return try {
+        JSONObject(raw)
+    } catch (e: JSONException) {
+        Log.warning(
+            LOG_TAG, "AJOTemplateProperties",
+            "Failed to parse adb_template_properties: ${e.localizedMessage}"
+        )
+        null
+    }
+}
+
+/**
+ * Represents the AJO "ajo_basic" push template.
+ *
+ * All general fields (title, body, version, image url, icons, sound, action, etc.) are parsed by
+ * [AEPPushTemplate] from the flat top-level FCM keys. The only template-specific field lives in the
+ * [adb_template_properties] blob as the flat [adb_image_scale_type] key. This template has no large
+ * side icon. Action buttons are read from the flat [adb_act] key.
+ */
+internal class AJOBasicPushTemplate(data: NotificationData) : AEPPushTemplate(data) {
+
+    private val SELF_TAG = "AJOBasicPushTemplate"
+
+    // Scale type for the main expanded image. Defaults to CENTER_CROP.
+    internal val imgScaleType: String
+
+    // Optional, action buttons for the notification as a raw string
+    internal val actionButtonsString: String?
+
+    // Optional, parsed list of action buttons
+    internal val actionButtonsList: List<BasicPushTemplate.ActionButton>?
+
+    init {
+        val props: JSONObject? = parseAjoTemplateProperties(
+            data.getString(PushPayloadKeys.AJO_TEMPLATE_PROPERTIES)
+        )
+
+        imgScaleType = props?.optString(AJOTemplatePropertyKeys.IMAGE_SCALE_TYPE)
+            ?.takeIf { it.isNotEmpty() }
+            ?: AJOTemplatePropertyKeys.ScaleType.CENTER_CROP
+
+        // Action buttons come from the flat adb_act key, same as ACC/AJO today
+        actionButtonsString = data.getString(PushPayloadKeys.ACTION_BUTTONS)
+        actionButtonsList = getActionButtonsFromString(actionButtonsString)
+    }
+
+    @VisibleForTesting
+    internal fun getActionButtonsFromString(actionButtons: String?): List<BasicPushTemplate.ActionButton>? {
+        if (actionButtons == null) {
+            Log.debug(
+                LOG_TAG, SELF_TAG,
+                "Exception in converting actionButtons json string to json object, Error : actionButtons is null"
+            )
+            return null
+        }
+        val actionButtonList = mutableListOf<BasicPushTemplate.ActionButton>()
+        try {
+            val jsonArray = JSONArray(actionButtons)
+            for (i in 0 until jsonArray.length()) {
+                val jsonObject = jsonArray.getJSONObject(i)
+                val button = BasicPushTemplate.ActionButton.getActionButtonFromJSONObject(jsonObject)
+                    ?: continue
+                actionButtonList.add(button)
+            }
+        } catch (e: JSONException) {
+            Log.warning(
+                LOG_TAG, SELF_TAG,
+                "Exception in converting actionButtons json string to json object, Error : ${e.localizedMessage}"
+            )
+            return null
+        }
+        return actionButtonList
+    }
+}