Administrator Api - MACROMEDIA COLFUSION MX 7 - CONFIGURING AND ADMINISTERING COLDFUSION MX Manual

Administrator API

You can perform most ColdFusion MX Administrator tasks programmatically using the
Administrator API. The Administrator API consists of a set of ColdFusion components (CFCs)
that contain methods you call to perform Administrator tasks. For example, you use the
method of datasource.cfc to add a SQL Server data source.
The CFCs for the Administrator API are located in the cf_web_root/CFIDE/adminapi directory,
and each CFC corresponds to an area of the ColdFusion MX Administrator, as the following
table shows:
CFC
administrator.cfc
base.cfc
datasource.cfc
debugging.cfc
eventgateway.cfc
extensions.cfc
mail.cfc
runtime.cfc
security.cfc
serverinstance.cfc Start, stop, and restart JRun servers. This CFC only works when running the
The adminapi directory also contains an Application.cfm file and two subdirectories.
Note: If you are using sandbox security, you must enable access to the cf_web_root/CFIDE/adminapi
directory to use the Administrator API.
There are two styles of methods in the Administrator API:
•
Method arguments
method arguments.
•
Getting and setting simple values
settings, the Administrator API uses get and set property methods.
To view the methods, method arguments, and documentation for the Administrator API CFCs,
use the CFC Explorer. For example, to view datasource.cfc when running in the server
configuration, open a browser to http://localhost:8500/CFIDE/adminapi/datasource.cfc.
Description
Contains basic Administrator functionality, including login, logout, the Migration
Wizard, and the Setup Wizard. You must call the
any other methods in the Administrator API.
Base object for all other Administrator API CFCs.
Add, modify, and delete ColdFusion data sources.
Manage debug settings.
Manage event gateways.
Manage custom tags, mappings, CFXs, applets, CORBA, and web services.
Manage ColdFusion mail settings.
Manage runtime settings for fonts, cache, charts, configuration, and other
settings.
Manage passwords, RDS, and sandbox security.
multiserver configuration.
When setting complex or varied values, the Administrator API uses
When setting simple values, such as true or false debug
setMSQL
method before calling
login

Administrator API

39