From 04c868333214c0e5bfce3926c43a4302615f2ac5 Mon Sep 17 00:00:00 2001
From: Maros Marsalek <mmarsale@cisco.com>
Date: Wed, 26 Oct 2016 12:18:11 +0200
Subject: Honeycomb-73 Extensible initializers framework

Change-Id: Ib23453d4040d59a512686315995a5cf9e532cefc
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
---
 .../translate/spi/read/InitializingCustomizer.java | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/read/InitializingCustomizer.java

(limited to 'infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/read/InitializingCustomizer.java')

diff --git a/infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/read/InitializingCustomizer.java b/infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/read/InitializingCustomizer.java
new file mode 100644
index 000000000..ce4b2a6e9
--- /dev/null
+++ b/infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/read/InitializingCustomizer.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.translate.spi.read;
+
+import io.fd.honeycomb.translate.read.ReadContext;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * ReadCustomizers which want to participate in the initializing process need to implement this interface.
+ * <p/>
+ * It is triggered after Honeycomb initializes the plugins to give them a change
+ * reconcile(put data in HC in sync with underlying layer) with the underlying layer.
+ */
+public interface InitializingCustomizer<O extends DataObject> {
+
+    /**
+     * Transform Operational data into Config data.
+     *
+     * @param id InstanceIdentifier of operational data being initialized
+     * @param readValue Operational data being initialized(converted into config)
+     * @param ctx Standard read context to assist during initialization e.g. caching data between customizers
+     *
+     * @return Initialized, config data and its identifier
+     */
+    @Nonnull
+    Initialized<? extends DataObject> init(@Nonnull InstanceIdentifier<O> id,
+                                           @Nonnull O readValue,
+                                           @Nonnull ReadContext ctx);
+}
-- 
cgit 1.2.3-korg