gerrit.onap Code Review - policy/common.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019 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.onap.policy.common.endpoints.event.comm.bus;
  22
  23 import java.util.List;
  24 import java.util.Properties;
  25 import org.onap.policy.common.endpoints.event.comm.Topic;
  26
  27 /**
  28  * Topic Base Factory.
  29  *
  30  * @param <T> Type.
  31  */
  32 public interface TopicBaseFactory<T extends Topic> {
  33
  34     /**
  35      * build a TopicBase instance.
  36      *
  37      * @param properties properties.
  38      * @return T instance.
  39      */
  40     List<T> build(Properties properties);
  41
  42     /**
  43      * build a TopicBase instance.
  44      *
  45      * @param servers servers.
  46      * @param topic topic.
  47      * @param managed managed.
  48      * @return T instance.
  49      */
  50     T build(List<String> servers, String topic, boolean managed);
  51
  52     /**
  53      * destroy TopicBase instance.
  54      * @param topic topic.
  55      */
  56     void destroy(String topic);
  57
  58     /**
  59      * destroy.
  60      */
  61     void destroy();
  62
  63     /**
  64      * get T instance.
  65      *
  66      * @param topic topic.
  67      * @return T instance.
  68      */
  69     T get(String topic);
  70
  71     /**
  72      * inventory of T instances.
  73      *
  74      * @return T instance list.
  75      */
  76     List<T> inventory();
  77 }