com.devexperts.qd.qtp

Class AgentAdapter

java.lang.Object

com.devexperts.qd.qtp.MessageConsumerAdapter

com.devexperts.qd.qtp.MessageAdapter

com.devexperts.qd.qtp.AgentAdapter

All Implemented Interfaces:

MessageAdapterMBean, MessageConsumer, MessageProvider, SymbolCodec.Resolver

public class AgentAdapter
extends MessageAdapter

The AgentAdapter adapts agent side of QD to message API. The agent side of an QD is an aggregation of agents for all its data sources. Thus, the AgentAdapter can be used to represent an outside data consumer in the specific QD. if you are a QD publisher - use this Adapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentAdapter.Factory The factory for agent side of an QD.

Nested classes/interfaces inherited from class com.devexperts.qd.qtp.MessageAdapter

MessageAdapter.AbstractFactory, MessageAdapter.CloseListener, MessageAdapter.ConfigurableFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected QDFilter	localStripe
static int	MAX_SUPPORTED_MESSAGE_TYPE
static int	MESSAGE_DESCRIBE_PROTOCOL
static int	MESSAGE_DESCRIBE_RECORDS
static int	MESSAGE_DESCRIBE_RESERVED
static int	MESSAGE_GZIP_COMPRESSION This value is reserved and can not be used as any message type.
static int	MESSAGE_HEARTBEAT
static int	MESSAGE_HISTORY_ADD_SUBSCRIPTION
static int	MESSAGE_HISTORY_DATA
static int	MESSAGE_HISTORY_REMOVE_SUBSCRIPTION
static int	MESSAGE_PART
static int	MESSAGE_RAW_DATA
static int	MESSAGE_RMI_ADVERTISE_SERVICES
static int	MESSAGE_RMI_CANCEL
static int	MESSAGE_RMI_DESCRIBE_OPERATION
static int	MESSAGE_RMI_DESCRIBE_SUBJECT
static int	MESSAGE_RMI_ERROR
static int	MESSAGE_RMI_REQUEST
static int	MESSAGE_RMI_RESPONSE
static int	MESSAGE_RMI_RESULT
static int	MESSAGE_STREAM_ADD_SUBSCRIPTION
static int	MESSAGE_STREAM_DATA
static int	MESSAGE_STREAM_REMOVE_SUBSCRIPTION
static int	MESSAGE_TEXT_FORMAT
static int	MESSAGE_TICKER_ADD_SUBSCRIPTION
static int	MESSAGE_TICKER_DATA
static int	MESSAGE_TICKER_REMOVE_SUBSCRIPTION
static int	MESSAGE_ZIP_COMPRESSION This value is reserved and can not be used as any message type.

Fields inherited from class com.devexperts.qd.qtp.MessageAdapter

AUTHENTICATION_LOGIN_REQUIRED, closeListener, doNotCloseOnErrors, messageListener, remoteEndpointId, useDescribeProtocol

Constructor Summary

Constructors

Constructor and Description
AgentAdapter(DataScheme scheme, QDStats stats) Creates new agent adapter for specified scheme and stats.
AgentAdapter(QDEndpoint endpoint, QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDFilter stripe, QDStats stats) Creates new agent adapter for specified endpoints, ticker, stream, history, filter and stats.
AgentAdapter(QDEndpoint endpoint, QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDStats stats) Deprecated.
AgentAdapter(QDTicker ticker, QDStream stream, QDHistory history, SubscriptionFilter filter, QDStats stats) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	closeImpl()
protected QDAgent	createAgent(QDCollector collector, SubscriptionFilter filter, String keyProperties) This method is used internally by agent adapter to create agent for the corresponding collector, filter, and keyProperties when the corresponding subscription arrives for a first time.
protected QDAgent.Builder	createAgentBuilder(QDCollector collector, SubscriptionFilter filter, String keyProperties)
DataScheme	getScheme()
String	getSymbol(char[] chars, int offset, int length) Returns symbol used for specified characters or null if not found.
AgentAdapter	initialize(ChannelShaper... shapers) Initializes the adapter with specified channel shapers.
boolean	isProtocolDescriptorCompatible(ProtocolDescriptor desc)
long	nextRetrieveTime(long currentTime) Returns next time when MessageAdapter.retrieveMessages(MessageVisitor) shall be called.
void	prepareProtocolDescriptor(ProtocolDescriptor desc) Prepares outgoing protocol descriptor.
void	processDescribeProtocol(ProtocolDescriptor desc, boolean logDescriptor) Process incoming protocol descriptor.
protected void	processSubscription(SubscriptionIterator iterator, MessageType message)
void	reinitConfiguration(com.devexperts.auth.AuthSession session) Updates the adapter configuration.
protected boolean	retrieveDataMessages(MessageVisitor visitor)
boolean	retrieveMessages(MessageVisitor visitor) Retrieves accumulated message into specified message visitor.
boolean	supportsMixedSubscription()
String	toString() Returns description of this MessageAdapter for management and logging purposes.
void	updateChannel(ChannelShaper shaper) Deprecated. No need to use this method. It does nothing. Channels are automatically update on change of their parameters.

Methods inherited from class com.devexperts.qd.qtp.MessageAdapter

addMask, clearMessageMask, close, getCommonScheme, getConnectionVariables, getEndpoint, getFieldReplacer, getMessageMask, getRemoteEndpointId, getRemoteHostAddress, getRemoteOptSet, getStats, getStatus, handleCorruptedMessage, handleCorruptedStream, handleUnknownMessage, hasMessageMask, intersectStripes, isAlive, isClosed, isMarkedForImmediateRestart, markForImmediateRestart, notifyListener, prepareAuthenticateProtocolDescriptor, processDescribeProtocol, reportIgnoredMessage, retrieveDescribeProtocolMessage, retrieveMask, setAuthRealm, setCloseListener, setConnectionVariables, setLoginHandler, setMessageListener, setRemoteOptSet, start, start, startImpl, useDescribeProtocol

Methods inherited from class com.devexperts.qd.qtp.MessageConsumerAdapter

processData, processHeartbeat, processHistoryAddSubscription, processHistoryData, processHistoryRemoveSubscription, processOtherMessage, processOtherMessage, processRecordSource, processStreamAddSubscription, processStreamData, processStreamRemoveSubscription, processTickerAddSubscription, processTickerData, processTickerRemoveSubscription, processTimeProgressReport

Methods inherited from class java.lang.Object

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

Field Detail

localStripe

protected QDFilter localStripe

MESSAGE_HEARTBEAT

public static final int MESSAGE_HEARTBEAT

See Also:

Constant Field Values

MESSAGE_DESCRIBE_PROTOCOL

public static final int MESSAGE_DESCRIBE_PROTOCOL

See Also:

Constant Field Values

MESSAGE_DESCRIBE_RECORDS

public static final int MESSAGE_DESCRIBE_RECORDS

See Also:

Constant Field Values

MESSAGE_DESCRIBE_RESERVED

public static final int MESSAGE_DESCRIBE_RESERVED

See Also:

Constant Field Values

MESSAGE_PART

public static final int MESSAGE_PART

See Also:

Constant Field Values

MESSAGE_RAW_DATA

public static final int MESSAGE_RAW_DATA

See Also:

Constant Field Values

MESSAGE_TICKER_DATA

public static final int MESSAGE_TICKER_DATA

See Also:

Constant Field Values

MESSAGE_TICKER_ADD_SUBSCRIPTION

public static final int MESSAGE_TICKER_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_TICKER_REMOVE_SUBSCRIPTION

public static final int MESSAGE_TICKER_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_STREAM_DATA

public static final int MESSAGE_STREAM_DATA

See Also:

Constant Field Values

MESSAGE_STREAM_ADD_SUBSCRIPTION

public static final int MESSAGE_STREAM_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_STREAM_REMOVE_SUBSCRIPTION

public static final int MESSAGE_STREAM_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_HISTORY_DATA

public static final int MESSAGE_HISTORY_DATA

See Also:

Constant Field Values

MESSAGE_HISTORY_ADD_SUBSCRIPTION

public static final int MESSAGE_HISTORY_ADD_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_HISTORY_REMOVE_SUBSCRIPTION

public static final int MESSAGE_HISTORY_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

MESSAGE_RMI_ADVERTISE_SERVICES

public static final int MESSAGE_RMI_ADVERTISE_SERVICES

See Also:

Constant Field Values

MESSAGE_RMI_DESCRIBE_SUBJECT

public static final int MESSAGE_RMI_DESCRIBE_SUBJECT

See Also:

Constant Field Values

MESSAGE_RMI_DESCRIBE_OPERATION

public static final int MESSAGE_RMI_DESCRIBE_OPERATION

See Also:

Constant Field Values

MESSAGE_RMI_REQUEST

public static final int MESSAGE_RMI_REQUEST

See Also:

Constant Field Values

MESSAGE_RMI_CANCEL

public static final int MESSAGE_RMI_CANCEL

See Also:

Constant Field Values

MESSAGE_RMI_RESULT

public static final int MESSAGE_RMI_RESULT

See Also:

Constant Field Values

MESSAGE_RMI_ERROR

public static final int MESSAGE_RMI_ERROR

See Also:

Constant Field Values

MESSAGE_RMI_RESPONSE

public static final int MESSAGE_RMI_RESPONSE

See Also:

Constant Field Values

MAX_SUPPORTED_MESSAGE_TYPE

public static final int MAX_SUPPORTED_MESSAGE_TYPE

See Also:

Constant Field Values

MESSAGE_TEXT_FORMAT

public static final int MESSAGE_TEXT_FORMAT

See Also:

Constant Field Values

MESSAGE_ZIP_COMPRESSION

public static final int MESSAGE_ZIP_COMPRESSION

This value is reserved and can not be used as any message type. It is the second byte of zip file compression.

See Also:

Constant Field Values

MESSAGE_GZIP_COMPRESSION

public static final int MESSAGE_GZIP_COMPRESSION

This value is reserved and can not be used as any message type. It is the second byte of gzip file compression.

See Also:

Constant Field Values

Constructor Detail

AgentAdapter

public AgentAdapter(QDEndpoint endpoint,
                    QDTicker ticker,
                    QDStream stream,
                    QDHistory history,
                    SubscriptionFilter filter,
                    QDFilter stripe,
                    QDStats stats)

Creates new agent adapter for specified endpoints, ticker, stream, history, filter and stats. Any of the endpoint, collectors and/or filter may be null.

The resulting adapter will be initiailized. It will use equal weight of 1 and no aggregation for all collectors.

AgentAdapter

@Deprecated
public AgentAdapter(QDEndpoint endpoint,
                                QDTicker ticker,
                                QDStream stream,
                                QDHistory history,
                                SubscriptionFilter filter,
                                QDStats stats)

Deprecated.

AgentAdapter

@Deprecated
public AgentAdapter(QDTicker ticker,
                                QDStream stream,
                                QDHistory history,
                                SubscriptionFilter filter,
                                QDStats stats)

Deprecated.

Creates new agent adapter for specified ticker, stream, history, filter and stats. Any of the collectors and/or filter may be null.

The resulting adapter will be initiailized. It will use equal weight of 1 and no aggregation for all collectors.

AgentAdapter

public AgentAdapter(DataScheme scheme,
                    QDStats stats)

Creates new agent adapter for specified scheme and stats.

Adapter created by this constructor must be initialized with shapers before being used.

Parameters:

scheme - data scheme

stats - stats

Method Detail

initialize

public AgentAdapter initialize(ChannelShaper... shapers)

Initializes the adapter with specified channel shapers. This method must be called exactly once before the adapter is used (unless the adapter is created with AgentAdapter(QDTicker, QDStream, QDHistory, SubscriptionFilter, QDStats) constructor in which case it ia already initialized). All channels are bound to this agent and cannot be used in other agent.

Parameters:

shapers - shaping configuration for adapter channels

Returns:

this agent adapter (in order to allow chained notation)

createAgent

protected QDAgent createAgent(QDCollector collector,
                              SubscriptionFilter filter,
                              String keyProperties)

This method is used internally by agent adapter to create agent for the corresponding collector, filter, and keyProperties when the corresponding subscription arrives for a first time. This method is called while holding this adapter's lock. This implementation returns collector.createAgent(filter, keyProperties). This method may be overriden to create agent with other filter, otherwise customize the agent that is being created, or to keep track of created agents.

Parameters:

collector - collector to create agent for

filter - subscription filter for the agent

keyProperties - key properties for stats

Returns:

newly created agent

createAgentBuilder

protected QDAgent.Builder createAgentBuilder(QDCollector collector,
                                             SubscriptionFilter filter,
                                             String keyProperties)

toString

public String toString()

Description copied from class: MessageAdapter

Returns description of this MessageAdapter for management and logging purposes.

Overrides:

toString in class MessageAdapter

getScheme

public DataScheme getScheme()

Specified by:

getScheme in class MessageAdapter

getSymbol

public String getSymbol(char[] chars,
                        int offset,
                        int length)

Description copied from class: MessageConsumerAdapter

Returns symbol used for specified characters or null if not found.

Specified by:

getSymbol in interface SymbolCodec.Resolver

Overrides:

getSymbol in class MessageConsumerAdapter

updateChannel

public void updateChannel(ChannelShaper shaper)

Deprecated. No need to use this method. It does nothing. Channels are automatically update on change of their parameters.

supportsMixedSubscription

public boolean supportsMixedSubscription()

Overrides:

supportsMixedSubscription in class MessageAdapter

processSubscription

protected void processSubscription(SubscriptionIterator iterator,
                                   MessageType message)

Overrides:

processSubscription in class MessageConsumerAdapter

closeImpl

protected void closeImpl()

Overrides:

closeImpl in class MessageAdapter

retrieveMessages

public boolean retrieveMessages(MessageVisitor visitor)

Description copied from interface: MessageProvider

Retrieves accumulated message into specified message visitor. Returns true if some messages still remains in the provider or false if all accumulated messages were retrieved.

Specified by:

retrieveMessages in interface MessageProvider

Overrides:

retrieveMessages in class MessageAdapter

prepareProtocolDescriptor

public void prepareProtocolDescriptor(ProtocolDescriptor desc)

Description copied from class: MessageAdapter

Prepares outgoing protocol descriptor. Implementers should call super.prepareProtocolDescriptor(desc).

Overrides:

prepareProtocolDescriptor in class MessageAdapter

Parameters:

desc - outgoing protocol descriptor

processDescribeProtocol

public void processDescribeProtocol(ProtocolDescriptor desc,
                                    boolean logDescriptor)

Description copied from class: MessageAdapter

Process incoming protocol descriptor. Implementers should call super.processDescribeProtocol(desc).

Specified by:

processDescribeProtocol in interface MessageConsumer

Overrides:

processDescribeProtocol in class MessageAdapter

Parameters:

desc - incoming protocol descriptor

logDescriptor - when protocol description shall be logged.

isProtocolDescriptorCompatible

public boolean isProtocolDescriptorCompatible(ProtocolDescriptor desc)

Overrides:

isProtocolDescriptorCompatible in class MessageAdapter

retrieveDataMessages

protected boolean retrieveDataMessages(MessageVisitor visitor)

reinitConfiguration

public void reinitConfiguration(com.devexperts.auth.AuthSession session)

Description copied from class: MessageAdapter

Updates the adapter configuration.

Overrides:

reinitConfiguration in class MessageAdapter

Parameters:

session - the unique session.

nextRetrieveTime

public long nextRetrieveTime(long currentTime)

Description copied from class: MessageAdapter

Returns next time when MessageAdapter.retrieveMessages(MessageVisitor) shall be called. This method is overridden when a message has to be generated at a certain time in the future. For immediate message delivery use MessageAdapter.addMask(long), which immediately calls MessageAdapter.notifyListener() as needed.

This implementation returns Long.MAX_VALUE.

Overrides:

nextRetrieveTime in class MessageAdapter

Parameters:

currentTime - the current value of System.currentTimeMillis()

Returns:

next time when MessageAdapter.retrieveMessages(MessageVisitor) shall be called even if the mask of messages for immediate delivery is empty.