001/* 002 * (C) Copyright 2017 Nuxeo (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 * Florent Guillaume 018 */ 019package org.nuxeo.runtime.pubsub; 020 021import java.util.List; 022import java.util.Map; 023import java.util.function.BiConsumer; 024 025/** 026 * The SPI of a Publish/Subscribe implementation of the {@link PubSubService}. 027 * 028 * @since 9.1 029 */ 030public interface PubSubProvider { 031 032 /** 033 * Initializes the resources for this provider and registers the local subscribers map. 034 * <p> 035 * The options taken from the {@link PubSubProviderDescriptor} 036 * The subscribers map structure is thread-safe. The implementation must not modify the subscribers map in any way. 037 */ 038 void initialize(Map<String, String> options, Map<String, List<BiConsumer<String, byte[]>>> subscribers); 039 040 /** 041 * Frees the resources. 042 */ 043 void close(); 044 045 /** 046 * Publishes a message to the given topic. 047 * 048 * @param topic the topic 049 * @param message the message 050 */ 051 void publish(String topic, byte[] message); 052 053}