Copy policy-endpoints from drools-pdp to common

Issue-ID: POLICY-967
Change-Id: I374c155ee102c3e157c60d0a22d7191544abb76a
Signed-off-by: mmis <michael.morris@ericsson.com>

1 files changed, 158 insertions, 0 deletions

diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java
new file mode 100644
index 00000000..adfb4b42
--- /dev/null
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java
@@ -0,0 +1,158 @@
+/*
+ * ============LICENSE_START=======================================================
+ * policy-endpoints
+ * ================================================================================
+ * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.endpoints.event.comm.bus;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+
+/**
+ * DMAAP Topic Source Factory
+ */
+public interface DmaapTopicSourceFactory {
+    public final String DME2_READ_TIMEOUT_PROPERTY = "AFT_DME2_EP_READ_TIMEOUT_MS";
+    public final String DME2_EP_CONN_TIMEOUT_PROPERTY = "AFT_DME2_EP_CONN_TIMEOUT";
+    public final String DME2_ROUNDTRIP_TIMEOUT_PROPERTY = "AFT_DME2_ROUNDTRIP_TIMEOUT_MS";
+    public final String DME2_VERSION_PROPERTY = "Version";
+    public final String DME2_ROUTE_OFFER_PROPERTY = "routeOffer";
+    public final String DME2_SERVICE_NAME_PROPERTY = "ServiceName";
+    public final String DME2_SUBCONTEXT_PATH_PROPERTY = "SubContextPath";
+    public final String DME2_SESSION_STICKINESS_REQUIRED_PROPERTY = "sessionstickinessrequired";
+
+    /**
+     * Creates an DMAAP Topic Source based on properties files
+     * 
+     * @param properties Properties containing initialization values
+     * 
+     * @return an DMAAP Topic Source
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public List<DmaapTopicSource> build(Properties properties);
+
+    /**
+     * Instantiates a new DMAAP Topic Source
+     * 
+     * @param servers list of servers
+     * @param topic topic name
+     * @param apiKey API Key
+     * @param apiSecret API Secret
+     * @param userName user name
+     * @param password password
+     * @param consumerGroup Consumer Group
+     * @param consumerInstance Consumer Instance
+     * @param fetchTimeout Read Fetch Timeout
+     * @param fetchLimit Fetch Limit
+     * @param managed is this endpoind managed?
+     * @param useHttps does the connection use HTTPS?
+     * @param allowSelfSignedCerts does connection allow self-signed certificates?
+     * 
+     * @return an DMAAP Topic Source
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public DmaapTopicSource build(List<String> servers, String topic, String apiKey, String apiSecret, String userName,
+            String password, String consumerGroup, String consumerInstance, int fetchTimeout, int fetchLimit,
+            boolean managed, boolean useHttps, boolean allowSelfSignedCerts);
+
+    /**
+     * Instantiates a new DMAAP Topic Source
+     * 
+     * @param servers list of servers
+     * @param topic topic name
+     * @param apiKey API Key
+     * @param apiSecret API Secret
+     * @param userName user name
+     * @param password password
+     * @param consumerGroup Consumer Group
+     * @param consumerInstance Consumer Instance
+     * @param fetchTimeout Read Fetch Timeout
+     * @param fetchLimit Fetch Limit
+     * @param environment DME2 environment
+     * @param aftEnvironment DME2 AFT environment
+     * @param partner DME2 Partner
+     * @param latitude DME2 latitude
+     * @param longitude DME2 longitude
+     * @param additionalProps additional properties to pass to DME2
+     * @param managed is this endpoind managed?
+     * @param useHttps does the connection use HTTPS?
+     * @param allowSelfSignedCerts does connection allow self-signed certificates?
+     * 
+     * @return an DMAAP Topic Source
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public DmaapTopicSource build(List<String> servers, String topic, String apiKey, String apiSecret, String userName,
+            String password, String consumerGroup, String consumerInstance, int fetchTimeout, int fetchLimit,
+            String environment, String aftEnvironment, String partner, String latitude, String longitude,
+            Map<String, String> additionalProps, boolean managed, boolean useHttps, boolean allowSelfSignedCerts);
+
+    /**
+     * Instantiates a new DMAAP Topic Source
+     * 
+     * @param servers list of servers
+     * @param topic topic name
+     * @param apiKey API Key
+     * @param apiSecret API Secret
+     * 
+     * @return an DMAAP Topic Source
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public DmaapTopicSource build(List<String> servers, String topic, String apiKey, String apiSecret);
+
+    /**
+     * Instantiates a new DMAAP Topic Source
+     * 
+     * @param servers list of servers
+     * @param topic topic name
+     * 
+     * @return an DMAAP Topic Source
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public DmaapTopicSource build(List<String> servers, String topic);
+
+    /**
+     * Destroys an DMAAP Topic Source based on a topic
+     * 
+     * @param topic topic name
+     * @throws IllegalArgumentException if invalid parameters are present
+     */
+    public void destroy(String topic);
+
+    /**
+     * Destroys all DMAAP Topic Sources
+     */
+    public void destroy();
+
+    /**
+     * gets an DMAAP Topic Source based on topic name
+     * 
+     * @param topic the topic name
+     * @return an DMAAP Topic Source with topic name
+     * @throws IllegalArgumentException if an invalid topic is provided
+     * @throws IllegalStateException if the DMAAP Topic Source is an incorrect state
+     */
+    public DmaapTopicSource get(String topic);
+
+    /**
+     * Provides a snapshot of the DMAAP Topic Sources
+     * 
+     * @return a list of the DMAAP Topic Sources
+     */
+    public List<DmaapTopicSource> inventory();
+}