ARRIS Enterprises, Inc. Confidential Information

The white list URLs definition

The white list URLs defines the domains to be handled as portals by the VIP units. This whitelisting allows the domains to execute TOI JavaScript code on the STB. The white list URLs definition uses XML and is as default located in /opt/infocast/whitelisturls.xml.

Portal URLs DTD

If pages are requested using both FQDNs and IP addresses, then both formats must be presented in this file to get the desired effect.

The Portal browser uses the URL specified in cfg.portal.starturl as the default URL when the browser starts. If cfg.portal.starturl has not been set, the first valid URL in the whitelist file will be used.

Portal pages located on the set-top box (ie, URLs beginning with file:// ) are automatically whitelisted, and do not need to be explicitly mentioned here. Only file:// portal pages in /usr/local/portal/ are allowed.


<!ELEMENT PortalURLs (PortalURL+)>
<!ELEMENT PortalURL (#PCDATA)>

White List URLs XML example

An example whitelist file is provided in the SDK at <sdk_root>/examples/build_scripts/whitelisturls.xml and also installed with the Infocast server installation by default to /opt/infocast/whitelisturls.xml.


<?xml version="1.0"?>
<!DOCTYPE PortalURLs SYSTEM "whitelisturls.dtd">
<PortalURLs>
  <PortalURL>http://www.arris.com/</PortalURL>
  <PortalURL>http://192.168.95.14/portal</PortalURL>
</PortalURLs>

White List URLs XML description

Element Comment Values

PortalURLs

Defines the complete set of portal URLs. Contains one or more PortalURL items. If the cfg.portal.starturl object is not set, then the first specified portal URL is the one that will be loaded when the Portal application starts.

Type:
XML object

Value set:
<PortalURL> objects

PortalURL

Defines one portal URL. The URL may be specified as a FQDN or as an IP-address. A certain directory in the domain may be specified. If so, only URLs matching the complete prefix will be considered as portal URLs. In the example, http://195.168.95.14/portal/epg/program.html is a valid portal page, but http://195.168.95.14/epgdata/tv1.html is not.

The portal URLs are matched as prefixes, but an extra slash is added to the end of the URL if not already there. This means that http://www.example.com/portal and http://www.example.com/portal/ are equivalent. Also note that http:// is automatically added if a protocol is not specified, but this is deprecated, and a warning will be logged when a URL without protocol is used.

Type:
String

Value set:
A valid IP address or FQDN

Examples:
http://www.example.com http://192.168.95.14/portal/