com.devexperts.qd.qtp

Interface MessageConnectorMBean

All Known Subinterfaces:

ClientSocketConnectorMBean, MessageConnector, ServerConnectorMBean, ServerSocketConnectorMBean

All Known Implementing Classes:

AbstractMessageConnector, AbstractServerConnector, ClientSocketConnector, ServerSocketConnector

public interface MessageConnectorMBean

Defines properties and operations that every MessageConnector exposes via JMX.

Method Summary

Modifier and Type	Method and Description
String	getAddress() Address string of connector.
int	getConnectionCount() Number of established connections
String	getEndpointStats() Endpoint statistics since last reset
String	getFieldReplacer() Returns configured input field replacers.
String	getName() Name of connector.
String	getPassword() User password for authorization.
long	getReconnectDelay() Delay between reconnection attempts in milliseconds
MessageConnectorState	getState() State of connector.
int	getThreadPriority() Priority for threads associated with this connector
String	getUser() User login name Returns connector's user name for authorization.
boolean	isActive() True when connector is active (started).
void	reconnect() Reconnects connector.
void	resetEndpointStats() Resets endpoint statistics
void	restart() Restarts connector (connection is immediately dropped and established again).
com.devexperts.transport.stats.EndpointStats	retrieveCompleteEndpointStats() Retrieves endpoint statistics for this message connector since its creation
void	setFieldReplacer(String fieldReplacer) Sets input field replacers.
void	setName(String name) Sets connector's short name for logging and monitoring.
void	setPassword(String password) Sets password for authorization.
void	setReconnectDelay(long delay) Sets reconnection delay.
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.
void	start() Starts connector (connection is immediately established).
void	stop() Stops connector (connection is immediately dropped).

Method Detail

getAddress

String getAddress()

Address string of connector.

Returns:

address string of this connector. It is "[host1[:port1],host2[:port2],...]:port" for client socket connector and ":port" for server socket connector.

start

void start()

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

stop

void stop()

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

restart

void restart()

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

reconnect

void reconnect()

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

Default behavior is just performing restart().

isActive

boolean isActive()

True when connector is active (started).

Returns:

true if connector is started (not stopped)

getState

MessageConnectorState getState()

State of connector.

Returns:

message connector state.

getName

String getName()

Name of connector.

Returns:

connector's short name for logging and monitoring

setName

void setName(String name)

Sets connector's short name for logging and monitoring.

Parameters:

name - connector's new short name for logging and monitoring

getUser

String getUser()

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

setUser

void setUser(String user)

Sets connector's user name for authorization.

Parameters:

user - connector's user name for authorization.

Throws:

NullPointerException - if user is null

getPassword

String getPassword()

User password for authorization.

setPassword

void setPassword(String password)

Sets password for authorization.

Parameters:

password - password for authorization.

Throws:

NullPointerException - if password is null

getConnectionCount

int getConnectionCount()

Number of established connections

getThreadPriority

int getThreadPriority()

Priority for threads associated with this connector

setThreadPriority

void setThreadPriority(int priority)

Sets thread priority for all threads created by this connector.

Parameters:

priority - thread priority for all threads created by this connector

getReconnectDelay

long getReconnectDelay()

Delay between reconnection attempts in milliseconds

setReconnectDelay

void setReconnectDelay(long delay)

Sets reconnection delay.

Parameters:

delay - reconnection delay

getEndpointStats

String getEndpointStats()

Endpoint statistics since last reset

Returns:

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

resetEndpointStats

void resetEndpointStats()

Resets endpoint statistics

retrieveCompleteEndpointStats

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

Retrieves endpoint statistics for this message connector since its creation

getFieldReplacer

String getFieldReplacer()

Returns configured input field replacers.

setFieldReplacer

void setFieldReplacer(String fieldReplacer)

Sets input field replacers.

Parameters:

fieldReplacer - field replacers specification.