Macromedia colfusion mx 7 Manual
Administrator API
39
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
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
setMSQL
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:
and each CFC corresponds to an area of the ColdFusion MX Administrator, as the following
table shows:
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.
directory to use the Administrator API.
There are two styles of methods in the Administrator API:
•
Method arguments
When setting complex or varied values, the Administrator API uses
method arguments.
•
Getting and setting simple values
When setting simple values, such as true or false debug
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.
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.
CFC
Description
administrator.cfc
Contains basic Administrator functionality, including login, logout, the Migration
Wizard, and the Setup Wizard. You must call the
Wizard, and the Setup Wizard. You must call the
login
method before calling
any other methods in the Administrator API.
base.cfc
Base object for all other Administrator API CFCs.
datasource.cfc
Add, modify, and delete ColdFusion data sources.
debugging.cfc
Manage debug settings.
eventgateway.cfc
Manage event gateways.
extensions.cfc
Manage custom tags, mappings, CFXs, applets, CORBA, and web services.
mail.cfc
Manage ColdFusion mail settings.
runtime.cfc
Manage runtime settings for fonts, cache, charts, configuration, and other
settings.
settings.
security.cfc
Manage passwords, RDS, and sandbox security.
serverinstance.cfc Start, stop, and restart JRun servers. This CFC only works when running the
multiserver configuration.