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