001/*
002 * Copyright 2006-2013 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core.listener;
017
018import java.util.Iterator;
019import java.util.List;
020
021import org.springframework.batch.core.ItemWriteListener;
022import org.springframework.core.Ordered;
023
024/**
025 * @author Lucas Ward
026 * @author Dave Syer
027 *
028 */
029public class CompositeItemWriteListener<S> implements ItemWriteListener<S> {
030
031        private OrderedComposite<ItemWriteListener<? super S>> listeners = new OrderedComposite<ItemWriteListener<? super S>>();
032
033        /**
034         * Public setter for the listeners.
035         *
036         * @param itemWriteListeners list of {@link ItemWriteListener}s to be called when write events occur.
037         */
038        public void setListeners(List<? extends ItemWriteListener<? super S>> itemWriteListeners) {
039                this.listeners.setItems(itemWriteListeners);
040        }
041
042        /**
043         * Register additional listener.
044         *
045         * @param itemWriteListener list of {@link ItemWriteListener}s to be registered.
046         */
047        public void register(ItemWriteListener<? super S> itemWriteListener) {
048                listeners.add(itemWriteListener);
049        }
050
051        /**
052         * Call the registered listeners in reverse order, respecting and
053         * prioritising those that implement {@link Ordered}.
054         * @see ItemWriteListener#afterWrite(java.util.List)
055         */
056        @Override
057        public void afterWrite(List<? extends S> items) {
058                for (Iterator<ItemWriteListener<? super S>> iterator = listeners.reverse(); iterator.hasNext();) {
059                        ItemWriteListener<? super S> listener = iterator.next();
060                        listener.afterWrite(items);
061                }
062        }
063
064        /**
065         * Call the registered listeners in order, respecting and prioritising those
066         * that implement {@link Ordered}.
067         * @see ItemWriteListener#beforeWrite(List)
068         */
069        @Override
070        public void beforeWrite(List<? extends S> items) {
071                for (Iterator<ItemWriteListener<? super S>> iterator = listeners.iterator(); iterator.hasNext();) {
072                        ItemWriteListener<? super S> listener = iterator.next();
073                        listener.beforeWrite(items);
074                }
075        }
076
077        /**
078         * Call the registered listeners in reverse order, respecting and
079         * prioritising those that implement {@link Ordered}.
080         * @see ItemWriteListener#onWriteError(Exception, List)
081         */
082        @Override
083        public void onWriteError(Exception ex, List<? extends S> items) {
084                for (Iterator<ItemWriteListener<? super S>> iterator = listeners.reverse(); iterator.hasNext();) {
085                        ItemWriteListener<? super S> listener = iterator.next();
086                        listener.onWriteError(ex, items);
087                }
088        }
089}