Configuration Examples

Proxying Google

This example will proxy Google but clicks on search results will not be proxied. The HTTP timeout is set to ensure that if Google is unreachable the portlet will not hang indefinitely waiting to connect.

edu.wisc.my.webproxy.webproxy.general.config.sBaseUrlhttp://www.google.com
edu.wisc.my.webproxy.webproxy.general.config.sPortletUrlgoogle\.com
edu.wisc.my.webproxy.webproxy.general.config.sPortletStateNORMAL
edu.wisc.my.webproxy.webproxy.general.config.sListTypeINCLUDE
edu.wisc.my.webproxy.webproxy.httpclient.httpTimeout5

Full Configuration Options List

Preference NameValue TypeDescription
General Preferences
edu.wisc.my.webproxy.webproxy.general.config.sBaseUrlsingleThe initial URL to proxy
edu.wisc.my.webproxy.webproxy.general.config.sEditUrlsingleThe URL to display in the EDIT PortletMode
edu.wisc.my.webproxy.webproxy.general.config.sPortletUrlmultiAn ordered list of regular expressions used to match URLs for proxying
edu.wisc.my.webproxy.webproxy.general.config.sPortletStatemultiThe portlet WindowState the URL that matches the expression should be rendered in
edu.wisc.my.webproxy.webproxy.general.config.sListTypesingleIf the list is an include list (matched URLs are re
edu.wisc.my.webproxy.webproxy.general.config.funcNameUrlRegExmultiAn ordered list of regular expressions used to match URLs for proxying and rendering with an fname target
edu.wisc.my.webproxy.webproxy.general.config.funcNameUrlStatesmultiThe portlet WindowState the URL that matches the fname expression should be rendered in
edu.wisc.my.webproxy.webproxy.general.config.funcNameListTypesingleIf the fname expression list is an include list (matched URLs are re
edu.wisc.my.webproxy.webproxy.general.config.funcNameTargetsingleThe fname to target with proxied fname urls
edu.wisc.my.webproxy.webproxy.general.config.sPreInterceptorsingleThe class to use as a pre
edu.wisc.my.webproxy.webproxy.general.config.sPostInterceptorsingleThe class to use as a post
Caching Preferences
edu.wisc.my.webproxy.webproxy.cache.useCachesingleTRUE to enable content caching, FALSE to disable content caching
edu.wisc.my.webproxy.webproxy.cache.cacheTimeOutsingleHow long in seconds the cached content is valid for (
edu.wisc.my.webproxy.webproxy.cache.useExpiredsingleTRUE to used expired cached content if the proxied site cannot be reached, FALSE will show a failure if the cached content is expired and the proxied site cannot be reached
edu.wisc.my.webproxy.webproxy.cache.retryDelaysingleHow long in seconds after a failed request to the proxied site before the request is retried
edu.wisc.my.webproxy.webproxy.cache.persistCachesingleTRUE to persist the cached content to a database, FALSE to only store cached content in memory
Commons HTTP Client Preferences
edu.wisc.my.webproxy.webproxy.httpclient.httpTimeoutsingleHTTP Socket Connect timeout
edu.wisc.my.webproxy.webproxy.httpclient.redirectssingleThe maximum number of redirects to follow
edu.wisc.my.webproxy.webproxy.httpclient.sAuthTypesingleIf Authentication is enabled, the type of authentication to perform [BASIC, NTLM or FORM]
edu.wisc.my.webproxy.webproxy.httpclient.sAuthenticationUrlsingleThe URL to authenticate to if different than the application URL
edu.wisc.my.webproxy.webproxy.httpclient.authEnablesingleIf Authentication is needed for the proxied application [true or false]
edu.wisc.my.webproxy.webproxy.httpclient.userNamesingleIf BASIC or NTLM authentication the username to use
edu.wisc.my.webproxy.webproxy.httpclient.promptUserNamesingleIf not specifying a userName should the portal user be propmted for the username
edu.wisc.my.webproxy.webproxy.httpclient.persistUserNamesingleIf prompting for the username should it be stored in the PortletPreferences for the user so they don't need to provide it during a later session [true or false]
edu.wisc.my.webproxy.webproxy.httpclient.passwordsingleIf BASIC or NTLM authentication the password to use
edu.wisc.my.webproxy.webproxy.httpclient.promptPasswordsingleIf not specifying a password should the portal user be propmted for the password
edu.wisc.my.webproxy.webproxy.httpclient.persistPasswordsingleIf prompting for the password should it be stored in the PortletPreferences for the user so they don't need to provide it during a later session [true or false]
edu.wisc.my.webproxy.webproxy.httpclient.sessionKeysingleIf the proxied application's session should be shared with other instances of the WebProxy portlet enter a the key to use for sharing here
edu.wisc.my.webproxy.webproxy.httpclient.sessionPersistenceEnablesingleIf the proxied application's session should be persisted for re
edu.wisc.my.webproxy.webproxy.httpclient.domainsingleIf NTLM authentication the domain to use
edu.wisc.my.webproxy.webproxy.httpclient.promptDomainsingleIf not specifying a domain should the portal user be propmted for the domain
edu.wisc.my.webproxy.webproxy.httpclient.persistDomainsingleIf prompting for the domain should it be stored in the PortletPreferences for the user so they don't need to provide it during a later session [true or false]
edu.wisc.my.webproxy.webproxy.httpclient.sessionTimeoutsingleThe timeout of the proxied application's session in minutes
edu.wisc.my.webproxy.webproxy.httpclient.sDynamicParameterNamesmultiIf FORM authentication an ordered list of form parameter names to prompt the user for before authentication
edu.wisc.my.webproxy.webproxy.httpclient.sDynamicParameterValuesmultiIf FORM authentication an ordered list of form parameter values entered by the user, if persistence for the parameter name is enabled
edu.wisc.my.webproxy.webproxy.httpclient.sDynamicParameterPersistmultiIf FORM authentication an ordered list of [true or false] flags indicating if each named dynamic parameter should be persisted after the user enters it
edu.wisc.my.webproxy.webproxy.httpclient.sDynamicParameterSensitivemultiIf FORM authentication an ordered list of [true or false] flags indicating if the prompt for the user should be displayed as a PASSWORD input instead of a TEXT input
edu.wisc.my.webproxy.webproxy.httpclient.sStaticParameterNamesmultiIf FORM authentication an ordered list of form parameter names to send when authenticating
edu.wisc.my.webproxy.webproxy.httpclient.sStaticParameterValuesmultiIf FORM authentication an ordered list of form parameter values to send when authenticating
HTTP Header Preferences
edu.wisc.my.webproxy.webproxy.httpheader.sHeaderNamemultiAn ordered list of HTTP header names to send with every request, the value for each name is found in the corresponding position of the sHeaderValue preference
edu.wisc.my.webproxy.webproxy.httpheader.sHeaderValuemultiAn ordered list of HTTP header values to send with every request
Static Content Preferences
edu.wisc.my.webproxy.webproxy.statichtml.sStaticHeadersingleA HTML snippet to print before every proxied page
edu.wisc.my.webproxy.webproxy.statichtml.sStaticFootersingleA HTML snippet to print after every proxied page
Content Clipping Preferences
edu.wisc.my.webproxy.webproxy.clipping.sClippingDisablesingleTRUE to enable content clipping, FALSE to disable content clipping
edu.wisc.my.webproxy.webproxy.clipping.sXPathmultiA list of XML paths (not XPath) used for clipping content, while the expression is matched by the position in the document content is allowed through
edu.wisc.my.webproxy.webproxy.clipping.sCommentmultiA list of comments to use for clipping content, while between each matching comment content is let through
edu.wisc.my.webproxy.webproxy.clipping.sElementmultiA list of elements to use for clipping content, while between each matching element content is let through
HTML Parser Preferences
edu.wisc.my.webproxy.webproxy.htmlparser.sScriptStripCommentsingleShould comments containing javascript be stripped from the output [true or false]
edu.wisc.my.webproxy.webproxy.htmlparser.sInsertDocTypesingleShould a DOCTYPE entry be inserted in the output [true or false]
edu.wisc.my.webproxy.webproxy.htmlparser.sBalanceTagssingleShould the parser attempt to balance the HTML tags [true or false]
edu.wisc.my.webproxy.webproxy.htmlparser.sStripCommentssingleShould comments be stripped from the output [true or false]
edu.wisc.my.webproxy.webproxy.htmlparser.sReportErrorssingleShould parse errors be reported, just causes them to be logged [true or false]