QDEndpoint (QD Core API 3.352)

java.lang.Object
- com.devexperts.qd.qtp.QDEndpoint

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class QDEndpoint
extends Object
implements Closeable
```
Named collection of QD collectors and network connections. Use newBuilder().build() to create an instance of this class.
Threads and locks
This class is tread-safe.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QDEndpoint.Builder` Builder that creates instances of `QDEndpoint` objects.
`static interface`	`QDEndpoint.ConnectorInitializer` A strategy that defines how to create `MessageConnectors`, which should be used `QDEndpoint` for `connect(String)`.
`static class`	`QDEndpoint.Plugin`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DXFEED_STICKY_SUBSCRIPTION_PROPERTY` Defines a sticky subscription period in format of `TimePeriod`
`static String`	`DXFEED_STRIPE_PROPERTY` Defines symbol striping strategy for an endpoint.
`protected com.devexperts.logging.Logging`	`log`
`static String`	`NAME_PROPERTY` Defines name for an endpoint that is used to distinguish multiple endpoints in the same JVM in logs and in other diagnostic means.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QDEndpoint(QDEndpoint.Builder builder, QDStats rootStats)`
`protected`	`QDEndpoint(String name, DataScheme scheme, QDStats rootStats, List<QDCollector.Factory> collectors, boolean withEventTimeSequence, boolean storeEverything)` Deprecated. Use `QDEndpoint.Builder.build()` or builder constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`QDEndpoint`	`addCollector(QDCollector collector)` Deprecated.
`QDEndpoint`	`addCollectors(QDCollector... collectors)` Deprecated.
`QDEndpoint`	`addConnectors(Collection<MessageConnector> connectors)`
`protected void`	`addConnectorsImpl(Collection<MessageConnector> connectors)`
`QDEndpoint`	`addMessageConnectionListener(MessageConnectorListener listener)`
`void`	`addPlugin(QDEndpoint.Plugin plugin)`
`void`	`awaitProcessed()`
`void`	`cleanupConnectors()` Permanently closes all connectors and cleans up their resources.
`protected void`	`cleanupConnectorsImpl(Collection<MessageConnector> connectors)`
`void`	`close()` Closes this endpoint.
`protected void`	`closeImpl()`
`void`	`connect(String address)` Connects the endpoint to specified address(es).
`com.devexperts.util.TimePeriodInfo`	`getAggregationPeriodInfo()` Returns aggregated aggregation period info across all connectors.
`QDCollector`	`getCollector(QDContract contract)`
`Collection<QDCollector>`	`getCollectors()`
`List<MessageConnector>`	`getConnectors()`
`Set<QDContract>`	`getContracts()`
`Map<String,String>`	`getDescriptorProperties()`
`com.devexperts.connector.proto.EndpointId`	`getEndpointId()`
`QDHistory`	`getHistory()`
`Object`	`getLock()`
`String`	`getName()`
`com.devexperts.util.TimePeriod`	`getRequestedAggregationPeriod()` Returns the requested aggregation period, or `null` if not set.
`QDStats`	`getRootStats()`
`DataScheme`	`getScheme()`
`QDStream`	`getStream()`
`QDTicker`	`getTicker()`
`boolean`	`hasConnectorInitializer()` Returns `true` if this endpoint has a `QDEndpoint.ConnectorInitializer`, otherwise returns `false`
`boolean`	`hasEventTimeSequence()` Returns `true` if this endpoint supports event time sequence or any it's collector supports event time sequence
`void`	`initializeConnectorsForAddress(String address)` Initializes endpoint's connectors to the specified address(es).
`boolean`	`isClosed()`
`static QDEndpoint.Builder`	`newBuilder()` Creates new `QDEndpoint.Builder` instance.
`QDEndpoint`	`password(String password)`
`void`	`reconnectActiveConnectors()`
`void`	`registerMonitoringTask(Runnable task)` This method registers monitoring task that is invoked periodically when "qds-monitoring" module is in classpath.
`QDEndpoint`	`removeConnectors(Collection<MessageConnector> connectors)`
`protected void`	`removeConnectorsImpl(Collection<MessageConnector> connectors)`
`QDEndpoint`	`removeMessageConnectionListener(MessageConnectorListener listener)`
`void`	`removePlugin(QDEndpoint.Plugin plugin)`
`void`	`restartActiveConnectors()`
`void`	`setConnectorInitializer(QDEndpoint.ConnectorInitializer connectorInitializer)` Sets `QDEndpoint.ConnectorInitializer` for this endpoint, which is used in `connect(String)`
`void`	`setRequestedAggregationPeriod(com.devexperts.util.TimePeriod requestedAggregationPeriod)` Sets the requested aggregation period and propagates to all connectors.
`QDEndpoint`	`startConnectors()`
`void`	`stopConnectors()`
`void`	`stopConnectorsAndWait()`
`void`	`stopConnectorsAndWaitUninterruptibly()`
`QDEndpoint`	`user(String user)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME_PROPERTY
```
public static final String NAME_PROPERTY
```
    Defines name for an endpoint that is used to distinguish multiple endpoints in the same JVM in logs and in other diagnostic means. Use QDEndpoint.Builder.withProperty(String, String) method. This property is also changed by QDEndpoint.Builder.withName(String) method.
    
    See Also:
    
    Constant Field Values
  - DXFEED_STRIPE_PROPERTY
```
public static final String DXFEED_STRIPE_PROPERTY
```
    Defines symbol striping strategy for an endpoint. Use QDEndpoint.Builder.withProperty(String, String). This property is also changed by QDEndpoint.Builder.withStripe(String) or QDEndpoint.Builder.withStriper(SymbolStriper) method.
    
    See Also:
    
    SymbolStriper, Constant Field Values
  - DXFEED_STICKY_SUBSCRIPTION_PROPERTY
```
public static final String DXFEED_STICKY_SUBSCRIPTION_PROPERTY
```
    Defines a sticky subscription period in format of TimePeriod
    
    See Also:
    
    Constant Field Values
  - log
```
protected final com.devexperts.logging.Logging log
```
- Constructor Detail
  - QDEndpoint
```
@Deprecated
protected QDEndpoint(String name,
                                 DataScheme scheme,
                                 QDStats rootStats,
                                 List<QDCollector.Factory> collectors,
                                 boolean withEventTimeSequence,
                                 boolean storeEverything)
```
    Deprecated. Use QDEndpoint.Builder.build() or builder constructor.
    
    Creates custom endpoint with a specified name, scheme, and root stats, without management. This constructor is used only if user defines all management for this endpoint and automated management is not necessary.
  - QDEndpoint
```
protected QDEndpoint(QDEndpoint.Builder builder,
                     QDStats rootStats)
```
- Method Detail
  - newBuilder
```
public static QDEndpoint.Builder newBuilder()
```
    Creates new QDEndpoint.Builder instance. Use QDEndpoint.Builder.build() to build an instance of QDEndpoint when all configuration properties were set.
    
    Returns:
    
    the created endpoint builder.
  - getLock
```
public Object getLock()
```
  - connect
```
public void connect(String address)
```
    Connects the endpoint to specified address(es). This method can be used only when sets connectorInitializer, otherwise it will be IllegalStateException.
    
    Parameters:
    
    address - address(es) to connect to.
    
    See Also:
    
    hasConnectorInitializer()
  - initializeConnectorsForAddress
```
public void initializeConnectorsForAddress(String address)
```
    Initializes endpoint's connectors to the specified address(es). This method can be used only when sets connectorInitializer, otherwise it will be IllegalStateException.
    
    Parameters:
    
    address - address(es) to connect to.
    
    See Also:
    
    hasConnectorInitializer()
  - setConnectorInitializer
```
public void setConnectorInitializer(QDEndpoint.ConnectorInitializer connectorInitializer)
```
    Sets QDEndpoint.ConnectorInitializer for this endpoint, which is used in connect(String)
    
    Parameters:
    
    connectorInitializer - QDEndpoint.ConnectorInitializer, which is used in connect(String)
  - hasConnectorInitializer
```
public boolean hasConnectorInitializer()
```
    Returns true if this endpoint has a QDEndpoint.ConnectorInitializer, otherwise returns false
    
    Returns:
    
    true if this endpoint has a QDEndpoint.ConnectorInitializer, otherwise returns false
  - hasEventTimeSequence
```
public boolean hasEventTimeSequence()
```
    Returns true if this endpoint supports event time sequence or any it's collector supports event time sequence
    
    Returns:
    
    true if this endpoint supports event time sequence or any it's collector supports event time sequence
  - isClosed
```
public boolean isClosed()
```
  - getName
```
public final String getName()
```
  - getDescriptorProperties
```
public Map<String,String> getDescriptorProperties()
```
  - getScheme
```
public final DataScheme getScheme()
```
  - getRootStats
```
public QDStats getRootStats()
```
  - getTicker
```
public final QDTicker getTicker()
```
  - getStream
```
public final QDStream getStream()
```
  - getHistory
```
public final QDHistory getHistory()
```
  - getCollector
```
public QDCollector getCollector(QDContract contract)
```
  - getContracts
```
public Set<QDContract> getContracts()
```
  - getCollectors
```
public Collection<QDCollector> getCollectors()
```
  - getConnectors
```
public List<MessageConnector> getConnectors()
```
  - addCollector
```
@Deprecated
public QDEndpoint addCollector(QDCollector collector)
```
    Deprecated.
  - addCollectors
```
@Deprecated
public QDEndpoint addCollectors(QDCollector... collectors)
```
    Deprecated.
  - addPlugin
```
public final void addPlugin(QDEndpoint.Plugin plugin)
```
  - removePlugin
```
public final void removePlugin(QDEndpoint.Plugin plugin)
```
  - user
```
public QDEndpoint user(String user)
```
  - password
```
public QDEndpoint password(String password)
```
  - getRequestedAggregationPeriod
```
public com.devexperts.util.TimePeriod getRequestedAggregationPeriod()
```
    Returns the requested aggregation period, or null if not set.
    
    See Also:
    
    DXEndpoint, "Aggregation period"
  - setRequestedAggregationPeriod
```
public void setRequestedAggregationPeriod(com.devexperts.util.TimePeriod requestedAggregationPeriod)
```
    Sets the requested aggregation period and propagates to all connectors.
    
    See Also:
    
    DXEndpoint, "Aggregation period"
  - getAggregationPeriodInfo
```
public com.devexperts.util.TimePeriodInfo getAggregationPeriodInfo()
```
    Returns aggregated aggregation period info across all connectors.
    
    See Also:
    
    DXEndpoint, "Aggregation period"
  - addConnectors
```
public final QDEndpoint addConnectors(Collection<MessageConnector> connectors)
```
  - addConnectorsImpl
```
protected void addConnectorsImpl(Collection<MessageConnector> connectors)
```
  - removeConnectors
```
public final QDEndpoint removeConnectors(Collection<MessageConnector> connectors)
```
  - removeConnectorsImpl
```
protected void removeConnectorsImpl(Collection<MessageConnector> connectors)
```
  - startConnectors
```
public QDEndpoint startConnectors()
```
  - restartActiveConnectors
```
public final void restartActiveConnectors()
```
  - reconnectActiveConnectors
```
public final void reconnectActiveConnectors()
```
  - awaitProcessed
```
public final void awaitProcessed()
                          throws InterruptedException
```
    Throws:
    
    InterruptedException
  - stopConnectors
```
public final void stopConnectors()
```
  - stopConnectorsAndWait
```
public final void stopConnectorsAndWait()
                                 throws InterruptedException
```
    Throws:
    
    InterruptedException
  - stopConnectorsAndWaitUninterruptibly
```
public final void stopConnectorsAndWaitUninterruptibly()
```
  - cleanupConnectors
```
public final void cleanupConnectors()
```
    Permanently closes all connectors and cleans up their resources.
  - cleanupConnectorsImpl
```
protected void cleanupConnectorsImpl(Collection<MessageConnector> connectors)
```
  - addMessageConnectionListener
```
public QDEndpoint addMessageConnectionListener(MessageConnectorListener listener)
```
  - removeMessageConnectionListener
```
public QDEndpoint removeMessageConnectionListener(MessageConnectorListener listener)
```
  - registerMonitoringTask
```
public void registerMonitoringTask(Runnable task)
```
    This method registers monitoring task that is invoked periodically when "qds-monitoring" module is in classpath.
  - close
```
public void close()
```
    Closes this endpoint. All connectors are stopped and removed, all other associated resources are freed.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - closeImpl
```
protected void closeImpl()
```
  - getEndpointId
```
public com.devexperts.connector.proto.EndpointId getEndpointId()
```

Class QDEndpoint

Threads and locks

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_PROPERTY

DXFEED_STRIPE_PROPERTY

DXFEED_STICKY_SUBSCRIPTION_PROPERTY

log

Constructor Detail

QDEndpoint

QDEndpoint

Method Detail

newBuilder

getLock

connect

initializeConnectorsForAddress

setConnectorInitializer

hasConnectorInitializer

hasEventTimeSequence

isClosed

getName

getDescriptorProperties

getScheme

getRootStats

getTicker

getStream

getHistory

getCollector

getContracts

getCollectors

getConnectors

addCollector

addCollectors

addPlugin

removePlugin

user

password

getRequestedAggregationPeriod

setRequestedAggregationPeriod

getAggregationPeriodInfo

addConnectors

addConnectorsImpl

removeConnectors

removeConnectorsImpl

startConnectors

restartActiveConnectors

reconnectActiveConnectors

awaitProcessed

stopConnectors

stopConnectorsAndWait

stopConnectorsAndWaitUninterruptibly

cleanupConnectors

cleanupConnectorsImpl

addMessageConnectionListener

removeMessageConnectionListener

registerMonitoringTask

close

closeImpl

getEndpointId