-/*\r
- * ===============================LICENSE_START======================================\r
- * dcae-analytics\r
- * ================================================================================\r
- * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
- * ================================================================================\r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- * ============================LICENSE_END===========================================\r
- */\r
-\r
-package org.openecomp.dcae.apod.analytics.dmaap.service.publisher;\r
-\r
-import org.openecomp.dcae.apod.analytics.common.exception.DCAEAnalyticsRuntimeException;\r
-import org.openecomp.dcae.apod.analytics.dmaap.domain.config.DMaaPMRPublisherConfig;\r
-import org.openecomp.dcae.apod.analytics.dmaap.domain.response.DMaaPMRPublisherResponse;\r
-\r
-import java.util.Date;\r
-import java.util.List;\r
-\r
-/**\r
- * <p>\r
- * DMaaP MR Publisher can be used to publish messages to DMaaP MR Topics.\r
- * <p>\r
- *\r
- * @author Rajiv Singla . Creation Date: 10/13/2016.\r
- */\r
-public interface DMaaPMRPublisher extends AutoCloseable {\r
-\r
-\r
- /**\r
- * <p>\r
- * Adds collection of messages to DMaaP MR Topic Publishing Queue.\r
- * <p>\r
- * Note: Invoking this method may or may not cause publishing immediately\r
- * as publishing in done is batch mode by default. Parameter maxBatchSize\r
- * in {@link DMaaPMRPublisherConfig} is used to determine max batch queue size.\r
- * If the maxBatchSize is reached all message will be published automatically\r
- * during subsequent call.\r
- * </p>\r
- *\r
- * @param messages messages to publish to DMaaP MR Publisher\r
- * @return response which may contain Http Response code 202 (Accepted) as publishing\r
- * will proceed when max batch size is reached. Throws {@link DCAEAnalyticsRuntimeException}\r
- * if publishing fails\r
- */\r
- DMaaPMRPublisherResponse publish(List<String> messages);\r
-\r
-\r
- /**\r
- * <p>\r
- * Forces publishing of messages to DMaaP MR Topic and returns {@link DMaaPMRPublisherResponse}\r
- * which can be inspected for HTTP status code of publishing call to DMaaP MR Topic.\r
- * </p>\r
- *\r
- * @param messages messages to publish to DMaaP MR Publisher\r
- * @return DMaaP Message Router Publisher Response. Throws {@link DCAEAnalyticsRuntimeException}\r
- * if force publishing fails\r
- *\r
- */\r
- DMaaPMRPublisherResponse forcePublish(List<String> messages);\r
-\r
-\r
- /**\r
- * <p>\r
- * Forces publishing of messages in Publisher queue to DMaaP MR Topic and returns\r
- * {@link DMaaPMRPublisherResponse}.If there are no messages were in the queue to\r
- * be flushed response code 304 (Not Modified) will be returned\r
- * </p>\r
- *\r
- * @return DMaaP Message Router Publisher Response\r
- */\r
- DMaaPMRPublisherResponse flush();\r
-\r
-\r
- /**\r
- * <p>\r
- * Returns the creation time when Publisher instance was created.\r
- * <p>\r
- *\r
- * @return creation time of Subscriber instance\r
- */\r
- Date getPublisherCreationTime();\r
-\r
-\r
-}\r
+/*
+ * ===============================LICENSE_START======================================
+ * dcae-analytics
+ * ================================================================================
+ * Copyright © 2017 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.dcae.apod.analytics.dmaap.service.publisher;
+
+import org.onap.dcae.apod.analytics.common.exception.DCAEAnalyticsRuntimeException;
+import org.onap.dcae.apod.analytics.dmaap.domain.config.DMaaPMRPublisherConfig;
+import org.onap.dcae.apod.analytics.dmaap.domain.response.DMaaPMRPublisherResponse;
+
+import java.util.Date;
+import java.util.List;
+
+/**
+ * <p>
+ * DMaaP MR Publisher can be used to publish messages to DMaaP MR Topics.
+ * <p>
+ *
+ * @author Rajiv Singla . Creation Date: 10/13/2016.
+ */
+public interface DMaaPMRPublisher extends AutoCloseable {
+
+
+ /**
+ * <p>
+ * Adds collection of messages to DMaaP MR Topic Publishing Queue.
+ * <p>
+ * Note: Invoking this method may or may not cause publishing immediately
+ * as publishing in done is batch mode by default. Parameter maxBatchSize
+ * in {@link DMaaPMRPublisherConfig} is used to determine max batch queue size.
+ * If the maxBatchSize is reached all message will be published automatically
+ * during subsequent call.
+ * </p>
+ *
+ * @param messages messages to publish to DMaaP MR Publisher
+ * @return response which may contain Http Response code 202 (Accepted) as publishing
+ * will proceed when max batch size is reached. Throws {@link DCAEAnalyticsRuntimeException}
+ * if publishing fails
+ */
+ DMaaPMRPublisherResponse publish(List<String> messages);
+
+
+ /**
+ * <p>
+ * Forces publishing of messages to DMaaP MR Topic and returns {@link DMaaPMRPublisherResponse}
+ * which can be inspected for HTTP status code of publishing call to DMaaP MR Topic.
+ * </p>
+ *
+ * @param messages messages to publish to DMaaP MR Publisher
+ * @return DMaaP Message Router Publisher Response. Throws {@link DCAEAnalyticsRuntimeException}
+ * if force publishing fails
+ *
+ */
+ DMaaPMRPublisherResponse forcePublish(List<String> messages);
+
+
+ /**
+ * <p>
+ * Forces publishing of messages in Publisher queue to DMaaP MR Topic and returns
+ * {@link DMaaPMRPublisherResponse}.If there are no messages were in the queue to
+ * be flushed response code 304 (Not Modified) will be returned
+ * </p>
+ *
+ * @return DMaaP Message Router Publisher Response
+ */
+ DMaaPMRPublisherResponse flush();
+
+
+ /**
+ * <p>
+ * Returns the creation time when Publisher instance was created.
+ * <p>
+ *
+ * @return creation time of Subscriber instance
+ */
+ Date getPublisherCreationTime();
+
+
+}
Code Review / dcaegen2 / analytics / tca.git / blobdiff