com.couchbase.client.core.cnc.events.config.CollectionMapRefreshFailedEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation

The official Couchbase JVM Core IO Library

There is a newer version: 3.7.2

/*
 * Copyright (c) 2019 Couchbase, 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.couchbase.client.core.cnc.events.config;

import com.couchbase.client.core.cnc.AbstractEvent;
import com.couchbase.client.core.cnc.Context;
import com.couchbase.client.core.io.CollectionIdentifier;

import java.time.Duration;

/**
 * This event is raised if a collection map could not be refreshed properly.
 */
public class CollectionMapRefreshFailedEvent extends AbstractEvent {

  private final Throwable cause;
  private final Reason reason;
  private final CollectionIdentifier collectionIdentifier;

  public CollectionMapRefreshFailedEvent(Duration duration, Context context, CollectionIdentifier collectionIdentifier,
                                         Throwable cause, Reason reason) {
    super(Severity.WARN, Category.CONFIG, duration, context);
    this.cause = cause;
    this.reason = reason;
    this.collectionIdentifier = collectionIdentifier;
  }

  public CollectionIdentifier collectionIdentifier() {
    return collectionIdentifier;
  }

  @Override
  public Throwable cause() {
    return cause;
  }

  @Override
  public String description() {
    return "Collection Map refresh (" + collectionIdentifier + ") failed: " + reason;
  }

  public enum Reason {
    /**
     * Dispatching the operation failed for some reason (see cause).
     */
    FAILED,
    /**
     * Collections are nut supported by the server.
     */
    NOT_SUPPORTED,
    /**
     * The collection the client asked for is unknown to the server.
     */
    UNKNOWN_COLLECTION,
    /**
     * The scope the client asked for is unknown to the server.
     */
    UNKNOWN_SCOPE,
    /**
     * The server returned success, but it did not send a collection id.
     */
    COLLECTION_ID_NOT_PRESENT,
    /**
     * The client sent an invalid request to the server.
     */
    INVALID_REQUEST,
    /**
     * An unknown failure occurred (see cause).
     */
    UNKNOWN
  }

}