Mediator

Mediator: Mediates actions across a set of Deployments

Documentation

Documentation is available on the ControlTier Wiki: Core Type Guide - Mediator

Super Type

Deployment

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory
Data View	Children, proximity: 1
Logger Name

Allowed Child Dependencies

• DefaultAllowMultiplePackageMatches¹
• DefaultFailIfPackageNotReplaced¹
• DefaultPackageName¹
• DefaultPackageType¹
• Deployment
• DispatchBaseType ¹
• DispatchChangeDependencies ¹
• DispatchExecutionStrategy ¹
• DispatchOptions ¹
• DispatchResourceName ¹
• DispatchResourceType ¹
• DispatchSortOrder ¹
• DispatchThreadCount ¹
• MediatorNotificationList ¹

¹: These types have a Singleton constraint. Only one instance may be added as a resource.

Defaults for Imported Attributes

Name	Default	Description
defaultDeploymentType	Deployment	Used by runChangeDependencies to match any Deployment sub-type
dispatchBaseType	(?:deployment|service|mediator)	Used by dispatchCmd to match any object that is a Deployment or Service
dispatchChangeDependencies	false	Specifies if Change-Dependencies should dispatch the command to the subordiante objects
dispatchExecutionStrategy	nodedispatch	Used by dispatchCmd option: -strategy
dispatchOptions		Used by dispatchCmd option: -dispatchOptions
dispatchResourceName	.*	Used by dispatchCmd to match any object name
dispatchResourceType	[^\.]*	Used by dispatchCmd to match any object type
dispatchSortOrder	ascending	Used by dispatchCmd option: -sortorder
MediatorNotificationList		Used by Update to send notification emails
threadCount	1	Defaults to sequential execution.

View the available commands in the User Reference.

The following types are defined for use with Mediator.

DispatchBaseType

Overview

DispatchBaseType: A setting to used to default dispatchCmd option: -resourceorder

Used by the dispatchCmd option -resourceorder <> argument. This must be a valid regex used to match base types for child dependency objects.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	[^\.] deployment mediator service	[^\.]	false

Attributes

Exported Attributes

Name	Property
dispatchBaseType	settingValue

DispatchChangeDependencies

Overview

DispatchChangeDependencies: A setting to determine whether Change-Dependencies is run locally or dispatched to resources

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	false true	false	false

Attributes

Exported Attributes

Name	Property
dispatchChangeDependencies	settingValue

DispatchExecutionStrategy

Overview

DispatchExecutionStrategy: A setting to used to define DispatchCommand option: -strategy

Used by the dispatchCmd command option -strategy <> argument. Specifies what algorithm to use to execute the dispatched command. If "nodedispatch" strategy is specified, a remote command will be executed to invoke the command on remote objects. If "localdispatch" strategy is specifed, command to only local objects will be dispatched. Internally, this value sets the "strategy" attribute in the ExecuteAction element used by the CTL Controller task.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	localdispatch nodedispatch	nodedispatch	false

Attributes

Exported Attributes

Name	Property
dispatchExecutionStrategy	settingValue

DispatchOptions

Overview

DispatchOptions: A setting to used to default dispatchCmd option: -dispatchOptions

Used by the dispatchCmd option -dispatchOptions <> argument. This comma separated list of options are passed to commands executed by child objects.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	true		false

Attributes

Exported Attributes

Name	Property
dispatchOptions	settingValue

DispatchResourceName

Overview

DispatchResourceName: A setting to used to default dispatchCmd option: -resourcename

Used by the dispatchCmd option -resourcename <> argument. This must be a valid regex used to match object names for child dependency objects.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	.*		false

Attributes

Exported Attributes

Name	Property
dispatchResourceName	settingValue

DispatchResourceType

Overview

DispatchResourceType: A setting to used to default dispatchCmd option: -resourcetype

Used by the dispatchCmd option -resourcetype <> argument. This must be a valid regex used to match type names for child dependency objects.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	[^\.]	[^\.]	false

Attributes

Exported Attributes

Name	Property
dispatchResourceType	settingValue

DispatchSortOrder

Overview

DispatchSortOrder: A setting to used to default dispatchCmd option: -sortorder

Used by the dispatchCmd option -sortorder <> argument. Specifies how the child objects are sorted. Defaults to "ascending".

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	ascending descending	ascending	false

Attributes

Exported Attributes

Name	Property
dispatchSortOrder	settingValue

DispatchThreadCount

Overview

DispatchThreadCount: A setting to used to default dispatchCmd option: -threadcount

Used by the dispatchCmd option -threadcount <> argument. Must be an integer value. Internally this is used to set the threadCount attribute in the Ant Parallel task.

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator

Allowed Property Values

Property	Allowed Values	Default	Enforced
settingValue	1 2 3 4 5	1	false

Attributes

Exported Attributes

Name	Property
threadCount	settingValue

MediatorNotificationList

Overview

MediatorNotificationList: Comma-separate list of notification email addresses

Design

Super Type

MediatorSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Attributes

Exported Attributes

Name	Property
mediatorNotificationList	settingValue

MediatorSetting

Overview

MediatorSetting: A generic configuration setting for a Mediator

Design

Super Type

Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• Mediator