com.mongodb.event.ConnectionRemovedEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

There is a newer version: 3.12.14

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.event;

import com.mongodb.connection.ConnectionId;
import org.bson.assertions.Assertions;

/**
 * An event for removing a connection from the pool.
 *
 * @since 3.5
 */
public final class ConnectionRemovedEvent {

    /**
     * An enumeration of the reasons a connection could be closed
     * @since 3.11
     */
    public enum Reason {
        /**
         * Reason unknown
         */
        UNKNOWN,

        /**
         * The pool became stale because the pool has been cleared
         */
        STALE,

        /**
         * The connection became stale by being idle for too long
         */
        MAX_IDLE_TIME_EXCEEDED,

        /**
         * The connection became stale by being open for too long
         */
        MAX_LIFE_TIME_EXCEEDED,

        /**
         * The connection experienced an error, making it no longer valid
         */
        ERROR,

        /**
         * The pool was closed, making the connection no longer valid
         */
        POOL_CLOSED,
   }

    private final ConnectionId connectionId;
    private final Reason reason;

    /**
     * Construct an instance
     *
     * @param connectionId the connectionId
     * @deprecated Prefer {@link #ConnectionRemovedEvent(ConnectionId, Reason)}
     */
    @Deprecated
    public ConnectionRemovedEvent(final ConnectionId connectionId) {
        this(connectionId, Reason.UNKNOWN);
    }

    /**
     * Constructs an instance.
     *
     * @param connectionId the connection id
     * @param reason the reason the connection was closed
     * @since 3.11
     */
    public ConnectionRemovedEvent(final ConnectionId connectionId, final Reason reason) {
        this.connectionId = Assertions.notNull("connectionId", connectionId);
        this.reason = Assertions.notNull("reason", reason);
    }


    /**
     * Gets the connection id
     *
     * @return the connection id
     */
    public ConnectionId getConnectionId() {
        return connectionId;
    }

    /**
     * Get the reason the connection was removed.
     *
     * @return the reason
     * @since 3.11
     */
    public Reason getReason() {
        return reason;
    }

    @Override
    public String toString() {
        return "ConnectionRemovedEvent{"
                + "connectionId=" + connectionId
                + ", reason=" + reason
                + '}';
    }
}