MessageConnectorMBean (QD Core API 3.352)

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`getAddress()` Address string of connector.
`default String`	`getAggregationPeriod()` Returns the default aggregation period (alias for `getDefaultAggregationPeriod()`).
`default String`	`getAggregationPeriodInfoStr()` Returns the current effective aggregation period info as JSON across all active connections.
`int`	`getConnectionCount()` Number of established connections
`default String`	`getDefaultAggregationPeriod()` Returns the default aggregation period for server-side connections, or `null` if not set.
`String`	`getEndpointStats()` Endpoint statistics since last reset
`String`	`getFieldReplacer()` Returns configured input field replacers.
`default String`	`getMaxAggregationPeriod()` Returns the maximum aggregation period bound for server-side connections, or `null` if not set.
`default String`	`getMinAggregationPeriod()` Returns the minimum aggregation period bound for server-side connections, or `null` if not set.
`String`	`getName()` Name of connector.
`String`	`getPassword()` User password for authorization.
`long`	`getReconnectDelay()` Delay between reconnection attempts in milliseconds
`default String`	`getRequestedAggregationPeriod()` Returns the client-requested aggregation period string.
`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
`default void`	`setDefaultAggregationPeriod(String defaultAggregationPeriod)` Sets the default aggregation period applied when client doesn't specify one.
`void`	`setFieldReplacer(String fieldReplacer)` Sets input field replacers.
`default void`	`setMaxAggregationPeriod(String maxAggregationPeriod)` Sets the maximum bound for aggregation period validation.
`default void`	`setMinAggregationPeriod(String minAggregationPeriod)` Sets the minimum bound for aggregation period validation.
`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.
`default void`	`setRequestedAggregationPeriod(String requestedAggregationPeriod)` Sets the requested aggregation period to send to the server via DESCRIBE_PROTOCOL.
`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.
  - getAggregationPeriodInfoStr
```
default String getAggregationPeriodInfoStr()
```
    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.
  - getRequestedAggregationPeriod
```
default String getRequestedAggregationPeriod()
```
    Returns the client-requested aggregation period string. Returns null if not set. Applicable for client-side connectors (propagated to all DistributorAdapters).
  - setRequestedAggregationPeriod
```
default void setRequestedAggregationPeriod(String requestedAggregationPeriod)
```
    Sets the requested aggregation period to send to the server via DESCRIBE_PROTOCOL. Propagated to all active DistributorAdapter connections.
    
    Parameters:
    
    requestedAggregationPeriod - aggregation period string (e.g. "1s", "0.5s"), or "undefined"/null/empty to reset (server uses its default)
  - getDefaultAggregationPeriod
```
default String getDefaultAggregationPeriod()
```
    Returns the default aggregation period for server-side connections, or null if not set. Alias: getAggregationPeriod().
  - setDefaultAggregationPeriod
```
default void setDefaultAggregationPeriod(String defaultAggregationPeriod)
```
    Sets the default aggregation period applied when client doesn't specify one. Propagated to all active AgentAdapter connections.
    
    Parameters:
    
    defaultAggregationPeriod - default aggregation period string (e.g. "1s"), or null to reset
  - getAggregationPeriod
```
default String getAggregationPeriod()
```
    Returns the default aggregation period (alias for getDefaultAggregationPeriod()).
  - getMinAggregationPeriod
```
default String getMinAggregationPeriod()
```
    Returns the minimum aggregation period bound for server-side connections, or null if not set.
  - setMinAggregationPeriod
```
default void setMinAggregationPeriod(String minAggregationPeriod)
```
    Sets the minimum bound for aggregation period validation. Client requests below this value will be clamped up.
    
    Parameters:
    
    minAggregationPeriod - minimum aggregation period string (e.g. "0.5s"), or null to reset
  - getMaxAggregationPeriod
```
default String getMaxAggregationPeriod()
```
    Returns the maximum aggregation period bound for server-side connections, or null if not set.
  - setMaxAggregationPeriod
```
default void setMaxAggregationPeriod(String maxAggregationPeriod)
```
    Sets the maximum bound for aggregation period validation. Client requests above this value will be clamped down.
    
    Parameters:
    
    maxAggregationPeriod - maximum aggregation period string (e.g. "5s"), or null to reset

Interface MessageConnectorMBean

Method Summary

Method Detail

getAddress

start

stop

restart

reconnect

isActive

getState

getName

setName

getUser

setUser

getPassword

setPassword

getConnectionCount

getThreadPriority

setThreadPriority

getReconnectDelay

setReconnectDelay

getEndpointStats

resetEndpointStats

retrieveCompleteEndpointStats

getFieldReplacer

setFieldReplacer

getAggregationPeriodInfoStr

getRequestedAggregationPeriod

setRequestedAggregationPeriod

getDefaultAggregationPeriod

setDefaultAggregationPeriod

getAggregationPeriod

getMinAggregationPeriod

setMinAggregationPeriod

getMaxAggregationPeriod

setMaxAggregationPeriod