The content of this page was adopted from the README.txt file included with WebProxy portlet. Please note that there are several places where "????" notation was used because no reasonable value was known as of this writing. Perhaps someone may be able to fill those in.
...
- Base URL (REQUIRED): The Base URL is the starting point of the proxied application and will be the first page proxied for the end user after authentication.
edu.wisc.my.webproxy.webproxy.general.config.sBaseUrl- This value must contain the protocol of the URL. (e.g., http://www.foo.bar/, http://foo.bar/example.html)
- This value may include placeholders for user attributes (e.g. http://www.foo.bar/${uid} becomes http://www.foo.bar/admin for the admin user at run time). User attributes used in this way must be declared in portlet.xml.
- Edit URL (OPTIONAL): This URL will provide a link that will allow the end user to configure the proxied web-application for their own personal needs. This value must also contain the protocol. (e.g., http://foo.bar/edit.html)
edu.wisc.my.webproxy.webproxy.general.config.sEditUrl - URL Rewrite Masks (OPTIONAL): Must contain the URLs of the web application you would like or would not like to be proxied, depending on the URL List Type (see below). The portlet URL list uses regular expressions for matching. (e.g., .foo.)
edu.wisc.my.webproxy.webproxy.general.config.sPortletUrl - URL List Type: This value is set to Include by default. This value will designate how the portlet will read the Portlet Url list. If this value is set to Include,the portlet will rewrite and proxy all matching URL expressions in the list. If set to Exclude, the portlet will proxy all the sites that do not match the URL expressions listed.
edu.wisc.my.webproxy.webproxy.general.config.sListType - Target FName (OPTIONAL): Functional name of another channel to redirect the user to where a functional URL rewrite mask matches the URL.
edu.wisc.my.webproxy.webproxy.general.config.funcNameTarget Functional URL Rewrite Masks (OPTIONAL): Regular expression(s) matching URLs which should trigger a redirect of the user to another channel. If matched (or not matched, depending on the "FName URL List Type" setting) the user is redirected to the channel identified by the functional name specified in the field "Target FName".
edu.wisc.my.webproxy.webproxy.general.config.funcNameUrlRegEx
- Functional URL list type: This value is set to Include by default. This value will designate how the portlet will read the Functional URL Rewrite Masks. If this value is set to Include, the portlet will redirect the user to the alternative channel for all matching URL expressions in the list. If set to Exclude, the portlet will redirect when the sites does not match the URL expressions listed.
edu.wisc.my.webproxy.webproxy.general.config.sListType
edu.wisc.my.webproxy.webproxy.general.config.funcNameListType - Pre-Interceptor class (Optional): This is an optional configuration that can be used to manipulate the http request before it is sent to the web-application. This will require a custom class file to use. (e.g. edu.wisc.my.webproxy.CPreInterceptor)
edu.wisc.my.webproxy.webproxy.general.config.sPreInterceptor - Post-Interceptor class (Optional): This is an optional configuration that can be used to manipulate the http response after it is received from the web-application. This will require a custom class file to use. (e.g. edu.wisc.my.webproxy.CPostInterceptor)
edu.wisc.my.webproxy.webproxy.general.config.sPostInterceptor
...
- Use Cache (Optional) : Select this if you would like to enable the Authenticated WebProxy cache. Values: true, false (default).
edu.wisc.my.webproxy.webproxy.cache.useCache - Cache Timeout Scope (Optional): The amount of seconds you would like the cache to be valid for.
If edu.wisc.my.webproxy.webproxy.cache.user is selected, the cache will only be valid for the end portal user. If edu.wisc.my.webproxy.webproxy.cache.cacheTimeOutUse expired data if the remote server is not responding (Optional): If selected the portal will use expired data if application is selected, all users will share the data stored in cache. Default: edu.wisc.my.webproxy.webproxy.cache.user
edu.wisc.my.webproxy.webproxy.cache.cacheScope - Cache Timeout (Optional): The amount of seconds you would like the cache to be valid for.
edu.wisc.my.webproxy.webproxy.cache.cacheTimeOut - Use expired data if the remote server is not responding (Optional): If selected the portal will use expired data if the remote server stops responding. If selected, you must designate the amount of seconds Authenticated Web Proxy will wait before trying to contact the non-responding servers.before trying to contact the non-responding servers. Values: true, false (default).
edu.wisc.my.webproxy.webproxy.cache.useCExpired - Retry Delay (Optional): If an HTTP timeout occurred, edu.wisc.my.webproxy.webproxy.cache.useCExpired = true, this value is the amount of seconds you would like to wait (e.g. retain the item in cache) before another attempt is made by a future request to access the resource. Default: 0 (do not retain cached data so next request should retry)
edu.wisc.my.webproxy.webproxy.cache.useCExpiredretryDelay - Persist Cache (Optional): If you would like to keep the cache beyond the user's session.
edu.wisc.my.webproxy.webproxy.cache.persistCacheCache Scope (Optional): If User is selected, the cache will only be valid for the end portal user. If Application is selected, all users will share the data stored in cachethe cache beyond the user's HTTP session. Makes sense only with user caching. Values: true, false. NOTE: It does not appear that EhPageCache.java actually uses this value and persists to a store.
edu.wisc.my.webproxy.webproxy.cache.????persistCache
...
HTTP Headers
- Header name value pair: This provides a list of Header Names and their corresponding value you would like to be included in all Http Requests.
edu.wisc.my.webproxy.webproxy.httpheader.sHeaderName and edu.wisc.my.webproxy.webproxy.httpheader.sHeaderValue
...