| ColdFusion MX 7 introduces programmatic access to most ColdFusion Administrator functionality. The Administrator API (Admin API) is a set of ColdFusion Components (CFCs). These CFCs have methods that allow completion of Administrator tasks without accessing the ColdFusion Administrator (/CFIDE/administrator/index.cfm). The Administrator API CFCs are located in the cf_web_root/CFIDE/adminapi directory. You'll find nine CFCs and an Application.cfm. The CFCs represent the functional areas of the Administrator: Server Settings, Data & Services, Debugging & Logging, Extensions, Event Gateways, Security, and Enterprise Manager. The following are descriptions of the Admin API components and their functionality. administrator.cfc. Provides login and logout functions, and management of settings in the Migration and Setup Wizard. You must call the login method before calling any other methods in the Admin API. This component will typically be used only for API authentication; there is nominal need to access Migration and Setup Wizard settings. base.cfc. The base object with common methods (such as dump) inherited by all other Admin API CFCs. This component should not be accessed directly. Its methods are available via the other components. datasource.cfc. Provides ColdFusion data sources management. Allows you to add, delete, and modify data source properties, including the setup of third-party drivers. This component provides the functionality of the Data Sources page in the Data & Services section of the Administrator. It is a potentially dangerous component because it can expose all DSNs (data source names) on the server. debugging.cfc. Provides management of settings for ColdFusion debugging and logging. This component provides the functionality of the CF Administrator Debugging & Logging section. eventgateway.cfc. Provides event gateway management. This component provides the functionality of the CF Administrator Event Gateways section. extensions.cfc. Provides custom tags, ColdFusion mappings, CFXs, applets, CORBA, and Web services management. This component provides the functionality of the CF Administrator's Extensions section and the Web Services page of the Data & Services section. This component provides access to global resources (such as CF mappings, Web services, and so on), which could lead to security risks. mail.cfc. Provides management of ColdFusion mail settings. This component provides the functionality of the Mail Settings page in the CF Administrator Server Settings section. runtime.cfc. Provides management of runtime settings for caching, charting, configuration, fonts, and other settings. These are configuration settings found in the CF Administrator's Server Settings section. They are systemwide settings and should not be exposed to all users. security.cfc. Provides management of Administrator and RDS passwords, and sandbox security. This component provides the functionality of the CF Administrator Security section. serverinstance.cfc. Starts, stops, and restarts JRun server instances. This component provides the functionality of the CF Administrator Enterprise Manager section. It is only available for ColdFusion MX 7 Multiserver configuration.
TIP Debugging settings should not be enabled in production environments due to the overhead and increased response time they cause.
|
