oracle.kv.impl.async.exception.ConnectionHandlerShutdownException Maven / Gradle / Ivy

Go to download
/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv.impl.async.exception;

import oracle.kv.impl.async.CreatorEndpoint;

/**
 * This exception is thrown when {@link CreatorEndpoint#startDialog} is called
 * but the underlying handler of the connection is being terminated for some
 * reason.
 */
public class ConnectionHandlerShutdownException extends ConnectionException {

    private static final String MESSAGE = "Connection handler is unavailable";
    private static final long serialVersionUID = 1L;

    /**
     * Constructs the exception.
     */
    public ConnectionHandlerShutdownException() {
        super(false /* not from remote */,
              MESSAGE,
              null /* no cause */);
    }

    /**
     * Returns {@code false} since a new connection handler will be created the
     * next time we start a dialog.
     */
    @Override
    public boolean shouldBackoff() {
        return false;
    }

    /**
     * Checks for side effect.
     */
    @Override
    public void checkSideEffect(boolean hasSideEffect) {
        if (hasSideEffect) {
            throw new IllegalArgumentException(
                "This exception should have no side effects");
        }
    }
}