renamed/refactored to interstitials instead of sgai, since that is what this module really does

Author: izenoni

README.md

@@ -1,5 +1,6 @@
-# Wowza SGAI (Server Guided Ad Insertion) REST API
-The **SGAI REST API** module for [Wowza Streaming Engine™ media server software](https://www.wowza.com/products/streaming-engine) enables you to add HLS Interstitials with a REST api to a live video feed
+# Wowza HLS Interstials REST API 
+The **HLS Interstials REST API** module for [Wowza Streaming Engine™ media server software](https://www.wowza.com/products/streaming-engine) enables you to add HLS Interstitials with a REST api to a live video feed by adding the #EXT-DATE-RANGE tag.
+[Getting Started with HLS Interstitials](https://developer.apple.com/streaming/GettingStartedWithHLSInterstitials.pdf)
 
 ## Prerequisites
 * Wowza Streaming Engine™ 4.9.4 or later is required.
@@ -12,13 +13,13 @@ The **SGAI REST API** module for [Wowza Streaming Engine™ media server softwar
 * Run `./gradlew build` to build the jar file.
 
 ## Install
-* Copy `wse-plugin-cloud-sgai-rest-api-x.x.x.jar` into lib directory 
+* Copy `wse-plugin-cloud-interstitials-rest-api-x.x.x.jar` into lib directory 
 * Add HTTPProvider to `VHost.xml`
 ```xml
 
 <HTTPProvider>
-    <BaseClass>com.wowza.wms.plugin.sgairestapi.http.HTTPProviderSgaiRestApi</BaseClass>
-    <RequestFilters>v1/sgai/*</RequestFilters>
+    <BaseClass>com.wowza.wms.plugin.interstitialsrestapi.http.HTTPProviderInterstitialsRestApi</BaseClass>
+    <RequestFilters>v1/interstitials/*</RequestFilters>
     <AuthenticationMethod>none</AuthenticationMethod>
 </HTTPProvider>
 ```  
@@ -33,9 +34,9 @@ The **SGAI REST API** module for [Wowza Streaming Engine™ media server softwar
 * Add module to each application xml:
 ```xml
 <Module>
-    <Name>ModuleSgaiRestApi</Name>
-    <Description>ModuleSgaiRestApi</Description>
-    <Class>com.wowza.wms.plugin.sgairestapi.module.ModuleSgaiRestApi</Class>
+    <Name>ModuleInterstitialsRestApi</Name>
+    <Description>ModuleInterstitialsRestApi</Description>
+    <Class>com.wowza.wms.plugin.interstitialsrestapi.module.ModuleInterstitialsRestApi</Class>
 </Module>
 ```
 * Add HLS datetime to HTTPStreamer Properties in each application xml
@@ -49,7 +50,7 @@ The **SGAI REST API** module for [Wowza Streaming Engine™ media server softwar
 
 ## API
 ### API patterns is
-* `/v1/sgai/applications/{appName}/streams/{streamName}`
+* `/v1/interstitials/applications/{appName}/streams/{streamName}`
 
 
 ### API supports methods/verbs
@@ -83,7 +84,7 @@ curl -X POST  -H "Content-Type: application/json"  -d '{
   "start_date": "+5",
   "duration": 10.0,
   "asset_uri": "https://wv-cdn-00-00.flowplayer.com/7bb18344-08f9-4c1e-84a7-80c1007aa99b/cmaf/58080f44-c657-4e81-938c-ebcb8a29ffaa/playlist.m3u8"  
-  }' http://localhost/v1/sgai/applications/simu-live/streams/myStream
+  }' http://localhost/v1/interstitials/applications/simu-live/streams/myStream
 ```
 
 Test Playback (using hlsjs)

build.gradle

@@ -7,7 +7,7 @@ plugins {
     id "com.gorylenko.gradle-git-properties" version "2.4.0-rc1"
 }
 
-group 'com.wowza.wms.plugin.sgairestapi'
+group 'com.wowza.wms.plugin.interstitialsrestapi'
 version '1.0.0'
 
 java {

conf/VHost.xml

@@ -58,8 +58,8 @@
 						<PasswordEncodingScheme>none</PasswordEncodingScheme>
 					</HTTPProvider>
 					<HTTPProvider>
-					    <BaseClass>com.wowza.wms.plugin.sgairestapi.http.HTTPProviderSgaiRestApi</BaseClass>
-					    <RequestFilters>v1/sgai/*</RequestFilters>
+					    <BaseClass>com.wowza.wms.plugin.interstitialsrestapi.http.HTTPProviderInterstitialsRestApi</BaseClass>
+					    <RequestFilters>v1/interstitials/*</RequestFilters>
 					    <AuthenticationMethod>none</AuthenticationMethod>
 					</HTTPProvider>					
 				</HTTPProviders>
@@ -341,7 +341,6 @@
 			<MaximumSetBufferTime>60000</MaximumSetBufferTime>
 		</Application>
 		<StartStartupStreams>true</StartStartupStreams>
-
 		<Manager>
 			<TestPlayer>
 				<IpAddress>wse-trial.wowza.com</IpAddress>

conf/live/Application.xml

@@ -234,9 +234,9 @@
 				<Class>com.wowza.wms.module.ModuleFLVPlayback</Class>
 			</Module>
 			<Module>
-				<Name>ModuleSgaiRestApi</Name>
-				<Description>ModuleSgaiRestApi</Description>
-				<Class>com.wowza.wms.plugin.sgairestapi.module.ModuleSgaiRestApi</Class>
+				<Name>ModuleInterstitialsRestApi</Name>
+				<Description>ModuleInterstitialsRestApi</Description>
+				<Class>com.wowza.wms.plugin.interstitialsrestapi.module.ModuleInterstitialsRestApi</Class>
 			</Module>
 		</Modules>
 		<!-- Properties defined here will be added to the IApplication.getProperties() and IApplicationInstance.getProperties() collections -->

conf/simu-live/Application.xml

@@ -200,6 +200,17 @@
 					<Value>true</Value>
 					<Type>Boolean</Type>
 				</Property>
+				<Property>
+					<Name>CORSDynamicEnabled</Name>
+					<Value>true</Value>
+					<Type>Boolean</Type>
+				</Property>
+				<Property>
+					<Name>CORSUseHostname</Name>
+					<Value>true</Value>
+					<Type>Boolean</Type>
+				</Property>
+				
 			</Properties>
 		</HTTPStreamer>
 		<Manager>
@@ -237,9 +248,9 @@
 				<Class>com.wowza.wms.security.ModuleCoreSecurity</Class>
 			</Module>
 			<Module>
-				<Name>ModuleSgaiRestApi</Name>
-				<Description>ModuleSgaiRestApi</Description>
-				<Class>com.wowza.wms.plugin.sgairestapi.module.ModuleSgaiRestApi</Class>
+				<Name>ModuleInterstitialsRestApi</Name>
+				<Description>ModuleInterstitialsRestApi</Description>
+				<Class>com.wowza.wms.plugin.interstitialsrestapi.module.ModuleInterstitialsRestApi</Class>
 			</Module>
 		</Modules>
 		<!-- Properties defined here will be added to the IApplication.getProperties() and IApplicationInstance.getProperties() collections -->

gradle.properties

@@ -1,4 +1,4 @@
-title = Wowza SGAI REST API
-projectName = sgai-rest-api
+title = Wowza HLS Interstitials REST API
+projectName = interstitials-rest-api
 version = 1.0.0
 #wseLibDir = /usr/local/WowzaStreamingEngine/lib

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'wse-plugin-sgai-rest-api'
+rootProject.name = 'wse-plugin-interstitials-rest-api'

…treamPacketizerCupertinoDataHandler.java …treamPacketizerCupertinoDataHandler.javasrc/main/java/com/wowza/wms/plugin/sgairestapi/LiveStreamPacketizerCupertinoDataHandler.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/LiveStreamPacketizerCupertinoDataHandler.java src/main/java/com/wowza/wms/plugin/sgairestapi/LiveStreamPacketizerCupertinoDataHandler.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/LiveStreamPacketizerCupertinoDataHandler.java

@@ -3,7 +3,7 @@
  * This code is licensed pursuant to the Wowza Public License version 1.0, available at www.wowza.com/legal.
  */
 
-package com.wowza.wms.plugin.sgairestapi;
+package com.wowza.wms.plugin.interstitialsrestapi;
 
 import com.wowza.util.BufferUtils;
 import com.wowza.wms.amf.*;

…estapi/LiveStreamPacketizerListener.java …estapi/LiveStreamPacketizerListener.javasrc/main/java/com/wowza/wms/plugin/sgairestapi/LiveStreamPacketizerListener.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/LiveStreamPacketizerListener.java src/main/java/com/wowza/wms/plugin/sgairestapi/LiveStreamPacketizerListener.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/LiveStreamPacketizerListener.java

@@ -3,7 +3,7 @@
  * This code is licensed pursuant to the Wowza Public License version 1.0, available at www.wowza.com/legal.
  */
 
-package com.wowza.wms.plugin.sgairestapi;
+package com.wowza.wms.plugin.interstitialsrestapi;
 
 import com.wowza.wms.application.IApplicationInstance;
 import com.wowza.wms.httpstreamer.cupertinostreaming.livestreampacketizer.*;
@@ -16,28 +16,17 @@
 public class LiveStreamPacketizerListener extends LiveStreamPacketizerActionNotifyBase
 {
 	private static final Logger log = LogManager.getLogger(LiveStreamPacketizerListener.class);
-	public static final String DATEFORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
 
-	private enum HlsTagType { DATERANGE, CUE }
 	private static final Class<LiveStreamPacketizerListener> CLASS = LiveStreamPacketizerListener.class;
 	private static final String CLASSNAME = CLASS.getSimpleName();
 	private final IApplicationInstance appInstance;
 	private final WMSLogger logger;
 
-	private HlsTagType hlsTagType = HlsTagType.DATERANGE;
 
 	public LiveStreamPacketizerListener(IApplicationInstance appInstance)
 	{
 		this.appInstance = appInstance;
 		this.logger = WMSLoggerFactory.getLoggerObj(CLASS, appInstance);
-		try
-		{
-			hlsTagType = HlsTagType.valueOf(appInstance.getLiveStreamPacketizerProperties().getPropertyStr("scteAdsHlsTagType", "DATERANGE"));
-		}
-		catch (Exception e)
-		{
-			logger.error(String.format("%s.onAppStart [%s] exception: %s", CLASSNAME, appInstance.getContextStr(), e));
-		}
 	}
 
 	@Override
@@ -50,14 +39,6 @@ public void onLiveStreamPacketizerInit(ILiveStreamPacketizer liveStreamPacketize
 			{
 				LiveStreamPacketizerCupertinoDataHandler dataHandler =  new LiveStreamPacketizerCupertinoDataHandler((LiveStreamPacketizerCupertino) liveStreamPacketizer, stream);
 				((LiveStreamPacketizerCupertino)liveStreamPacketizer).setDataHandler(dataHandler);
-
-				// logger.info("Adding stuff to streamName:" + streamName);
-				// String queryParam = "";
-				// queryParam = "EXT-X-DEFINE:QUERYPARAM=\"user\"";
-				// ((LiveStreamPacketizerCupertino)liveStreamPacketizer).getUserManifestHeaders().addHeader(queryParam);
-				// queryParam = "EXT-X-DEFINE:QUERYPARAM=\"content\"";
-				// ((LiveStreamPacketizerCupertino)liveStreamPacketizer).getUserManifestHeaders().addHeader(queryParam);
-
 			}
 			else if (liveStreamPacketizer instanceof LiveStreamPacketizerMPEGDash)
 			{

…estapi/http/HTTPProviderSgaiRestApi.java …tp/HTTPProviderInterstitialsRestApi.javasrc/main/java/com/wowza/wms/plugin/sgairestapi/http/HTTPProviderSgaiRestApi.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/http/HTTPProviderInterstitialsRestApi.java src/main/java/com/wowza/wms/plugin/sgairestapi/http/HTTPProviderSgaiRestApi.java renamed to src/main/java/com/wowza/wms/plugin/interstitialsrestapi/http/HTTPProviderInterstitialsRestApi.java

@@ -3,7 +3,7 @@
  * This code is licensed pursuant to the Wowza Public License version 1.0, available at www.wowza.com/legal.
  */
 
-package com.wowza.wms.plugin.sgairestapi.http;
+package com.wowza.wms.plugin.interstitialsrestapi.http;
 
 import com.fasterxml.jackson.core.*;
 import com.wowza.util.SystemUtils;
@@ -14,7 +14,7 @@
 import com.wowza.wms.http.IHTTPResponse;
 import com.wowza.wms.httpstreamer.cupertinostreaming.livestreampacketizer.LiveStreamPacketizerCupertino;
 import com.wowza.wms.logging.*;
-import com.wowza.wms.plugin.sgairestapi.ReleaseInfo;
+import com.wowza.wms.plugin.interstitialsrestapi.ReleaseInfo;
 import com.wowza.wms.stream.IMediaStream;
 import com.wowza.wms.stream.livepacketizer.ILiveStreamPacketizer;
 import com.wowza.wms.vhost.IVHost;
@@ -27,18 +27,18 @@
 import java.util.*;
 import java.util.concurrent.*;
 
-public class HTTPProviderSgaiRestApi extends HTTPProvider2Base
+public class HTTPProviderInterstitialsRestApi extends HTTPProvider2Base
 {
 	public static final String DATEFORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
 	public FastDateFormat fastDateFormat;
 	public int adNumber = 0;
 	Map<String,Timer> cancelDateRange = new HashMap<String, Timer>();
 	static WMSLogger log = null;
 
-	public HTTPProviderSgaiRestApi()
+	public HTTPProviderInterstitialsRestApi()
 	{
-		log = WMSLoggerFactory.getLogger(HTTPProviderSgaiRestApi.class);
-		log.info("Creating HTTPProvider SgaiRestApi v"+ ReleaseInfo.getVersion());
+		log = WMSLoggerFactory.getLogger(HTTPProviderInterstitialsRestApi.class);
+		log.info("Creating HTTPProvider InterstitialsRestApi v"+ ReleaseInfo.getVersion());
 		fastDateFormat = FastDateFormat.getInstance(DATEFORMAT, SystemUtils.gmtTimeZone, Locale.US);
 	}
 	//
@@ -111,7 +111,7 @@ public void onHTTPRequest(IVHost ivHost, IHTTPRequest ihttpRequest, IHTTPRespons
 				sendResponse(ihttpResponse, "Error:" + e.getMessage(), 500);
 			}
 		}
-		// curl -X POST "http://localhost:1935/v1/sgai/applications/simu-live/streams/myStream -d '{ "id":"foo" }'
+		// curl -X POST "http://localhost:1935/v1/interstitials/applications/simu-live/streams/myStream -d '{ "id":"foo" }'
 
 	}