com.devexperts.qd.qtp

Class ChannelShaper

java.lang.Object

com.devexperts.qd.qtp.ChannelShaper

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DynamicChannelShaper

public class ChannelShaper
extends Object
implements Cloneable

This class represents configuration of a single data channel within AgentAdapter. It includes contract, collector, keep rejected flag, subscription filter, data filter, relative weight, and aggregation period. Each channel may specify executor to be used for subscription processing (i.e. filtering) - it is required when subscription filtering is a heavy operation (e.g. requires database access).

Channel may change its parameters except for contract, subscription executor, and keep reject flag, to new values anytime. The changes of data filter, weight or aggregation period are immediately effective and do not require re-creation of agent (i.e. no interruption of data stream happens). The changes of collector or subscription filter require re-creation of agent which result with brief data stream interruption. The re-creation of agent will happen upon data or subscription message processing; it can be forced via invocation of AgentAdapter.updateChannel(com.devexperts.qd.qtp.ChannelShaper) method.

Constructor Summary

Constructors

Constructor and Description
ChannelShaper(Executor subscriptionExecutor, QDCollector collector, SubscriptionFilter subscriptionFilter, RecordFilter dataFilter) Deprecated. Use ChannelShaper(QDContract, Executor) and setCollector(QDCollector), setSubscriptionFilter(QDFilter), setDataFilter(RecordFilter)
ChannelShaper(QDContract contract, Executor subscriptionExecutor) Creates new channel shaper with specified contract and subscription executor.
ChannelShaper(QDContract contract, Executor subscriptionExecutor, boolean keepRejected) Creates new channel shaper with specified contract, subscription executor, and keep rejected flag.

Method Summary

Modifier and Type	Method and Description
ChannelShaper	clone()
void	close() Closes this channel shaper and releases its resources (stops tracking dynamic filters).
long	getAggregationPeriod() Returns aggregation period in milliseconds for this channel data.
QDCollector	getCollector() Returns collector currently used by the channel.
QDContract	getContract() Returns contract of the channel.
RecordFilter	getDataFilter() Returns data filter currently used by the channel.
Executor	getSubscriptionExecutor() Returns executor for subscription processing used by the channel or null if none specified.
QDFilter	getSubscriptionFilter() Returns subscription filter currently used by the channel.
int	getWeight() Returns relative weight of this channel data within the adapter for shaping.
boolean	hasSubscriptionExecutor() Returns true if there is an executor for subscription processing.
boolean	isKeepRejected() Returns true when subscription rejected by this channel's filter is kept for the case of future changes of subscription filter.
void	setAggregationPeriod(long aggregationPeriod) Sets aggregation period for this channel data.
void	setCollector(QDCollector collector) Sets collector for the channel.
void	setDataFilter(RecordFilter dataFilter) Sets data filter for the channel.
void	setSubscriptionFilter(QDFilter subscriptionFilter) Sets subscription filter for the channel.
void	setSubscriptionFilter(SubscriptionFilter subscriptionFilter) Deprecated. Use setSubscriptionFilter(QDFilter) that accepts non-null QDFilter instance which replaces legacy SubscriptionFilter.
void	setWeight(int weight) Sets relative weight of this channel data within the adapter for shaping.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelShaper

public ChannelShaper(QDContract contract,
                     Executor subscriptionExecutor)

Creates new channel shaper with specified contract and subscription executor. This channel shaper does not keep subscription rejected by a filter.

Parameters:

contract - channel contract; may not be null

subscriptionExecutor - subscription executor; may be null

Throws:

NullPointerException - if contract is null

ChannelShaper

public ChannelShaper(QDContract contract,
                     Executor subscriptionExecutor,
                     boolean keepRejected)

Creates new channel shaper with specified contract, subscription executor, and keep rejected flag.

Parameters:

contract - channel contract; may not be null

subscriptionExecutor - subscription executor; may be null

keepRejected - true when rejected subscription elements shall be kept for future changes of filter.

Throws:

NullPointerException - if contract is null

ChannelShaper

public ChannelShaper(Executor subscriptionExecutor,
                     QDCollector collector,
                     SubscriptionFilter subscriptionFilter,
                     RecordFilter dataFilter)

Deprecated. Use ChannelShaper(QDContract, Executor) and setCollector(QDCollector), setSubscriptionFilter(QDFilter), setDataFilter(RecordFilter)

Creates new channel shaper with specified parameters. All initialization parameters except for collector may be null.

Parameters:

subscriptionExecutor - subscription executor; may be null

collector - channel collector; may not be null

subscriptionFilter - subscription filter; may be null

dataFilter - data filter; may be null

Throws:

NullPointerException - if collector is null

Method Detail

close

public void close()

Closes this channel shaper and releases its resources (stops tracking dynamic filters).

clone

public ChannelShaper clone()

Overrides:

clone in class Object

getContract

public QDContract getContract()

Returns contract of the channel. This property is fixed for a given channel.

Returns:

channel contract

hasSubscriptionExecutor

public boolean hasSubscriptionExecutor()

Returns true if there is an executor for subscription processing. This property is fixed for a given channel.

Returns:

true if there is an executor for subscription processing.

getSubscriptionExecutor

public Executor getSubscriptionExecutor()

Returns executor for subscription processing used by the channel or null if none specified. This property is fixed for a given channel.

Returns:

subscription executor or null

isKeepRejected

public boolean isKeepRejected()

Returns true when subscription rejected by this channel's filter is kept for the case of future changes of subscription filter. This property is fixed for a given channel.

getCollector

public final QDCollector getCollector()

Returns collector currently used by the channel.

Returns:

channel collector or null

setCollector

public void setCollector(QDCollector collector)

Sets collector for the channel. The contract of collector must match the contract of this channel. The collector may be null in which case no agent will be created for the channel. Change of collector will trigger re-creation of agent.

Parameters:

collector - channel collector; may be null

getSubscriptionFilter

public final QDFilter getSubscriptionFilter()

Returns subscription filter currently used by the channel.

Returns:

subscription filter currently used by the channel (non-null).

setSubscriptionFilter

public void setSubscriptionFilter(SubscriptionFilter subscriptionFilter)

Deprecated. Use setSubscriptionFilter(QDFilter) that accepts non-null QDFilter instance which replaces legacy SubscriptionFilter.

Sets subscription filter for the channel. The subscription filter may be null in which case all subscription will be accepted. Change of subscription filter will trigger re-creation of agent.

Parameters:

subscriptionFilter - subscription filter; may be null

setSubscriptionFilter

public void setSubscriptionFilter(QDFilter subscriptionFilter)

Sets subscription filter for the channel. Use QDFilter.ANYTHING to accept any subscription. Change of subscription filter will trigger re-creation of agent.

Parameters:

subscriptionFilter - subscription filter; may be null for backwards-compatibility (it is replaced with QDFilter.ANYTHING)

getDataFilter

public RecordFilter getDataFilter()

Returns data filter currently used by the channel.

Returns:

data filter or null

setDataFilter

public void setDataFilter(RecordFilter dataFilter)

Sets data filter for the channel. The data filter may be null in which case all data will be accepted. Change of data filter is immediate and will not trigger re-creation of agent.

Parameters:

dataFilter - data filter; may be null

getWeight

public int getWeight()

Returns relative weight of this channel data within the adapter for shaping.

Returns:

relative weight of this channel data

setWeight

public void setWeight(int weight)

Sets relative weight of this channel data within the adapter for shaping. The weight must be between 1 and 100 inclusive. Change of weight is immediate and will not trigger re-creation of agent.

Parameters:

weight - relative weight

Throws:

IllegalArgumentException - if weight is less than 1 or greater than 100.

getAggregationPeriod

public long getAggregationPeriod()

Returns aggregation period in milliseconds for this channel data.

Returns:

aggregation period in milliseconds

setAggregationPeriod

public void setAggregationPeriod(long aggregationPeriod)

Sets aggregation period for this channel data. The aggregation period must be non-negative and must not exceed 24 hours. Change of aggregation period is immediate and will not trigger re-creation of agent.

Parameters:

aggregationPeriod - in milliseconds

Throws:

IllegalArgumentException - if aggregation period is negative or greater than 24 hours.