Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

StreamingSubscriptionConnection.getIsOpen() returns false after keep-alive #742

Open
@uklance

Description

@uklance

StreamingSubscriptionConnection.getIsOpen() returns true initially, but then starts returning false after the OnDisconnect handler fires (calling StreamingSubscriptionConnection.open())

The documentation here states:

After the time-out of the connection has elapsed, the OnDisconnect event is raised by the StreamingSubscriptionConnection instance. If your application still needs to monitor the subscription, you can just call the Open method of the StreamingSubscriptionConnection instance again to reconnect to the Exchange server. This behavior is expected and is not an error condition.

Please see my code below with comments showing when connection.getIsOpen() initially returns true, but starts returning false after the disconnect handler fires

public class EwsClient {
    private final ExchangeService exchangeService;
    private final Set<StreamingSubscriptionConnection> subscriptionConnections = ConcurrentHashMap.newKeySet();
    private final int subscriptionLifetimeMinutes = 2;

    // constructor

    public void subscribe(Collection<FolderId> folderIds, EventType[] eventTypes, INotificationEventDelegate eventHandler) throws Exception {
        StreamingSubscription subscription = exchangeService.subscribeToStreamingNotifications(folderIds, eventTypes);
        StreamingSubscriptionConnection connection = new StreamingSubscriptionConnection(exchangeService, subscriptionLifetimeMinutes), eventHandler);

        ISubscriptionErrorDelegate disconnectHandler = (sender, args) -> {
            try {
                connection.open(); // connection.getIsOpen() will start returning false now
            } catch (Exception e) {
                // I would expect connection.getIsOpen() will start returning false now
                log.error("Could not reconnect to the exchange server", e);
            }
        };
        connection.addSubscription(subscription);
        connection.addOnNotificationEvent(eventHandler);
        connection.addOnDisconnect(disconnectHandler);
        subscriptionConnections.add(connection);
        connection.open(); // connection.getIsOpen() will return true initially
    }

    // I use this method in a spring boot health check
    public boolean isSubscriptionsOpen() {
        return subscriptionConnections.stream().allMatch(connection -> {
            try {
                return connection.getIsOpen();
            } catch (Exception e) {
                log.error("Error validating subscription connection", e);
                return false;
            }
        });
    }
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions