Fix/consumption reporting changes (#20)

* Increase version number to 1.1.0

* Use ArrayList instead of Array

* Add required changes for consumption reporting

* Adjust consumption report models

* Add missing fields to model classes and move function to derive IP address to utils class

Author: dsilhavy

.idea/misc.xml

@@ -13,7 +13,7 @@ android {
         minSdk 29
         targetSdk 32
         versionCode 1
-        versionName "1.0.2"
+        versionName "1.1.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -38,7 +38,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.fivegmag'
             artifactId = 'a5gmscommonlibrary'
-            version = '1.0.2'
+            version = '1.1.0'
 
             afterEvaluate {
                 from components.release
@@ -63,6 +63,8 @@ dependencies {
     implementation 'androidx.appcompat:appcompat:1.6.1'
     implementation 'com.google.android.material:material:1.8.0'
     implementation "androidx.media3:media3-exoplayer:1.0.2"
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.1'
+    implementation 'com.fasterxml.jackson.module:jackson-module-kotlin:2.12.1'
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'androidx.test.ext:junit:1.1.5'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'

app/build.gradle

@@ -0,0 +1,40 @@
+/*
+License: 5G-MAG Public License (v1.0)
+Author: Daniel Silhavy
+Copyright: (C) 2023 Fraunhofer FOKUS
+For full license terms please see the LICENSE file distributed with this
+program. If this file is missing then the license can be retrieved from
+https://drive.google.com/file/d/1cinCiA778IErENZ3JN52VFW-1ffHpx7Z/view
+*/
+
+package com.fivegmag.a5gmscommonlibrary.consumptionReporting
+
+import android.os.Parcelable
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fivegmag.a5gmscommonlibrary.models.EndpointAddress
+import com.fivegmag.a5gmscommonlibrary.models.TypedLocation
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+@JsonIgnoreProperties(ignoreUnknown = true)
+data class ConsumptionReport(
+    val mediaPlayerEntry: String,
+    val reportingClientId: String,
+    val consumptionReportingUnits: ArrayList<ConsumptionReportingUnit>
+) : Parcelable
+
+@Parcelize
+@JsonIgnoreProperties(ignoreUnknown = true)
+data class ConsumptionReportingUnit(
+    val mediaConsumed: String,
+    var mediaEndpointAddress: EndpointAddress? = null,
+    val startTime: String,
+    var duration: Int,
+    var locations: ArrayList<TypedLocation>? = ArrayList(),
+    //@JsonIgnore
+    var mimeType: String? = null,
+    //@JsonIgnore
+    var finished: Boolean = false
+) : Parcelable
+

app/src/main/java/com/fivegmag/a5gmscommonlibrary/consumptionReporting/ConsumptionReport.kt

@@ -37,7 +37,8 @@ object SessionHandlerMessageTypes {
     const val UPDATE_LOOKUP_TABLE = 8
     const val SET_M5_ENDPOINT = 9
     const val START_PLAYBACK_BY_SERVICE_LIST_ENTRY_MESSAGE = 10
-    const val CONSUMPTION_REPORTING_MESSAGE = 11
+    const val GET_CONSUMPTION_REPORT = 11
+    const val CONSUMPTION_REPORT = 12
 }
 
 object SessionHandlerEvents {

app/src/main/java/com/fivegmag/a5gmscommonlibrary/helpers/Constants.kt

@@ -6,6 +6,10 @@ import java.util.Date
 import java.util.Random
 import java.util.TimeZone
 import okhttp3.Headers
+import java.net.NetworkInterface
+import java.time.Instant
+import java.util.Locale
+import java.util.UUID
 
 class Utils {
 
@@ -25,6 +29,23 @@ class Utils {
         return dateFormat.format(date)
     }
 
+    fun generateUUID(): String {
+        val uuid = UUID.randomUUID()
+        return uuid.toString()
+    }
+
+    fun formatDateToOpenAPIFormat(date: Date): String {
+        val format = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.getDefault())
+        return format.format(date)
+    }
+
+    fun calculateTimestampDifferenceInSeconds(timestamp1: String, timestamp2: String): Long {
+        val instant1 = Instant.parse(timestamp1)
+        val instant2 = Instant.parse(timestamp2)
+        val duration = Duration.between(instant1, instant2)
+        return duration.seconds
+    }
+
     fun getCurrentXsDateTime(): String {
         val currentTimestamp = getCurrentTimestamp()
 
@@ -80,4 +101,25 @@ class Utils {
     private fun hasHeaderChanged(headerA: String?, headerB: String?): Boolean {
         return headerA == null || headerB == null || headerA != headerB
     }
+
+    fun getIpAddress(ipVer: Int): String? {
+        val interfaces = NetworkInterface.getNetworkInterfaces()
+        while (interfaces.hasMoreElements()) {
+            val networkInterface = interfaces.nextElement()
+            val addresses = networkInterface.inetAddresses
+            while (addresses.hasMoreElements()) {
+                val address = addresses.nextElement()
+                if (!address.isLoopbackAddress && address.isSiteLocalAddress) {
+                    if ((ipVer == 4 && address.hostAddress.contains("."))||
+                        (ipVer == 6 && address.hostAddress.contains(":"))
+                    ){
+                        return address.hostAddress.toString()
+                    }
+                }
+            }
+        }
+
+        return null
+    }
+
 }

app/src/main/java/com/fivegmag/a5gmscommonlibrary/helpers/Utils.kt

@@ -27,9 +27,9 @@ data class StreamingAccess(
 
 @Parcelize
 data class ClientConsumptionReportingConfiguration(
-    val serverAddresses : Array<String>,
+    val serverAddresses : ArrayList<String>,
     val locationReporting: Boolean,
     val samplePercentage: Float,
-    val reportingInterval: UInt,
+    val reportingInterval: Int? = null,
     val accessReporting: Boolean
 ) : Parcelable

app/src/main/java/com/fivegmag/a5gmscommonlibrary/models/ConsumptionReporting.kt

@@ -14,13 +14,21 @@ import kotlinx.parcelize.Parcelize
 
 @Parcelize
 data class TypedLocation(
-    val locationIdentifierType: String,
+    val locationIdentifierType: CellIdentifierType,
     val location: String
 ) : Parcelable
 
 @Parcelize
 data class EndpointAddress(
+    val domainName: String? = null,
     val ipv4Addr: String? = null,
     val ipv6Addr: String? = null,
     val portNumber: UInt
-) : Parcelable
+) : Parcelable
+
+@Parcelize
+enum class CellIdentifierType : Parcelable {
+    CGI,
+    ECGI,
+    NCGI
+}