Skip to content

Latest commit

 

History

History
103 lines (82 loc) · 4.28 KB

README.md

File metadata and controls

103 lines (82 loc) · 4.28 KB
Raw

ColdFusion Configuration Manager

The ColdFusion Configuration Manager provides remote access to setter functions in the ColdFusion Administrator API via a very simple wrapper API.

Installation

Download the configmanager.zip file and extract to a folder named configmanager under the ColdFusion Administrator directory. You can optionally create a link to the extension by adding the following to the Administrator's custommenu.xml.

<submenu label="Configuration Manager">
    <menuitem href="configmanager/index.cfm" target="content">Recent Changes</menuitem>
</submenu>

For more information see the Custom Extensions section of the ColdFusion Administrator documentation.

Usage

Configuration

To set a configuration value simply post a JSON document to /CFIDE/administrator/configmanager/api/config.cfm including administrator credentials via basic authentication. The JSON document should identify the administrator api component, method, and method invocation arguments. For example, to call the runtime.cfc's setCacheProperty method with and argument collection of { propertyName="TrustedCache", propertyValue=true } you would post the following JSON.

{ 
    "runtime" : { 
        "cacheProperty" : [ 
            {"propertyName" : "TrustedCache", "propertyValue" : true } 
        ]
    }
}

The top level key, runtime in the above example, identifies the administrator api component. The second level key, cacheProperty in the above example, identifies the setter method to call on the administrator api component. This key contains an array of invocation arguments that will be passed to the method, so you can invoke a method several times if necessary. For example, the follow JSON document will invoke the runtime.setCacheProperty method four times, setting four distinct property values.

{ 
    "runtime" : { 
        "cacheProperty" : [ 
            {"propertyName" : "TrustedCache", "propertyValue" : true },
            {"propertyName" : "InRequestTemplateCache", "propertyValue" : true },
            {"propertyName" : "ComponentCache", "propertyValue" : true },
            {"propertyName" : "CacheRealPath", "propertyValue" : true } 
        ]
    }
}

You can also call multiple admin components as in the following example.

{ 
    "runtime" : { 
        "cacheProperty" : [ 
            {"propertyName" : "TrustedCache", "propertyValue" : true } 
        ]
    },
    "extensions" : {
        "mapping" : [
            {"mapName" : "\/test", "mapPath" : "C:\/test" }
        ]
    }
}

NOTE: The remote API relies on basic authenication, and as such should be accessed via HTTPS.

Enterprise Manager

The ColdFusion Configuration Manager also supports instance and cluster managment. To add new instances or clusters simply post a JSON document to /CFIDE/administrator/configmanager/api/entmanger.cfm. Below are sample JSON documents for the various actions:

New Local Instance

{
  "action": "addServer",
  "params": {
    "serverName": "cfusion2",
    "serverDir": "/opt/coldfusion10/cfusion2" //optional
  }
}

New Remote Instance

{
  "action": "addRemoteServer",
  "params": {
    "remoteServerName": "testRemote",
    "host": "192.168.33.12",
    "jvmRoute": "cfusion",
    "remotePort": "8012",
    "httpPort": "8005",
    "adminPort": "9443", //optional
    "adminUsername": "admin", //optional
    "adminPassword": "password", //optional
    "lbFactor": "1", //optional, default == '1'
    "https": "true" //optional, default == 'false'
  }
}

New Cluster

{
  "action": "addCluster",
  "params": {
    "clusterName": "testCluster",
    "multicastPort": "45599", // optional
    "stickySessions": "false", // optional
    "servers": "cfusion,cfusion2,testRemote" //optional
  }
}