io.stargate.sgv2.api.common.token.CassandraTokenResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sgv2-quarkus-common Show documentation

There is a newer version: 2.1.0-BETA-19

/*
 * Copyright The Stargate Authors
 *
 * 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 io.stargate.sgv2.api.common.token;

import io.vertx.ext.web.RoutingContext;
import jakarta.ws.rs.core.SecurityContext;
import java.util.Optional;

/**
 * Resolver of the Cassandra token. This token will be passed to the Bridge.
 *
 * The implementation can use any information from the {@link RoutingContext} or {@link
 * SecurityContext} to obtain the token.
 */
@FunctionalInterface
public interface CassandraTokenResolver {

  /**
   * Returns a Cassandra token given a {@link RoutingContext} and a {@link SecurityContext}.
   *
   * @param context the routing context
   * @param securityContext the security context
   * @return The Cassandra token to pass to the Bridge. If empty, indicates that no token should be
   *     used..
   */
  Optional resolve(RoutingContext context, SecurityContext securityContext);
}