How to blacklist a stream in session (BlacklistStreams)

The BlacklistStreams server listener and HTTP Provider for Wowza Streaming Engine™ media server software enables you to persistently blacklist streams published to your Wowza media server.

Contents


Prerequisites
Installation
Configuration
Properties
Usage
For developers

Prerequisites


Wowza Streaming Engine 4.0.0 or later is required.

Installation


  1. Download wse-plugin-blackliststreams.zip.
     
  2. Extract the contents from the downloaded (zipped) package, and then copy the wse-plugin-blackliststreams.jar file from the package to the lib folder in your Wowza Streaming Engine installation ([install-dir]/lib).
     
  3. Restart Wowza Streaming Engine.

Configuration


Adding the server listener

To enable the server listener, add the following server listener definition to your server in Wowza Streaming Engine Manager. See Configure server listeners for details.

Base Class
com.wowza.wms.plugin.blacklist.ServerListenerBlacklistStreams 

Adding the HTTP Provider

To configure the HTTP Provider:

  1. In a text editor, open [install-dir]/conf/VHost.xml and navigate to the Admin Hostport section in the file:
    <!-- Admin HostPort -->
  2. In the <HostPort>/<HTTPProviders> container, insert the BlacklistStreams HTTP Provider "before" the final <HTTPProvider> entry in the container:
    <HTTPProviders>
    ...
    	<HTTPProvider>
    		<BaseClass>com.wowza.wms.plugin.blacklist.HTTPProviderBlacklistStreams</BaseClass>
    		<RequestFilters>blacklist*</RequestFilters>
    		<AuthenticationMethod>admin-digest</AuthenticationMethod>
    	</HTTPProvider>
    	<HTTPProvider>
    		<BaseClass>com.wowza.wms.http.HTTPServerVersion</BaseClass>
    		<RequestFilters>*</RequestFilters>
    		<AuthenticationMethod>none</AuthenticationMethod>
    	</HTTPProvider>
    </HTTPProviders>
  3. Save and close the VHost.xml file, and then restart the media server to apply the changes.

Properties


The following properties can be set for the server listener. See Configure properties for details.

Path
Name
Type
Value
Notes
/Root/Server blacklistStreamsConfigPath String /usr/local/WowzaStreamingEngine/conf/blacklist.txt The full path to the blacklist file. (default: [install-dir]/conf/blacklist.txt)
/Root/Server blacklistStreamsDebugLog Boolean true Enables extra logging. (default: false)

Usage


To blacklist a stream:

  1. Start your Wowza Streaming Engine media server, and then open the following URL to the Stream Blacklists page in a web browser:
    http://[wowza-ip-address]:8086/blacklist
    Where [wowza-ip-address] is the IP address of the Wowza media server.
     
  2. When prompted, enter the credentials that you use to sign in to Wowza Streaming Engine Manager.
     
  3. Publish your first stream, and then in the Stream Blacklists page, click Check for new streams. Your new stream will be displayed in the Published Streams list.
     
  4. Click the Blacklist link next to the published stream to add that stream to the blacklist. This will also stop the stream. Any subsequent attempts to publish to that [app-name]/[app-instance]/[stream-name] sequence are rejected until you remove the stream from the blacklist.

For developers


Source code is available on GitHub.

Wowza Media Systems™ provides developers with a platform to create streaming applications and solutions. See Wowza Developer Tools to learn more about our APIs and SDK.


Wowza media server software and all components, including modules, source code, and other related items offered on this page, are copyrighted (c) 2006-2016 by Wowza Media Systems, LLC, all rights reserved, and are licensed pursuant to the Wowza Media Software End User License Agreement.

Originally Published: For Wowza Streaming Engine on 02-02-2015.
Updated: 05-19-2016.

If you're having problems or want to discuss this article, post in our forum.