WebProxy Portlet v2 Configuration

Owned by Jen Bourey
Last updated: Jun 04, 2014 by James Wennmacher (Deactivated)
2 min read

Portlet Preferences

Each instance of the web proxy portlet is configured via portlet preferences.  The main preferences indicate the content source, how content should be retrieved, and how the result should be processed.  Content services, interceptors, and filters may each define additional preferences for their configuration.  

There is a rich configuration admin page that allows configuration of the portlet preferences providing access to most functionality.

PreInterceptors

User Info URL Parameterizing PreInterceptor

This filter can dynamically insert values from the UserInfo map into the URL, query string, and form parameters.  Any value of the format \{keyName\} will be replaced the value of that key in the UserInfo map, assuming one exists.  If no value for the key exists, the string will not be replaced.  The Rich Configuration admin page automatically adds this filter.

Filters

URL Rewriting Filter

The URL rewriting filter is a key component for any document retrieved via the HTTP content service.  This filters rewrites any relative URLs to include the target server and can additionally proxy additional resources from the portlet.  For example, the portlet may be configured to proxy images, scripts, or target URLs.

Proxying behavior is controlled by the "whitelistRegexes" portlet preference.  This preference should represent zero or more regexes describing which URL paths the portlet should proxy beyond the initial HTTP page request.  The regex expression only has to match part of the url; e.g. if the url is http://www.net.edu/news/hello.news and the regex is "/news/" it will match.  See http://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html#find().  The Rich Configuration admin page allows entry of a single Whitelist regex expression and dynamically adds this filter based on its presence.

To provide multiple regex patterns you must edit the portlet publishing XML file, or just provide a more complex regex pattern.

Content Clipping Filter

This filter requires an addition portlet preference named "clippingSelector".  The Rich Configuration admin page automatically adds this filter if an HTML element name is specified; e.g. 'body' will return only the content within and not including the <body> ... </body> node.

Gateway Single Sign On

v2 of WebproxyPortlet supports a more modern implementation of Single Signon, where the external system does not share a backing sign-on repository, such as LDAP or CAS.  See WebProxy Portlet v2 Gateway SSO.