Difference between revisions of "Proxy White List"
(Created page with '==Overview== The goal of the Proxy White list is to allow you as a developer control over which methods within your application can be called through the [[Ajax Proxy|Ajax Proxy]…') |
(→Site Level Proxy White List) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
| − | The goal of the Proxy White list is to | + | The goal of the Proxy White list is to give you (as a developer) control over which methods within your application can be called through the [[Ajax Proxy|Ajax Proxy]]. |
| − | There are | + | There are three types of Proxy White Lists: |
# ADF Library Proxy White List | # ADF Library Proxy White List | ||
# App Proxy White List | # App Proxy White List | ||
| + | # Site Level Proxy White List | ||
== ADF Library Proxy White List == | == ADF Library Proxy White List == | ||
| Line 12: | Line 13: | ||
== App Proxy White List == | == App Proxy White List == | ||
| − | The App Proxy White List is an | + | The App Proxy White List is an application-specific list of methods that are accessible through Ajax. Each app can have its own Proxy White List file; however, all of the Apps and ADF Library White List files are combined to create one master list of components accessible through Ajax calls. An App Proxy White list file is located in your apps /components/ directory: |
/ADF/apps/pt_profile/components/proxyWhiteList.xml | /ADF/apps/pt_profile/components/proxyWhiteList.xml | ||
| + | |||
| + | == Site Level Proxy White List == | ||
| + | If you have components at your site level (/mySite/_cs_apps/components) that you call via Ajax Proxy (e.g. custom Choosers), then you will need a site level Proxy White List. The Proxy White list for the site level will exist in the site config folder: | ||
| + | |||
| + | /mySite/_cs_apps/config/proxyWhiteList.xml | ||
| + | |||
| + | Any time a change is made to the XML file itself, either adding or deleting entries, the ADF has to be [[Reset ADF|reset]]. | ||
| + | |||
| + | == Sample proxyWhiteList == | ||
| + | Here is a sample: | ||
| + | |||
| + | <pre> | ||
| + | <?xml version="1.0" encoding="utf-8"?> | ||
| + | <settings> | ||
| + | <CEData_1_0>deleteCE,getFormIDByCEName</CEData_1_0> | ||
| + | <CSData_1_0>getSiteTemplates,getSubsiteStruct,getPagesBySubsiteID,getPageDataArray</CSData_1_0> | ||
| + | <AjaxService_1_0>addSubsite,loadGeneralChooser</AjaxService_1_0> | ||
| + | <Forms_1_0>renderAddEditForm,renderDeleteForm</Forms_1_0> | ||
| + | <Lightbox_1_0>getDivLayersHTML</Lightbox_1_0> | ||
| + | <link_builder>htmlAddEditLinkBuilder,renderLinks,listManagement,removeLink</link_builder> | ||
| + | <utils_1_0>getCFTypes,scriptExists,getFieldTypes,updateCustomFieldType</utils_1_0> | ||
| + | </settings> | ||
| + | </pre> | ||
| + | |||
| + | [[Category: Security]] | ||
Latest revision as of 18:39, 18 November 2010
Contents
Overview
The goal of the Proxy White list is to give you (as a developer) control over which methods within your application can be called through the Ajax Proxy.
There are three types of Proxy White Lists:
- ADF Library Proxy White List
- App Proxy White List
- Site Level Proxy White List
ADF Library Proxy White List
The goal of the global white list is to control all of the components within the library that are accessible through Ajax. The global ADF Library Proxy White List is located here:
/ADF/lib/ajax/proxyWhiteList.xml
App Proxy White List
The App Proxy White List is an application-specific list of methods that are accessible through Ajax. Each app can have its own Proxy White List file; however, all of the Apps and ADF Library White List files are combined to create one master list of components accessible through Ajax calls. An App Proxy White list file is located in your apps /components/ directory:
/ADF/apps/pt_profile/components/proxyWhiteList.xml
Site Level Proxy White List
If you have components at your site level (/mySite/_cs_apps/components) that you call via Ajax Proxy (e.g. custom Choosers), then you will need a site level Proxy White List. The Proxy White list for the site level will exist in the site config folder:
/mySite/_cs_apps/config/proxyWhiteList.xml
Any time a change is made to the XML file itself, either adding or deleting entries, the ADF has to be reset.
Sample proxyWhiteList
Here is a sample:
<?xml version="1.0" encoding="utf-8"?>
<settings>
<CEData_1_0>deleteCE,getFormIDByCEName</CEData_1_0>
<CSData_1_0>getSiteTemplates,getSubsiteStruct,getPagesBySubsiteID,getPageDataArray</CSData_1_0>
<AjaxService_1_0>addSubsite,loadGeneralChooser</AjaxService_1_0>
<Forms_1_0>renderAddEditForm,renderDeleteForm</Forms_1_0>
<Lightbox_1_0>getDivLayersHTML</Lightbox_1_0>
<link_builder>htmlAddEditLinkBuilder,renderLinks,listManagement,removeLink</link_builder>
<utils_1_0>getCFTypes,scriptExists,getFieldTypes,updateCustomFieldType</utils_1_0>
</settings>
