extensions.cfc

CFIDE.adminapi.extensions
Component extensions (extensions)

Manages custom tags, mappings, CFXs, applets, CORBA, and web services.

hierarchy: WEB-INF.cftags.component
CFIDE.adminapi.base
CFIDE.adminapi.extensions
path: {web-root}\CFIDE\adminapi\extensions.cfc
serializable: Yes
properties:
methods: deleteApplet, deleteCFX, deleteCorbaConnector, deleteCustomTagPath, deleteMapping, deleteWebService, getApplets, getCFX, getCorbaConnectors, getCustomTagPaths, getMappings, getUseOrb, getWebServices, reloadWebService, setApplet, setCorbaConnector, setCPPCFX, setCustomTagPath, setJavaCFX, setMapping, setUseOrb, setWebService, validatemapping*
inherited methods: dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – private method


t;th align=”left” colspan=”1″> deleteWebService

deleteApplet
public void deleteApplet ( string appletName
)

Deletes the specified applet.

Output: suppressed
Parameters:
appletName: string, optional, appletName – Name of applet to delete.

deleteCFX
public void deleteCFX ( cfxname
)

Deletes a CFX tag.

Output: suppressed
Parameters:
cfxname: any, optional, cfxname – CFX tag name to delete.

deleteCorbaConnector
public void deleteCorbaConnector ( required name
)

Removes a CORBA Connector from the set of registered ColdFusion CORBA Connectors.

Output: suppressed
Parameters:
name: any, required, name – Name of CORBA Connector to delete.

deleteCustomTagPath
public void deleteCustomTagPath ( required path
)

Deletes a custom tag path

Output: suppressed
Parameters:
path: any, required, path – path to custom tags

deleteMapping
public void deleteMapping ( required mapName
)

Deletes the specified ColdFusion mapping.

Output: suppressed
Parameters:
mapName: any, required, mapName – A logical path name.

public void deleteWebService ( required name
)

Deletes a ColdFusion web service.

Output: suppressed
Parameters:
name: any, required, name – Name of the web service to delete.

getApplets
public getApplets ( name
)

Return a list of all registered Java applets or a specified applet.

Output: suppressed
Parameters:
name: any, optional, name – Specifies the name of a registered Java applet.

getCFX
public struct getCFX ( cfxname
)

Lists the names of all registered CFX tags or a specified CFX tag.

Output: suppressed
Parameters:
cfxname: any, optional, cfxname – Specifies a CFX tag name.

getCorbaConnectors
public getCorbaConnectors ( name
)

Retrieves name, path, and options for CORBA Connectors.

Output: suppressed
Parameters:
name: any, optional, name – Specifies the name of a CORBA connector.

getCustomTagPaths
public array getCustomTagPaths (

)

Returns an array of paths to custom tags.

Output: suppressed

getMappings
public struct getMappings ( mapName
)

Returns ColdFusion mappings, which equate logical paths to directory paths.

Output: suppressed
Parameters:
mapName: any, optional, mapName – Specifies a logical path name.

getUseOrb
public getUseOrb (

)

Gets the name of a CORBA Object Request Broker (ORB) to use as the default.

Output: suppressed

getWebServices
public getWebServices ( name, boolean includeAutoRegistered="false"
)

Returns a structure that lists all registered ColdFusion web services or a specified web service.

Output: suppressed
Parameters:
name: any, optional, name – Specifies the name of a web service.
includeAutoRegistered: boolean, optional, includeAutoRegistered – Should the list include services not explicitly registered in the administrator

reloadWebService
public void reloadWebService ( required name, required path, username="", password=""
)

Reloads a ColdFusion web service.

Output: suppressed
Parameters:
name: any, required, name – Name of the web service to be reloaded.
path: any, required, path – URL for the WSDL.
username: any, optional, username – Web Service username.
password: any, optional, password – Web Service password.

setApplet
public void setApplet ( struct applet, string appletName
)

Registers a new Java applet.

Output: suppressed
Parameters:
applet: struct, optional, applet – Defining structure that includes subclass file, name of the JAR file, vertical and horizontal space for the applet, and so on. Keys in the structure are as follows:

  • align
  • archive
  • code
  • height
  • hspace
  • message
  • method
  • vspace
  • width
  • parameters (a structure of parameters passed to the applet)

appletName: string, optional, appletName – Name of the Java applet.

setCorbaConnector
public void setCorbaConnector ( required name, oldname, required classname, required classpath, propertyfile=""
)

Registers a CORBA Connector.

Output: suppressed
Parameters:
name: any, required, name – Name of the CORBA Connector.
oldname: any, optional, oldname
classname: any, required, classname – The class name of the connector.
classpath: any, required, classpath – The class path for the library that contains the connector.
propertyfile: any, optional, propertyfile – The file that contains the Java properties for this connector.

setCPPCFX
public void setCPPCFX ( required name, required library, description="", boolean cache="true", procedure="ProcessTagRequest"
)

Registers a C++ CFX tag.

Output: enabled
Parameters:
name: any, required, name – Name of tag, beginning with cfx_.
library: any, required, library – Path to the DLL for the tag.
description: any, optional, description – Description of tag usage.
cache: boolean, optional, cache – Indicates whether ColdFusion keeps the keep tag in memory. Specify true or false.
procedure: any, optional, procedure – Case-sensitive name of the procedure that implements the tag.

setCustomTagPath
public void setCustomTagPath ( required path
)

Defines a new path to custom tags.

Output: suppressed
Parameters:
path: any, required, path – Path to custom tags.

setJavaCFX
public void setJavaCFX ( required name, required classname, description
)

Registers a Java CFX tag.

Output: suppressed
Parameters:
name: any, required, name – Name of tag, beginning with cfx_.
classname: any, required, classname – The class name (without .class extension) that implements the interface.
description: any, optional, description – Description of tag usage.

setMapping
public void setMapping ( required mapName, required mapPath
)

Creates a ColdFusion mapping, equating a logical path to a directory path.

Output: suppressed
Parameters:
mapName: any, required, mapName – Logical path name.
mapPath: any, required, mapPath – Directory path name.

setUseOrb
public void setUseOrb ( required useOrb
)

Sets the name of a CORBA ORB to use as the default.

Output: suppressed
Parameters:
useOrb: any, required, useOrb – Name of CORBA ORB.

setWebService
public void setWebService ( required name, required path, username="", password=""
)

Adds a ColdFusion web service.

Output: suppressed
Parameters:
name: any, required, name – Name of the web service.
path: any, required, path – URL for the associated Web Service Description Language (WSDL).
username: any, optional, username – Web service username.
password: any, optional, password – Web service password.

validatemapping*
private string validatemapping ( required mapName
)

Verifies that a map name (logical path) follows the naming rules.

Output: suppressed
Parameters:
mapName: any, required, mapName – Logical path name to be validated.