org.springframework.kafka.event.ConsumerPausedEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-kafka Show documentation
Spring Kafka Support
The newest version!
/*
 * Copyright 2018-2023 the original author or 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
 *
 *      https://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 org.springframework.kafka.event;

import java.util.Collection;

import org.apache.kafka.common.TopicPartition;

/**
 * An event published when a consumer is paused.
 *
 * @author Gary Russell
 * @since 2.1.5
 *
 */
public class ConsumerPausedEvent extends KafkaEvent {

	private static final long serialVersionUID = 1L;

	private final String reason;

	private transient Collection partitions;

	/**
	 * Construct an instance with the provided source and partitions.
	 * @param source the container instance that generated the event.
	 * @param container the container or the parent container if the container is a child.
	 * @param partitions the partitions.
	 * @since 2.2.1
	 */
	public ConsumerPausedEvent(Object source, Object container, Collection partitions) {
		super(source, container);
		this.partitions = partitions;
		this.reason = null;
	}

	/**
	 * Construct an instance with the provided source and partitions.
	 * @param source the container instance that generated the event.
	 * @param container the container or the parent container if the container is a child.
	 * @param partitions the partitions.
	 * @param reason the reason for the pause.
	 * @since 2.8.9
	 */
	public ConsumerPausedEvent(Object source, Object container, Collection partitions,
			String reason) {

		super(source, container);
		this.partitions = partitions;
		this.reason = reason;
	}

	/**
	 * Return the paused partitions.
	 * @return the partitions.
	 */
	public Collection getPartitions() {
		return this.partitions;
	}

	@Override
	public String toString() {
		return "ConsumerPausedEvent [reason=" + this.reason + ", partitions=" + this.partitions + "]";
	}

}