Creates a simple task that sends a command to the entire cluster then waits for all responses. Success if determined by the lack of an Error in the callback in addition to the lack of an "error" property on each item in the results array provided by the cb from the call to send the command.

Parameters:

type String
The command type
command Object
The command to broadcast to the cluster.

`doPersistenceTasks`

(

cb

)

Defined in include/service/jobs/sites/site_deactivate_job.js:78

Update site to active as false in database to deactivate.

Parameters:

cb Function
- callback

`getChunkOfWorkPercentage`

() Number

Inherited from JobRunner: include/service/jobs/job_runner.js:153

Retrieves the chunk of work percentage

Returns:

Number:

`getId`

() String

Inherited from JobRunner: include/service/jobs/job_runner.js:128

Retrieves the unique identifier for the job

Returns:

String: The job ID

`getInitiatorTasks`

(

cb

)

Inherited from ClusterJobRunner but overwritten in include/service/jobs/sites/site_deactivate_job.js:23

Get tasks to deactivate a site.

Parameters:

cb Function
- callback function

`getSite`

() Object

Inherited from SiteJobRunner: include/service/jobs/sites/site_job_runner.js:39

Get the current site of this instance of SiteJobRunner.

Returns:

Object: the site object

`getTasks`

(

cb

)

Inherited from AsyncJobRunner but overwritten in include/service/jobs/cluster_job_runner.js:58

Retrieves the tasks to be executed by this job. The tasks provided to the callback are determined by the isInitiator property.

Parameters:

cb Function
A callback that takes two parameters: cb(Error, Object|Array)

`getWorkerTasks`

(

cb

)

Inherited from ClusterJobRunner but overwritten in include/service/jobs/sites/site_deactivate_job.js:58

Get task to stop accepting traffic for the site.

Parameters:

cb Function
- callback

`init`

(

[name]
[jobId]

)

Inherited from JobRunner: include/service/jobs/job_runner.js:113

The initialization function sets the job's name and ID as well as provide an instace of DAO.

Parameters:

[name] String optional
The job's name
[jobId] String optional
The job's unique identifier

`log`

(

message

)

Inherited from JobRunner: include/service/jobs/job_runner.js:174

Logs a message to the system logger as well as to the persistence layer. The function takes a variable number of arguments. A string message/pattern followed by the variables to fill in with that data. See util.format or the implementation for Winston loggers.

Parameters:

message String
The message or pattern to log

`onBeforeFirstTask`

(

cb

)

Inherited from AsyncJobRunner but overwritten in include/service/jobs/cluster_job_runner.js:164

Called before the start of task execution. When the property isInitiator = TRUE the onStart function is called to mark the start of the job. It is not called for others because it is assumed that workers are already part of an in-progress cluster job and that an existing job id has been provided.

Parameters:

cb Function
A callback that takes two parameters. The first is an Error (if occurred) and the second is a boolean value that indicates if the function successfully completed any pre-requsite operations before task execution begins.

`onCompleted`

(

[status]
err

)

Inherited from JobRunner: include/service/jobs/job_runner.js:258

Called once by the extending implementation when the job has completed execution whether that be successful completion or by error.

Parameters:

[status] String optional
The final status of the job. If not provided the status will default to 'COMPLETED' or 'ERRORED' when an error is provided as the second parameter.
err Error
The error, if any, that was generated by the job's execution

`onStart`

(

[status='RUNNING']

)

Inherited from JobRunner: include/service/jobs/job_runner.js:206

To be called once by the extending implmentation to mark the start of the job. The function persists the job record and makes it available to future calls to onUpdate or onComplete.

Parameters:

[status='RUNNING'] String optional
The starting status of the job

`onUpdate`

(

progressIncrement
[status]

)

Inherited from JobRunner: include/service/jobs/job_runner.js:226

To be called by the extending implmentation when progress has been made. The incremental amount of progress should be provided keeping in mind that the overall progress should not exceed 100. Optionally, the status parameter may also be included.

Parameters:

progressIncrement Integer
[status] String optional

`processClusterResults`

(

err
results
cb

)

Inherited from ClusterJobRunner but overwritten in include/service/jobs/sites/site_job_runner.js:48

Called when the tasks have completed execution and isInitiator = FALSE. The function ispects the results of each processes' execution and attempts to decipher if an error occurred. The function calls back with a result object that provides four properties: success (Boolean), id (String), pluginUid (String), results (Array of raw results).

Parameters:

err Error
- error in the process or null
results Array
- array of results from the tasks run
cb Function
- callback function

`processResults`

(

err
results
cb

)

Inherited from AsyncJobRunner but overwritten in include/service/jobs/cluster_job_runner.js:93

Called when the job has completed its assigned set of tasks. The function is responsible for processing the results and calling back with the refined result.

Parameters:

err Error
The error that occurred (if any) during task execution
results Array
An array containing the result of each executed task
cb Function
A callback that provides two parameters: The first is any error that occurred (if exists) and the second is dependent on the isInitiator property. See processClusterResults and processWorkerResults for more details.

`processWorkerResults`

(

err
results
cb

)

Inherited from ClusterJobRunner: include/service/jobs/cluster_job_runner.js:150

Called when the tasks have completed execution and isInitiator = FALSE. The function blindly passes the results of the tasks back to the callback.

Parameters:

err Error
The error that occurred (if any) during task execution
results Array
An array containing the result of each executed task
cb Function
A callback that provides two parameters: The first is any error that occurred (if exists) and the second is an array of Boolean values that indicate the success or failure of each task.

`run`

(

cb

)

Inherited from JobRunner but overwritten in include/service/jobs/async_job_runner.js:56

Kicks off the set of tasks for the job. The implementation wraps the items in a domain in an attempt to provide a level of error handling. When a qualifying error is intercepted by the domain processResults is called providing the error and all other task execution is halted.

Parameters:

cb Function

`setChunkOfWorkPercentage`

(

chunkOfWorkPercentage

)

JobRunner

Inherited from JobRunner: include/service/jobs/job_runner.js:137

Sets the portion of the over arching job that this job instance will contribute once complete.

Parameters:

chunkOfWorkPercentage Number

Returns:

JobRunner:

`setParallelLimit`

(

max

)

Inherited from AsyncJobRunner: include/service/jobs/async_job_runner.js:47

Sets the number of tasks to run in parallel

Parameters:

max Integer
The maximum number of tasks to run in parallel

`setRunAsInitiator`

(

isInitiator

)

ClusterJobRunner

Inherited from ClusterJobRunner: include/service/jobs/cluster_job_runner.js:45

Indicates if the job is to run as the initiator or a worker. When TRUE, the job sends commands to all processes in the cluster to perform the job. When FALSE, the actual job is performed on this process.

Parameters:

isInitiator Boolean

Returns:

ClusterJobRunner: This instance

`setSite`

(

options

)

Object

Inherited from SiteJobRunner: include/service/jobs/sites/site_job_runner.js:25

Set the site for an instance of SiteJobRunner.

Parameters:

options Object
-
- uid String
  - site unique id
- hostname String
  - result of site hostname edit/create
- displayName String
  - result of site display name edit/create

Returns:

Object: the instance in which the site was set.

Properties

`dao`

DAO

Inherited from JobRunner: include/service/jobs/job_runner.js:38

An instace of DAO to provide direct access to the DB if it is needed.

`id`

String

Inherited from JobRunner: include/service/jobs/job_runner.js:45

Holds the unique identifier for the job

`isInitiator`

Boolean

Inherited from ClusterJobRunner: include/service/jobs/cluster_job_runner.js:36

Indicates if the job is to run as the initiator or a worker. When TRUE, the job sends commands to all processes in the cluster to perform the job. When FALSE, the actual job is performed.

`parallelLimit`

Integer

Inherited from AsyncJobRunner: include/service/jobs/async_job_runner.js:40

The number of tasks to run in parallel

`site`

String - default to empty string

Inherited from SiteJobRunner: include/service/jobs/sites/site_job_runner.js:18

The site for this instance of SiteJobRunner

`taskFactor`

Number

Inherited from JobRunner: include/service/jobs/job_runner.js:52

The percentage of the overall work that this job accounts for. If this job is run by itself then the value should be 1. This means that 100% of the job is completed by this job. If, for example, the value is .333 then it is assumed that this job accounts for 33% or one third of the over all work necessary to complete the job. This is handy when a large job is made up of smaller jobs. This value will assist in allowing the jobs to calculate their update increments. The number must be a value between 0 (exclusive) & 1 (inclusive).

APIs

SiteDeactivateJob Class

Constructor