com.rabbitmq.stream.RoutingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stream-client Show documentation

The RabbitMQ Stream Java client library allows Java applications to interface with RabbitMQ Stream.

The newest version!

// Copyright (c) 2020-2023 Broadcom. All Rights Reserved.
// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
//
// This software, the RabbitMQ Stream Java client library, is dual-licensed under the
// Mozilla Public License 2.0 ("MPL"), and the Apache License version 2 ("ASL").
// For the MPL, please see LICENSE-MPL-RabbitMQ. For the ASL,
// please see LICENSE-APACHE2.
//
// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
// either express or implied. See the LICENSE file for specific language governing
// rights and limitations of this software.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.stream;

import java.util.List;
import java.util.function.Function;

/**
 * Strategy to route outbound messages to appropriate streams.
 *
 * This is an experimental API, subject to change.
 *
 * Used for super streams (partitioned stream).
 *
 * @see ProducerBuilder#routing(Function)
 */
public interface RoutingStrategy {

  /**
   * Where to route a message.
   *
   * @param message
   * @param metadata
   * @return the list of streams to route messages to
   */
  List route(Message message, Metadata metadata);

  /** Metadata on the super stream. */
  interface Metadata {

    List partitions();

    List route(String routingKey);
  }
}