Java Doc for CWebProxy.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » channels » webproxy » Java Source Code / Java DocumentationJava Source Code and Java Documentation

A channel which transforms and interacts with dynamic XML or HTML. See docs/website/developers/channel_docs/reference/CwebProxy.html for full documentation.

Static and Runtime Channel Parameters: These parameters can be configured both as ChannelStaticData parameters and as ChannelRuntimeData parameters. These static parameters can be updated by equivalent Runtime parameters. Caching parameters can also be changed temporarily. Cache defaults and IPerson restrictions are loaded first from properties, and overridden by static data if there.

1. "cw_xml" - a URI for the source XML document. By default, must be an http:// or https:// URI, though this requirement is configurable via ChannelStaticData parameters.
2. "cw_xslTitle" - a title representing the stylesheet (optional) If no title parameter is specified, a default stylesheet will be chosen according to the media
3. "cw_cacheDefaultMode" - Default caching mode. May be none (normally don't cache), or all (cache everything).
4. "cw_cacheDefaultTimeout" - Default timeout in seconds.
5. "cw_cacheMode" - override default for this request only. Primarily intended as a runtime parameter, but can used statically to override the first instance.
6. "cw_cacheTimeout" - override default for this request only. Primarily intended as a runtime parameter, but can be used statically to override the first instance.

Static Channel Parameters: These parameters can be configured only as ChannelStaticData parameters. They can no longer (as of uPortal 2.5.1) be changed at runtime. This closes some serious security vulnerabilities wherein the Adversary would manipulate these parameters at runtime to access resources on the local filesystem.

1. "cw_ssl" - a URI specifying the corresponding .ssl (stylesheet list) file
2. "cw_xsl" - a URI specifying the stylesheet to use If cw_xsl is supplied, cw_ssl and cw_xslTitle will be ignored.
3. "cw_passThrough" - indicates how RunTimeData is to be passed through. If cw_passThrough is supplied, and not set to "all" or "application", additional RunTimeData parameters not starting with "cw_" or "upc_" will be passed as request parameters to the XML URI. If cw_passThrough is set to "marked", this will happen only if there is also a RunTimeData parameter of cw_inChannelLink. "application" is intended to keep application-specific links in the channel, while "all" should keep all links in the channel. This distinction is handled entirely in the URL Filters.
4. "cw_tidy" - output from xmlUri will be passed though Jtidy
5. "cw_info" - a URI to be called for the info event.
6. "cw_help" - a URI to be called for the help event.
7. "cw_edit" - a URI to be called for the edit event.
8. "cw_person" - IPerson attributes to pass. A comma-separated list of IPerson attributes to pass to the back end application. The static data value will be passed on all requests except some refresh requests.
9. "cw_personAllow" - Restrict IPerson attribute passing to this list. A comma-separated list of IPerson attributes that may be passed via cw_person. An empty or non-existent value means use the default value from the corresponding property. The special value "*" means all attributes are allowed. The value "!*" means none are allowed. Static data only.
10. "upc_localConnContext" - LocalConnectionContext implementation class. The name of a class to use when data sent to the backend application needs to be modified or added to suit local needs. Static data only.
11. "cw_allow_uri_prefixes" - permitted URI prefixes. Optional static data only parameter specifying allowable prefixes for URIs accessed by this channel. This channel will only use URIs with these prefixes for obtaining XML and XSLT for use in rendering. Whitespace delimit allowed prefixes. Effectively defaults to "http:// https://"; do not allow "file:/" lightly.
12. "cw_block_uri_prefixes" - blocked URI prefixes. Optional static data only parameter further restricting which URIs this channel will use to obtain XML and XSLT. This channel will not use URIs matching prefixes specified in this whitespace- delimited parameter. Effectively defaults to "".
13. "cw_restrict_xmlUri_inStaticData" - Optional parameter specifying whether the xmlUri should be restricted according to the allow and deny prefix rules above as presented in ChannelStaticData or just as presented in ChannelRuntimeData. "true" means both ChannelStaticData and ChannelRuntimeData will be restricted. Any other value or the parameter not being present means only ChannelRuntimeData will be restricted. It is important to set this value to true when using subscribe-time channel parameter configuration of the xmlUri.

Runtime Channel Parameters:

1. "cw_reset" - an instruction to return to reset internal variables. The value return resets cw_xml to its last value before changed by button events. The value "reset" returns all variables to the static data values.
2. "cw_download" - use download worker for this link or form any link or form that contains this parameter will be handled by the download worker, if the pass-through mode is set to rewrite the link or form. This allows downloads from the proxied site to be delivered via the portal, primarily useful if the download requires verification of a session referenced by a proxied cookie

This channel can be used for all XML formats with appropriate stylesheets. All static data parameters as well as additional runtime data parameters passed to this channel via HttpRequest will in turn be passed on to the XSLT stylesheet as stylesheet parameters. They can be read in the stylesheet as follows: <xsl:param name="yourParamName">aDefaultValue</xsl:param>