CFIDE.adminapi.scheduler
Component scheduler (Scheduler)


Manages Scheduler tasks Services integration settings.


hierarchy: WEB-INF.cftags.component
      CFIDE.adminapi.base
            CFIDE.adminapi.scheduler
path: /opt/coldfusion/cfusion/wwwroot/CFIDE/adminapi/scheduler.cfc
serializable: Yes
properties:
final: false
abstract: false
methods: checkAllowedFileExtensions, disableCluster, findTask, getClusterDsnName, getCurrentRunningTasks, getCurrentRunningTasksNames, getTasks, setClusterDsnName, updateTask
inherited methods: dump, getEdition, getInstallType, isAdminUser, logaudit
* - private method

checkAllowedFileExtensions
public any checkAllowedFileExtensions ( required string ext )

Checks if extension is allowed or not.

Output: suppressed
Parameters:
   ext: string, required, ext

disableCluster
public void disableCluster ( )

Disables cluster setup

Output: suppressed

findTask
public any findTask ( required string task, required string group, required string mode )

Gets the detail of a given scheduled task

Output: suppressed
Parameters:
   task: string, required, task
   group: string, required, group
   mode: string, required, mode

getClusterDsnName
public any getClusterDsnName ( )

Gets the datasource for cluster setup.

Output: suppressed

getCurrentRunningTasks
public any getCurrentRunningTasks ( )

Returns current running tasks in the form of array of structs

Output: suppressed

getCurrentRunningTasksNames
public any getCurrentRunningTasksNames ( )

Returns names of current running tasks

Output: suppressed

getTasks
public any getTasks ( )

Gets all schedule tasks

Output: suppressed

setClusterDsnName
public void setClusterDsnName ( required string dsname, required boolean createtables )

Sets the datasource for cluster setup

Output: suppressed
Parameters:
   dsname: string, required, dsname
   createtables: boolean, required, createtables

updateTask
public void updateTask ( required any task )

Creates a schedule task

Output: suppressed
Parameters:
   task: any, required, task