com.devexperts.qd.qtp

Class AbstractMessageConnector

java.lang.Object

com.devexperts.qd.qtp.AbstractMessageConnector

All Implemented Interfaces:

MessageConnector, MessageConnectorMBean

Direct Known Subclasses:

AbstractServerConnector, ClientSocketConnector

public abstract class AbstractMessageConnector
extends Object
implements MessageConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMessageConnector.Joinable

Nested classes/interfaces inherited from interface com.devexperts.qd.qtp.MessageConnector

MessageConnector.Bindable

Field Summary

Fields

Modifier and Type	Field and Description
protected com.devexperts.logging.Logging	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessageConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory) Constructs new abstract message connector.

Method Summary

Modifier and Type	Method and Description
void	addClosedConnectionStats(com.devexperts.transport.stats.ConnectionStats stats)
void	addMessageConnectorListener(MessageConnectorListener listener) Adds the specified listener to this message connector.
void	close() Permanently closes connector and releases its resources.
protected void	closeImpl()
com.devexperts.util.TimePeriodInfo	getAggregationPeriodInfo() Returns the aggregation period info aggregated across all active adapters on this connector.
String	getAggregationPeriodInfoStr() Returns the current effective aggregation period info as JSON across all active connections.
long	getClosedConnectionCount() Returns total number of closed connector since the creation of connector.
String	getDefaultAggregationPeriod() Returns the default aggregation period for server-side connections, or null if not set.
String	getEndpointStats() Endpoint statistics since last reset
com.devexperts.connector.proto.ApplicationConnectionFactory	getFactory() Returns ApplicationConnectionFactory that is used by this message connector.
String	getFieldReplacer() Returns configured input field replacers.
com.devexperts.logging.Logging	getLogging() Returns Logging instance that is tied to this MessageConnector and includes this connector's name into the logs.
String	getMaxAggregationPeriod() Returns the maximum aggregation period bound for server-side connections, or null if not set.
protected List<MessageAdapter>	getMessageAdapters() Returns a snapshot list of all active message adapters.
String	getMinAggregationPeriod() Returns the minimum aggregation period bound for server-side connections, or null if not set.
String	getName() Returns short string description of this connector for management and logging purposes.
String	getPassword() User password for authorization.
long	getReconnectDelay() Delay between reconnection attempts in milliseconds
String	getRequestedAggregationPeriod() Returns the client-requested aggregation period string.
QDStats	getStats() Returns QDStats associated with this message connector.
int	getThreadPriority() Priority for threads associated with this connector
String	getUser() User login name Returns connector's user name for authorization.
protected void	handlerClosed(AbstractConnectionHandler handler) Invoked by handler to notify about associated connector about handler's death.
protected boolean	isClosed()
void	notifyMessageConnectorListeners()
protected void	reconfigure()
void	reconnect() Reconnects connector.
void	removeMessageConnectorListener(MessageConnectorListener listener) Removes the specified listener from this message connector.
void	resetEndpointStats() Resets endpoint statistics
void	restart() Restarts connector (connection is immediately dropped and established again).
protected void	restartImpl(boolean fullStop) Restart logic implementation; If fullStop is false, connection context (like last chosen address for multi-host connections) may be preserved.
com.devexperts.transport.stats.EndpointStats	retrieveCompleteEndpointStats() Retrieves endpoint statistics for this message connector since its creation
void	setAggregationPeriod(String period) Alias for setDefaultAggregationPeriod(java.lang.String) to support address format aggregationPeriod=1s.
void	setDefaultAggregationPeriod(String defaultAggregationPeriod) Sets the default aggregation period applied when client doesn't specify one.
void	setFactory(com.devexperts.connector.proto.ApplicationConnectionFactory factory) Changes ApplicationConnectionFactory that is used by this message connector.
void	setFieldReplacer(String fieldReplacer) Sets input field replacers.
void	setMaxAggregationPeriod(String maxAggregationPeriod) Sets the maximum bound for aggregation period validation.
void	setMinAggregationPeriod(String minAggregationPeriod) Sets the minimum bound for aggregation period validation.
void	setName(String name) Overrides name of this connector for management and logging purposes.
void	setPassword(String password) Sets password for authorization.
void	setReconnectDelay(long reconnectDelay) Sets reconnection delay.
void	setRequestedAggregationPeriod(String requestedAggregationPeriod) Sets the requested aggregation period to send to the server via DESCRIBE_PROTOCOL.
void	setStats(QDStats stats) Changes QDStats associated with this message connector.
void	setThreadPriority(int priority) Sets thread priority for all threads created by this connector.
void	setUser(String user) Sets connector's user name for authorization.
abstract void	start() Starts connector (connection is immediately established).
void	stop() Stops connector (connection is immediately dropped).
void	stopAndWait() Stops connector and waits while all its threads are terminated.
protected abstract AbstractMessageConnector.Joinable	stopImpl()
String	toString() Returns name of this connector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devexperts.qd.qtp.MessageConnector

awaitProcessed

Methods inherited from interface com.devexperts.qd.qtp.MessageConnectorMBean

getAddress, getAggregationPeriod, getConnectionCount, getState, isActive

Field Detail

log

protected com.devexperts.logging.Logging log

Constructor Detail

AbstractMessageConnector

protected AbstractMessageConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory)

Constructs new abstract message connector.

Parameters:

factory - application connection factory to use

Throws:

NullPointerException - if factory is null

Method Detail

toString

public String toString()

Returns name of this connector.

Overrides:

toString in class Object

Returns:

name of this connector

See Also:

getName()

getName

public String getName()

Returns short string description of this connector for management and logging purposes. The result of this method is equal to the name of the corresponding ApplicationConnectionFactory. This description may be manually overridden to arbitrary value via setName(java.lang.String) method.

Specified by:

getName in interface MessageConnectorMBean

Returns:

short string description of this connector for management and logging purposes

See Also:

setName(String)

setName

public void setName(String name)

Overrides name of this connector for management and logging purposes. This method changes the name of the corresponding ApplicationConnectionFactory.

Specified by:

setName in interface MessageConnectorMBean

Parameters:

name - connector name to set; it may be null in which case default autogenerated name will be used.

See Also:

getName()

getUser

public String getUser()

Description copied from interface: MessageConnectorMBean

User login name Returns connector's user name for authorization.

Specified by:

getUser in interface MessageConnectorMBean

setUser

public void setUser(String user)

Description copied from interface: MessageConnectorMBean

Sets connector's user name for authorization.

Specified by:

setUser in interface MessageConnectorMBean

Parameters:

user - connector's user name for authorization.

getPassword

public String getPassword()

Description copied from interface: MessageConnectorMBean

User password for authorization.

Specified by:

getPassword in interface MessageConnectorMBean

setPassword

public void setPassword(String password)

Description copied from interface: MessageConnectorMBean

Sets password for authorization.

Specified by:

setPassword in interface MessageConnectorMBean

Parameters:

password - password for authorization.

getFactory

public com.devexperts.connector.proto.ApplicationConnectionFactory getFactory()

Description copied from interface: MessageConnector

Returns ApplicationConnectionFactory that is used by this message connector.

Specified by:

getFactory in interface MessageConnector

Returns:

ApplicationConnectionFactory that is used by this message connector.

setFactory

public void setFactory(com.devexperts.connector.proto.ApplicationConnectionFactory factory)

Description copied from interface: MessageConnector

Changes ApplicationConnectionFactory that is used by this message connector.

Specified by:

setFactory in interface MessageConnector

Parameters:

factory - ApplicationConnectionFactory that will be used by this message connector.

getReconnectDelay

public long getReconnectDelay()

Description copied from interface: MessageConnectorMBean

Delay between reconnection attempts in milliseconds

Specified by:

getReconnectDelay in interface MessageConnectorMBean

setReconnectDelay

public void setReconnectDelay(long reconnectDelay)

Description copied from interface: MessageConnectorMBean

Sets reconnection delay.

Specified by:

setReconnectDelay in interface MessageConnectorMBean

Parameters:

reconnectDelay - reconnection delay

getFieldReplacer

public String getFieldReplacer()

Description copied from interface: MessageConnectorMBean

Returns configured input field replacers.

Specified by:

getFieldReplacer in interface MessageConnectorMBean

setFieldReplacer

public void setFieldReplacer(String fieldReplacer)

Description copied from interface: MessageConnectorMBean

Sets input field replacers.

Specified by:

setFieldReplacer in interface MessageConnectorMBean

Parameters:

fieldReplacer - field replacers specification.

getStats

public QDStats getStats()

Description copied from interface: MessageConnector

Returns QDStats associated with this message connector.

Specified by:

getStats in interface MessageConnector

Returns:

QDStats associated with this message connector

setStats

public void setStats(QDStats stats)

Description copied from interface: MessageConnector

Changes QDStats associated with this message connector.

Specified by:

setStats in interface MessageConnector

start

public abstract void start()

Description copied from interface: MessageConnectorMBean

Starts connector (connection is immediately established). Does nothing if connector is already started.

Specified by:

start in interface MessageConnectorMBean

stopImpl

protected abstract AbstractMessageConnector.Joinable stopImpl()

handlerClosed

protected void handlerClosed(AbstractConnectionHandler handler)

Invoked by handler to notify about associated connector about handler's death.

Recommended implementation template:
- check if handler is still actual (beware of asynchronous execution) and cut-out local handler reference
- restart processing (if needed)

Parameters:

handler - - the notifying handler

stop

public final void stop()

Description copied from interface: MessageConnectorMBean

Stops connector (connection is immediately dropped). Does nothing if connector is stopped.

Specified by:

stop in interface MessageConnectorMBean

stopAndWait

public final void stopAndWait()
                       throws InterruptedException

Description copied from interface: MessageConnector

Stops connector and waits while all its threads are terminated.

Specified by:

stopAndWait in interface MessageConnector

Throws:

InterruptedException - if interrupted.

restart

public void restart()

Description copied from interface: MessageConnectorMBean

Restarts connector (connection is immediately dropped and established again). It basically does MessageConnectorMBean.stop() and MessageConnectorMBean.start() in sequence.

Specified by:

restart in interface MessageConnectorMBean

reconnect

public void reconnect()

Description copied from interface: MessageConnectorMBean

Reconnects connector. Opposing to the MessageConnectorMBean.restart() method, reconnect should try to follow specified reconnection policy (like choosing next node in cluster) if applicable.

Default behavior is just performing MessageConnectorMBean.restart().

Specified by:

reconnect in interface MessageConnectorMBean

restartImpl

protected void restartImpl(boolean fullStop)

Restart logic implementation; If fullStop is false, connection context (like last chosen address for multi-host connections) may be preserved.

Parameters:

fullStop -

reconfigure

protected void reconfigure()

getThreadPriority

public int getThreadPriority()

Description copied from interface: MessageConnectorMBean

Priority for threads associated with this connector

Specified by:

getThreadPriority in interface MessageConnectorMBean

setThreadPriority

public void setThreadPriority(int priority)

Description copied from interface: MessageConnectorMBean

Sets thread priority for all threads created by this connector.

Specified by:

setThreadPriority in interface MessageConnectorMBean

Parameters:

priority - thread priority for all threads created by this connector

getEndpointStats

public String getEndpointStats()

Description copied from interface: MessageConnectorMBean

Endpoint statistics since last reset

Specified by:

getEndpointStats in interface MessageConnectorMBean

Returns:

endpoint statistics string for this message connector since last call to MessageConnectorMBean.resetEndpointStats().

resetEndpointStats

public void resetEndpointStats()

Description copied from interface: MessageConnectorMBean

Resets endpoint statistics

Specified by:

resetEndpointStats in interface MessageConnectorMBean

retrieveCompleteEndpointStats

public com.devexperts.transport.stats.EndpointStats retrieveCompleteEndpointStats()

Description copied from interface: MessageConnectorMBean

Retrieves endpoint statistics for this message connector since its creation

Specified by:

retrieveCompleteEndpointStats in interface MessageConnectorMBean

getClosedConnectionCount

public long getClosedConnectionCount()

Description copied from interface: MessageConnector

Returns total number of closed connector since the creation of connector.

Specified by:

getClosedConnectionCount in interface MessageConnector

addClosedConnectionStats

public void addClosedConnectionStats(com.devexperts.transport.stats.ConnectionStats stats)

getRequestedAggregationPeriod

public String getRequestedAggregationPeriod()

Description copied from interface: MessageConnectorMBean

Returns the client-requested aggregation period string. Returns null if not set. Applicable for client-side connectors (propagated to all DistributorAdapters).

Specified by:

getRequestedAggregationPeriod in interface MessageConnectorMBean

setRequestedAggregationPeriod

public void setRequestedAggregationPeriod(String requestedAggregationPeriod)

Description copied from interface: MessageConnectorMBean

Sets the requested aggregation period to send to the server via DESCRIBE_PROTOCOL. Propagated to all active DistributorAdapter connections.

Specified by:

setRequestedAggregationPeriod in interface MessageConnectorMBean

Parameters:

requestedAggregationPeriod - aggregation period string (e.g. "1s", "0.5s"), or "undefined"/null/empty to reset (server uses its default)

getAggregationPeriodInfo

public com.devexperts.util.TimePeriodInfo getAggregationPeriodInfo()

Description copied from interface: MessageConnector

Returns the aggregation period info aggregated across all active adapters on this connector. Returns TimePeriodInfo.UNKNOWN if no adapter has aggregation period info available.

Specified by:

getAggregationPeriodInfo in interface MessageConnector

getAggregationPeriodInfoStr

public String getAggregationPeriodInfoStr()

Description copied from interface: MessageConnectorMBean

Returns the current effective aggregation period info as JSON across all active connections. Format: {"min":1.5,"max":2.0} (seconds with decimals), or {"min":-1,"max":-1} if not available.

Specified by:

getAggregationPeriodInfoStr in interface MessageConnectorMBean

getDefaultAggregationPeriod

public String getDefaultAggregationPeriod()

Description copied from interface: MessageConnectorMBean

Returns the default aggregation period for server-side connections, or null if not set. Alias: MessageConnectorMBean.getAggregationPeriod().

Specified by:

getDefaultAggregationPeriod in interface MessageConnectorMBean

setDefaultAggregationPeriod

public void setDefaultAggregationPeriod(String defaultAggregationPeriod)

Description copied from interface: MessageConnectorMBean

Sets the default aggregation period applied when client doesn't specify one. Propagated to all active AgentAdapter connections.

Specified by:

setDefaultAggregationPeriod in interface MessageConnectorMBean

Parameters:

defaultAggregationPeriod - default aggregation period string (e.g. "1s"), or null to reset

setAggregationPeriod

public void setAggregationPeriod(String period)

Alias for setDefaultAggregationPeriod(java.lang.String) to support address format aggregationPeriod=1s.

getMinAggregationPeriod

public String getMinAggregationPeriod()

Description copied from interface: MessageConnectorMBean

Returns the minimum aggregation period bound for server-side connections, or null if not set.

Specified by:

getMinAggregationPeriod in interface MessageConnectorMBean

setMinAggregationPeriod

public void setMinAggregationPeriod(String minAggregationPeriod)

Description copied from interface: MessageConnectorMBean

Sets the minimum bound for aggregation period validation. Client requests below this value will be clamped up.

Specified by:

setMinAggregationPeriod in interface MessageConnectorMBean

Parameters:

minAggregationPeriod - minimum aggregation period string (e.g. "0.5s"), or null to reset

getMaxAggregationPeriod

public String getMaxAggregationPeriod()

Description copied from interface: MessageConnectorMBean

Returns the maximum aggregation period bound for server-side connections, or null if not set.

Specified by:

getMaxAggregationPeriod in interface MessageConnectorMBean

setMaxAggregationPeriod

public void setMaxAggregationPeriod(String maxAggregationPeriod)

Description copied from interface: MessageConnectorMBean

Sets the maximum bound for aggregation period validation. Client requests above this value will be clamped down.

Specified by:

setMaxAggregationPeriod in interface MessageConnectorMBean

Parameters:

maxAggregationPeriod - maximum aggregation period string (e.g. "5s"), or null to reset

getMessageAdapters

@Internal
protected List<MessageAdapter> getMessageAdapters()

Returns a snapshot list of all active message adapters. Subclasses should override this for connector-level aggregation queries.

close

public final void close()

Description copied from interface: MessageConnector

Permanently closes connector and releases its resources.

Specified by:

close in interface MessageConnector

closeImpl

protected void closeImpl()

isClosed

protected boolean isClosed()

addMessageConnectorListener

public void addMessageConnectorListener(MessageConnectorListener listener)

Description copied from interface: MessageConnector

Adds the specified listener to this message connector.

Specified by:

addMessageConnectorListener in interface MessageConnector

Parameters:

listener - newly adding MessageConnectorListener.

removeMessageConnectorListener

public void removeMessageConnectorListener(MessageConnectorListener listener)

Description copied from interface: MessageConnector

Removes the specified listener from this message connector.

Specified by:

removeMessageConnectorListener in interface MessageConnector

Parameters:

listener - removing MessageConnectorListener.

notifyMessageConnectorListeners

public void notifyMessageConnectorListeners()

getLogging

public com.devexperts.logging.Logging getLogging()

Returns Logging instance that is tied to this MessageConnector and includes this connector's name into the logs.