Initial TCA commit into DCAEGEN2
[dcaegen2/analytics/tca.git] / dcae-analytics-dmaap / src / main / java / org / openecomp / dcae / apod / analytics / dmaap / service / publisher / DMaaPMRPublisherFactory.java
1 /*
2  * ===============================LICENSE_START======================================
3  *  dcae-analytics
4  * ================================================================================
5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  *  Licensed under the Apache License, Version 2.0 (the "License");
8  *  you may not use this file except in compliance with the License.
9  *   You may obtain a copy of the License at
10  *
11  *          http://www.apache.org/licenses/LICENSE-2.0
12  *
13  *  Unless required by applicable law or agreed to in writing, software
14  *  distributed under the License is distributed on an "AS IS" BASIS,
15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  *  See the License for the specific language governing permissions and
17  *  limitations under the License.
18  *  ============================LICENSE_END===========================================
19  */
20
21 package org.openecomp.dcae.apod.analytics.dmaap.service.publisher;
22
23 import org.openecomp.dcae.apod.analytics.dmaap.DMaaPMRFactory;
24 import org.openecomp.dcae.apod.analytics.dmaap.domain.config.DMaaPMRPublisherConfig;
25
26 /**
27  * <p>
28  *     Factory to initialize instance of {@link DMaaPMRPublisher} for Guice DI injection purposes.
29  * <p>
30  *     <strong>
31  *          NOTE: Client should not use this Factory to initialize {@link DMaaPMRPublisher} unless they
32  *                are wiring dependencies using Guice. Client must use {@link DMaaPMRFactory} to initialize
33  *                guice injected Publisher instances
34  *      </strong>
35  * <p>
36  * @author Rajiv Singla . Creation Date: 10/20/2016.
37  */
38 public interface DMaaPMRPublisherFactory {
39
40     /**
41      * Guice Factory to create DMaaP MR Publisher
42      *
43      * @param publisherConfig publisher config
44      *
45      * @return DMaaP MR Publisher instance
46      */
47     DMaaPMRPublisher create(DMaaPMRPublisherConfig publisherConfig);
48
49 }