dcae-analytics-dmaap/src/main/java/org/openecomp/dcae/apod/analytics/dmaap/service/subscriber/DMaaPMRSubscriberFactory.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.subscriber;
  22
  23 import org.openecomp.dcae.apod.analytics.dmaap.DMaaPMRFactory;
  24 import org.openecomp.dcae.apod.analytics.dmaap.domain.config.DMaaPMRSubscriberConfig;
  25
  26 /**
  27  * Factory to initialize instance of {@link DMaaPMRSubscriber} for Guice DI injection purposes.
  28  * <p>
  29  *     <strong>
  30  *          NOTE: Client should not use this Factory to initialize {@link DMaaPMRSubscriber} unless they
  31  *              are wiring dependencies using Guice. Client must use {@link DMaaPMRFactory} to initialize
  32  *              guice injected Subscriber instances
  33  *      </strong>
  34  * <p>
  35  * @author Rajiv Singla . Creation Date: 10/20/2016.
  36  */
  37 public interface DMaaPMRSubscriberFactory {
  38
  39     /**
  40      * Guice Factory to create DMaaP MR Subscriber Instance
  41      *
  42      * @param subscriberConfig subscriber config
  43      *
  44      * @return DMaaP MR Subscriber instance
  45      */
  46     DMaaPMRSubscriber create(DMaaPMRSubscriberConfig subscriberConfig);
  47 }