org.springframework.batch.core.listener.CompositeItemWriteListener Maven / Gradle / Ivy

/*
 * Copyright 2006-2013 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.batch.core.listener;

import java.util.Iterator;
import java.util.List;

import org.springframework.batch.core.ItemWriteListener;
import org.springframework.core.Ordered;

/**
 * @author Lucas Ward
 * @author Dave Syer
 *
 */
public class CompositeItemWriteListener implements ItemWriteListener {

	private OrderedComposite> listeners = new OrderedComposite<>();

	/**
	 * Public setter for the listeners.
	 *
	 * @param itemWriteListeners list of {@link ItemWriteListener}s to be called when write events occur.
	 */
	public void setListeners(List> itemWriteListeners) {
		this.listeners.setItems(itemWriteListeners);
	}

	/**
	 * Register additional listener.
	 *
	 * @param itemWriteListener list of {@link ItemWriteListener}s to be registered.
	 */
	public void register(ItemWriteListener itemWriteListener) {
		listeners.add(itemWriteListener);
	}

	/**
	 * Call the registered listeners in reverse order, respecting and
	 * prioritising those that implement {@link Ordered}.
	 * @see ItemWriteListener#afterWrite(java.util.List)
	 */
	@Override
	public void afterWrite(List items) {
		for (Iterator> iterator = listeners.reverse(); iterator.hasNext();) {
			ItemWriteListener listener = iterator.next();
			listener.afterWrite(items);
		}
	}

	/**
	 * Call the registered listeners in order, respecting and prioritising those
	 * that implement {@link Ordered}.
	 * @see ItemWriteListener#beforeWrite(List)
	 */
	@Override
	public void beforeWrite(List items) {
		for (Iterator> iterator = listeners.iterator(); iterator.hasNext();) {
			ItemWriteListener listener = iterator.next();
			listener.beforeWrite(items);
		}
	}

	/**
	 * Call the registered listeners in reverse order, respecting and
	 * prioritising those that implement {@link Ordered}.
	 * @see ItemWriteListener#onWriteError(Exception, List)
	 */
	@Override
	public void onWriteError(Exception ex, List items) {
		for (Iterator> iterator = listeners.reverse(); iterator.hasNext();) {
			ItemWriteListener listener = iterator.next();
			listener.onWriteError(ex, items);
		}
	}
}