• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
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. The white list URLs definition uses XML and is as default located in /opt/infocast/whitelisturls.xml.

Portal URLs DTD

If the Portal and the Web applications are installed, then all URLs matching the specifications in this file will be handled by the Portal application and all other URLs will be sent to the Web application.

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 first URL specified is loaded when the portal application is started unless cfg.portal.starturl is specified.

To load a local file (using the file:// scheme) when the portal application starts, a specific existing file must be requested. If the file:// URL points to a directory, the portal will not be loaded. To load a regular URL when the application starts, it is possible to either use http://<host or ip>/path/index.html or http://<host or ip>/path. The latter requires that the webserver reply contains the index file. Only file:// portal pages in /usr/local/portal are allowed.


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

White List URLs XML example

The name of this file in the evaluation configuration is whitelisturls.xml.


<?xml version="1.0"?>
<!DOCTYPE PortalURLs SYSTEM "whitelisturls.dtd">
<PortalURLs>
  <PortalURL>file:///usr/local/portal/index.html</PortalURL>
  <PortalURL>http://www.example.com/portal</PortalURL>
  <PortalURL>http://192.168.95.14/</PortalURL>
</PortalURLs>

White List URLs XML description

Element Comment Values
PortalURLs Defines the complete set of portal URLs. Contains one or more PortalURL items. 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 implicit, 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/

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.