Theo Rushin, Jr. Senior Web Application Developer World Singles and DoubleBlack Technologies 12/26/2015 1
About Me Application Developer and Trainer Since ‘85 ColdFusion Developer Since ‘99 Flash Developer Since ’99 Flex Developer Since ‘05 Also work with SQL, JavaScript, HTML, and CSS Currently working for WorldSingles - a subsidiary of NicheClick Media ( 12/26/2015 2
What We Will Cover Today What is the ColdFusion Administrator API? Using the CF Admin API Building the Flex 2 Interface Summary Learn More Q & A 12/26/2015 3
What is the ColdFusion Administrator API? 12/26/2015 4
What is it? It allows you to perform most ColdFusion MX administrator tasks programmatically. In ColdFusion MX 6.x you could use the “undocumented” ServiceFactory to programmatically access ColdFusion’s administrator tasks. In ColdFusion 7.x you can use the Administrator API, a set of CFCs that offer a formal and secure way of accessing that functionality. 12/26/2015 5
Why use it? You could give developers the ability to perform certain administrator tasks without having to give out the single CF Administrator password featured in ColdFusion 6.x – 7.x. Refresh Trusted Cache Maintain Datasources Refresh WebServices Shared Hosting ColdFusion 8 is still in Beta (as of 7/10/2007) 12/26/2015 6
Where to find the CF Admin CFCs? The ColdFusion Administrator API exists as a set of CFCs located in the [coldfusion_webroot]/CFIDE/adminapi/ directory. 12/26/2015 7
CF Admin API CFCs (cont.) 12/26/ CFCDescription administrator.cfcContains basic Administrator functionality, including login, logout, the Migration Wizard, and the Setup Wizard. base.cfcBase object for all other Administrator API CFCs. datasource.cfcAdd, modify, and delete ColdFusion data sources. debugging.cfcManage debug settings. eventgateway.cfcManage event gateways. extensions.cfcManage custom tags, mappings, CFXs, applets, CORBA, and web services. mail.cfcManage ColdFusion mail settings. runtime.cfcManage runtime settings for fonts, cache, charts, configuration, and other settings. security.cfcManage passwords, RDS, and sandbox security. serverinstance.cfcStart, stop, and restart JRun servers. This CFC only works when running the multiserver configuration.
What are the CF Admin Methods? You may introspect the ColdFusion Administrator API cfc’s by entering in you browser’s address bar. 12/26/2015 9
CF Admin API Methods (cont.) 12/26/ CFCDescription administrator.cfcgetAdminProperty, login, logout, setAdminProperty, etc. base.cfcisAdminUser, etc. datasource.cfcdeleteDatasource, getDatasources, setMSAccess, setMSSQL, verifyDsn, etc. debugging.cfcaddDebugEvent, deleteIP, getDebugProperty, getIPList, setIP, getLogProperty, etc. eventgateway.cfcdeleteGatewayInstance, deleteGatewayType, getGatewayInstances, etc. extensions.cfcdeleteCFX, deleteCustomTagPath, getCFX, getCustomTagPaths, getMappings, etc. mail.cfcgetMailProperty, getMailServers, setMailServer, setMailProperty, etc. runtime.cfcclearTrustedCache, getCacheProperty, getRuntimeProperty, getScopeProperty, etc. security.cfcsetUseRDSPassword, setUseAdminPassword, setEnableRDS, etc. serverinstance.cfcrestartInstance,
Using the CF Admin API 12/26/
Accessing a Component Accessing an object … … using CFML … using CFSCRIPT adminObj = createObject("component","cfide.adminapi.administrator"); 12/26/
Calling a Method Calling a method … … using CFML … using CFSCRIPT adminObj.login(“mycfadminpassword”); 12/26/
Demo – ColdFusion Show a simple ColdFusion page that allows you to set your IP address for debugging. 12/26/
Building the Flex 2 Interface 12/26/
Calling your ColdFusion Component Use the RemoteObject service to invoke your ColdFusion cfc methods The RemoteObject uses AMF (Action Message Format), a binary encoding format, over HTTP. AMF is faster and leaner than using a standard HTTP or WebService call. 12/26/
Calling your ColdFusion Component (cont.) RemoteObject service example; 12/26/
Working with the result data Most methods return simple data types. Some methods return more complex data types such as arrays. Your ColdFusion code should return more complex data types such as structures and arrays that can contain result data or error messages. 12/26/
Demo – Flex Show a simple Flex 2 application that allows you to maintain various datasources. 12/26/
Summary Pros: Developers have access to most of the ColdFusion Administrator features through code. Cons: Developers have access to most of the ColdFusion Administrator features through code. Encapsulate your code using CFCs Use ColdFusion Try/Catch blocks to capture any possible errors. Use Flex RemoteObject calls to access your components. It’s easy!!! 12/26/
Learn More Adobe Administrator API LiveDocs elp/wwhimpl/common/html/wwhelp.htm?context=Col dFusion_Documentation&file= htm elp/wwhimpl/common/html/wwhelp.htm?context=Col dFusion_Documentation&file= htm Adobe Flex 2 RemoteObject LiveDocs ing/RemoteObject.html ing/RemoteObject.html Moving data from ColdFusion CFCs to Flex 2 applications html html 12/26/
Q & A Blog: Presentation materials: 12/26/