001/* 002 * (C) Copyright 2006-2016 Nuxeo SA (http://nuxeo.com/) and others. 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 * http://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 * 016 * Contributors: 017 * tiry 018 */ 019package org.nuxeo.ecm.core.event.pipe; 020 021import java.util.List; 022import java.util.Map; 023 024/** 025 * SPI for a consumer of messages inside the {@link EventBundlePipe} 026 * 027 * @since 8.4 028 */ 029public interface PipeConsumer<T> { 030 031 /** 032 * Initialize the Consumer when the {@link EventBundlePipe} is initialized 033 * 034 * @param name 035 * @param params 036 */ 037 void initConsumer(String name, Map<String, String> params); 038 039 /** 040 * Callback when a batch of messages is available 041 * 042 * @param messages 043 * @return 044 */ 045 boolean receiveMessage(List<T> messages); 046 047 /** 048 * Shutdown the consumer when the {@link EventBundlePipe} is shutdown 049 * 050 * @throws InterruptedException 051 */ 052 void shutdown() throws InterruptedException; 053 054 /** 055 * Wait until consumer is done 056 * 057 * @param timeoutMillis 058 * @return 059 * @throws InterruptedException 060 */ 061 boolean waitForCompletion(long timeoutMillis) throws InterruptedException; 062 063}