ScenarioServiceConfig is a helper class that assists in building a properies map for use when creating a new ScenarioService via the ScenarioServiceFactory. More...

Static Public Member Functions
static void	SetAckDataTimeout (Dictionary< string, object > properties, long timeout)
	Set the timeout for operations to wait for the Data channel to catch up. More...

static void	SetAutoInstanceDiscovery (System.Collections.IDictionary properties, bool autoInstanceDiscovery)
	Set the boolean configuration property to indicate if the service should discover instances automatically. More...

static void	SetDisconnectIfSlow (Dictionary< string, object > properties, bool disconnectIfSlow)
	Set the boolean configuration property to indicate if our event receiver should be disconnected if slow. More...

static void	SetReconnectPeriod (Dictionary< string, object > properties, long reconnectPeriod)
	Set the long configuration property to set how long to wait between reconnection attempts More...

static void	SetScenarioExclusionFilter (Dictionary< string, object > properties, ICollection< string > scenarioExclusionFilter)
	Set the configuration property to the Set of ScenarioID's that the client wishes to ignore. Note that this property is ignored if an inclusion filter is used. More...

static void	SetScenarioInclusionFilter (Dictionary< string, object > properties, ICollection< string > scenarioInclusionFilter)
	Set the configuration property to the Set of ScenarioID's in which the client is interested. Note that if this property is used, any exclusion filter will be ignored. More...

static void	SetStrongDataInboundEventQueue (Dictionary< string, object > properties, bool strong)
	Set the boolean configuration property to indicate if the 'Data' channels (EventServiceChannel's), created for listening to scenario instance output variable updates, should use strong or soft references to events in the inbound event queue. More...

static void	SetUseRawDataChannel (Dictionary< string, object > properties, bool useRawData)
	Set the boolean configuration property to indicate if the 'Data' channels (EventServiceChannel's), created for listening to scenario instance output variable updates, should be subscribed to the normal Data channel (possibly throttled), or the Raw Data channel (always unthrottled). More...

static void	SetUserNameFilter (System.Collections.IDictionary properties, string owner)
	Set the configuration property to filter by a given user More...

Detailed Description

ScenarioServiceConfig is a helper class that assists in building a properies map for use when creating a new ScenarioService via the ScenarioServiceFactory.

Note that EventServiceChannel configuration properties are also valid configuration properties for a ScenarioService, and will be applied to any channel created by the ScenarioService.

Any configuration property not explicitly specified will take its default value. Defaults are available for all configuration properties, in the same interface as the property.

See also: Apama.Services.Event.ChannelConfig

Member Function Documentation

static void Apama.Services.Scenario.ScenarioServiceConfig.SetAckDataTimeout	(	Dictionary< string, object >	properties,
		long	timeout
	)

static

Set the timeout for operations to wait for the Data channel to catch up.

Operations (Create, Edit, Delete) only complete once the Updates from the Data channel have been processed up to the point of that operation. Thus, if there are a lot of updates from scenario instances, a number of updates will be queued up, and any from before the operation will be processed before the update from the operation. This wait will time out if the data channel is too congested - the changes will still be seen, but after the operation has completed

Note that operations are "fail fast" - if an operation fails, the failure notification is delivered on the control channel, so the operation call will return quickly. Other operations can also be performed while waiting for the operation to complete.

Parameters

properties	The Map in which the configuration properties should be updated.
timeout	the new value for the timeout

See also: ScenarioServiceConstants.ConfigAckDataTimeout

See also: ScenarioServiceConstants.DefaultAckDataTimeout

static void Apama.Services.Scenario.ScenarioServiceConfig.SetAutoInstanceDiscovery	(	System.Collections.IDictionary	properties,
		bool	autoInstanceDiscovery
	)

static

Set the boolean configuration property to indicate if the service should discover instances automatically.

Parameters

properties	The Map in which the configuration properties should be updated.
autoInstanceDiscovery	The new value of the property.

static void Apama.Services.Scenario.ScenarioServiceConfig.SetDisconnectIfSlow	(	Dictionary< string, object >	properties,
		bool	disconnectIfSlow
	)

static

Set the boolean configuration property to indicate if our event receiver should be disconnected if slow.

The disconnect if slow property is only set when a connection is made between components; thus if any receiver, via scenario service, event service or other API, from this process (more exactly, this classloader) has been made, then that connection's disconnect if slow property will be used.

It is not (currently) possible to change the disconnect if slow property of a connection.

Connections to different correlators can use different values of this property.

Parameters

properties	The Map in which the configuration properties should be updated.
disconnectIfSlow	The new value of the property.

static void Apama.Services.Scenario.ScenarioServiceConfig.SetReconnectPeriod	(	Dictionary< string, object >	properties,
		long	reconnectPeriod
	)

static

Set the long configuration property to set how long to wait between reconnection attempts

The reconnect period property sets the minimum time to wait between reconnects

Parameters

properties	The Map in which the configuration properties should be updated.
reconnectPeriod	The new value of the property.

static void Apama.Services.Scenario.ScenarioServiceConfig.SetScenarioExclusionFilter	(	Dictionary< string, object >	properties,
		ICollection< string >	scenarioExclusionFilter
	)

static

Set the configuration property to the Set of ScenarioID's that the client wishes to ignore. Note that this property is ignored if an inclusion filter is used.

Parameters

properties	The Map in which the configuration properties should be updated.
scenarioExclusionFilter	The new value of the property.

See also: ScenarioServiceConstants.ConfigScenarioExclusionFilter

See also: ScenarioServiceConstants.DefaultScenarioExclusionFilter

See also: SetScenarioInclusionFilter(Dictionary<string,object>,ICollection<string>)

static void Apama.Services.Scenario.ScenarioServiceConfig.SetScenarioInclusionFilter	(	Dictionary< string, object >	properties,
		ICollection< string >	scenarioInclusionFilter
	)

static

Set the configuration property to the Set of ScenarioID's in which the client is interested. Note that if this property is used, any exclusion filter will be ignored.

Parameters

properties	The Map in which the configuration properties should be updated.
scenarioInclusionFilter	The new value of the property.

See also: ScenarioServiceConstants.ConfigScenarioInclusionFilter

See also: ScenarioServiceConstants.DefaultScenarioInclusionFilter

See also: SetScenarioExclusionFilter(Dictionary<string,object>,ICollection<string>)

static void Apama.Services.Scenario.ScenarioServiceConfig.SetStrongDataInboundEventQueue	(	Dictionary< string, object >	properties,
		bool	strong
	)

static

Set the boolean configuration property to indicate if the 'Data' channels (EventServiceChannel's), created for listening to scenario instance output variable updates, should use strong or soft references to events in the inbound event queue.

Note that this property would apply ONLY to 'Data' channels, and not to any other channels. For 'Data' channels, this setting overrides Apama.Services.Event.EventServiceChannelConstants.ConfigInboundEventQueueSoftReferencePrefixes.

Parameters

properties	The Map in which the configuration properties should be updated.
strong	The new value of the property.

See also: ScenarioServiceConstants.ConfigStrongDataInboundEventQueue

See also: ScenarioServiceConstants.DefaultStrongDataInboundEventQueue

static void Apama.Services.Scenario.ScenarioServiceConfig.SetUseRawDataChannel	(	Dictionary< string, object >	properties,
		bool	useRawData
	)

static

Set the boolean configuration property to indicate if the 'Data' channels (EventServiceChannel's), created for listening to scenario instance output variable updates, should be subscribed to the normal Data channel (possibly throttled), or the Raw Data channel (always unthrottled).

The event throttling mechanism is global within a correlator, so if the throttling mechanism is used, all scenarios will emit throttled output variable updates on the normal Data channel. However, for some applications the complete (unthrottled) output is required. For this reason, there is also a 'Raw' output channel that clients may choose to consume. This configuration property simply instructs a ScenarioService if it should use the alternative Raw channel instead of the normal Data channel.

Note that this property would apply ONLY to 'Data' channels, and not to any other channels.

Parameters

properties	The Map in which the configuration properties should be updated.
useRawData	The new value of the property.

See also: ScenarioServiceConstants.ConfigUseRawDataChannel

See also: ScenarioServiceConstants.DefaultUseRawDataChannel

static void Apama.Services.Scenario.ScenarioServiceConfig.SetUserNameFilter	(	System.Collections.IDictionary	properties,
		string	owner
	)

static

Set the configuration property to filter by a given user

If present, the scenario(s) listened for must have the ConfigureUpdates property sendRawUser or sendThrottledUser set to true.

Parameters

properties	The Map in which the configuration properties should be updated.
owner	the username to filter for

Static Public Member Functions

Detailed Description

Member Function Documentation