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 org.nuxeo.ecm.core.event.EventBundle; 022import org.nuxeo.ecm.core.event.EventService; 023 024import java.util.Map; 025 026/** 027 * Interface for a pipe of events. This is the abstraction used to bridge the Nuxeo events to pipes that consume them. 028 * 029 * @since 8.4 030 */ 031public interface EventBundlePipe { 032 033 /** 034 * Initialize the Pipe when Nuxeo Event Service starts 035 * 036 * @param name the name as defined in the XMap descriptor 037 * @param params the parameters as defined in the XMap descriptor 038 */ 039 void initPipe(String name, Map<String, String> params); 040 041 /** 042 * Send an {@link EventBundle} inside the pipe 043 * 044 * @param events 045 */ 046 void sendEventBundle(EventBundle events); 047 048 /** 049 * Wait until the end of event consumption 050 * 051 * @param timeoutMillis 052 * @return 053 * @throws InterruptedException 054 */ 055 boolean waitForCompletion(long timeoutMillis) throws InterruptedException; 056 057 /** 058 * Shutdown callback when the {@link EventService} stops 059 * 060 * @throws InterruptedException 061 */ 062 void shutdown() throws InterruptedException; 063}