diff options
author | Maros Marsalek <mmarsale@cisco.com> | 2016-07-27 11:05:51 +0200 |
---|---|---|
committer | Maros Marsalek <mmarsale@cisco.com> | 2016-07-29 16:32:07 +0200 |
commit | 81c9cdfa5a9e91b91d73a6a2b20cff8b612d7de3 (patch) | |
tree | c941a2e5ea9df88acdfc64392b03228fdd18eb2b /v3po/vpp-cfg-init/src/main/java/io | |
parent | 10d33239e1e0d10a2f51e6739d18035e61600eb8 (diff) |
HONEYCOMB-130: Separate v3po plugin from HC infra
Creating folders:
- common/
- infra/
- v3po/
- vpp-common/
Change-Id: I2c39e1b17e39e7c0f0628f44aa5fe08563fa06e4
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'v3po/vpp-cfg-init/src/main/java/io')
5 files changed, 0 insertions, 362 deletions
diff --git a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/AbstractDataTreeConverter.java b/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/AbstractDataTreeConverter.java deleted file mode 100644 index f0058264e..000000000 --- a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/AbstractDataTreeConverter.java +++ /dev/null @@ -1,114 +0,0 @@ -/* - * 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.v3po.vpp.data.init; - -import static com.google.common.base.Preconditions.checkNotNull; - -import com.google.common.annotations.Beta; -import com.google.common.base.Optional; -import com.google.common.util.concurrent.CheckedFuture; -import org.opendaylight.controller.md.sal.binding.api.DataBroker; -import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction; -import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; -import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; -import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; -import org.opendaylight.yangtools.yang.binding.DataObject; -import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Base class for initializers which perform conversion between operational and config YANG model. - * - * @param <C> Config data object - * @param <O> Operational data object - */ -@Beta -public abstract class AbstractDataTreeConverter<O extends DataObject, C extends DataObject> - implements DataTreeInitializer { - private static final Logger LOG = LoggerFactory.getLogger(AbstractDataTreeConverter.class); - - private final InstanceIdentifier<O> idOper; - private final InstanceIdentifier<C> idConfig; - private final DataBroker bindingDataBroker; - - public AbstractDataTreeConverter(final DataBroker bindingDataBroker, - final InstanceIdentifier<O> operRootId, - final InstanceIdentifier<C> cfgRootId) { - this.bindingDataBroker = checkNotNull(bindingDataBroker, "bindingDataBroker should not be null"); - this.idOper = checkNotNull(operRootId, "operRootId should not be null"); - this.idConfig = checkNotNull(cfgRootId, "cfgRootId should not be null"); - } - - @Override - public void close() throws Exception { - LOG.debug("AbstractDataTreeConverter.close()"); - // Not removing initialized data, since this works in cooperation with persistence, it could remove - // data restored by persistence or remove user configured data when shutting down HC - } - - @Override - public final void initialize() throws InitializeException { - LOG.debug("AbstractDataTreeConverter.initialize() from(oper): {}, to(cfg): {}", idOper, idConfig); - final Optional<O> data = readData(); - - if (data.isPresent()) { - LOG.debug("Config initialization, operational data={}", data); - - final O operationalData = data.get(); - final C configData = convert(operationalData); - - try { - LOG.debug("Initializing config with data={}", configData); - writeData(configData); - LOG.info("Config initialization successful from(oper): {}, to(cfg): {}", idOper, idConfig); - } catch (TransactionCommitFailedException e) { - throw new InitializeException("Failed to perform config initialization", e); - } - } else { - LOG.info("Data is not present under: {}, no initial changes to config at: {}", idOper, idConfig); - } - } - - private Optional<O> readData() { - try (ReadOnlyTransaction readTx = bindingDataBroker.newReadOnlyTransaction()) { - final CheckedFuture<Optional<O>, org.opendaylight.controller.md.sal.common.api.data.ReadFailedException> - readFuture = readTx.read(LogicalDatastoreType.OPERATIONAL, idOper); - return readFuture.checkedGet(); - } catch (org.opendaylight.controller.md.sal.common.api.data.ReadFailedException e) { - LOG.warn("Failed to read operational state", e); - } - return Optional.absent(); - } - - private void writeData(final C configData) throws TransactionCommitFailedException { - final WriteTransaction writeTx = bindingDataBroker.newWriteOnlyTransaction(); - // Merge(instead of put) has to be used due to dynamic start, this might be executed multiple times - // and might overwrite config restored from persisted file with the same incomplete config. - // Making the entire configuration trigger VPP twice (on second persis ... and VPP does not like that - writeTx.merge(LogicalDatastoreType.CONFIGURATION, idConfig, configData); - writeTx.submit().checkedGet(); - } - - // TODO make this class concrete and use function dependency instead of abstract method - /** - * Converts operational data to config data for given root node - * @param operationalData data object representing operational data - * @return data object representing config data - */ - protected abstract C convert(final O operationalData); -} diff --git a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/DataTreeInitializer.java b/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/DataTreeInitializer.java deleted file mode 100644 index d760401f9..000000000 --- a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/DataTreeInitializer.java +++ /dev/null @@ -1,51 +0,0 @@ -/* - * 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.v3po.vpp.data.init; - -import com.google.common.annotations.Beta; - -/** - * Service for config data tree initialization. - * Implementation reads operational data and initializes config data tree. - * Initialization does not cause any change in VPP state, unlike ordinary writes to config. - */ -@Beta -public interface DataTreeInitializer extends AutoCloseable { - - /** - * Initializes config data tree for supported root node. - * @throws InitializeException if initialization failed - */ - void initialize() throws InitializeException; - - /** - * Removes all data managed by the initializer. - */ - @Override - void close() throws Exception; - - class InitializeException extends Exception { - - public InitializeException(final String message, final Throwable cause) { - super(message, cause); - } - - public InitializeException(final String msg) { - super(msg); - } - } -} diff --git a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistry.java b/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistry.java deleted file mode 100644 index 8760f0f09..000000000 --- a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistry.java +++ /dev/null @@ -1,33 +0,0 @@ -/* - * 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.v3po.vpp.data.init; - -import com.google.common.annotations.Beta; - -/** - * Data tree initializer suitable as a holder for all other root initializers, providing initializeAll feature. - */ -@Beta -public interface InitializerRegistry extends DataTreeInitializer { - - /** - * Performs initialize on all registered root initializers. - * @throws if initialization failed - */ - @Override - void initialize() throws InitializeException; -} diff --git a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistryImpl.java b/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistryImpl.java deleted file mode 100644 index e5220f7e8..000000000 --- a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/InitializerRegistryImpl.java +++ /dev/null @@ -1,52 +0,0 @@ -/* - * 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.v3po.vpp.data.init; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkNotNull; - -import java.util.List; -import javax.annotation.Nonnull; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -public class InitializerRegistryImpl implements InitializerRegistry { - private static final Logger LOG = LoggerFactory.getLogger(InitializerRegistryImpl.class); - private final List<DataTreeInitializer> initializers; - - public InitializerRegistryImpl(@Nonnull List<DataTreeInitializer> initializers) { - this.initializers = checkNotNull(initializers, "initializers should not be null"); - checkArgument(!initializers.contains(null), "initializers should not contain null elements"); - } - - @Override - public void close() throws Exception { - LOG.debug("InitializerRegistryImpl.close()"); - for (DataTreeInitializer initializer : initializers) { - initializer.close(); - } - } - - @Override - public void initialize() throws InitializeException { - // TODO check if readers are there - LOG.debug("InitializerRegistryImpl.initialize()"); - for (DataTreeInitializer initializer : initializers) { - initializer.initialize(); - } - } -} diff --git a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/RestoringInitializer.java b/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/RestoringInitializer.java deleted file mode 100644 index abc3f54c0..000000000 --- a/v3po/vpp-cfg-init/src/main/java/io/fd/honeycomb/v3po/vpp/data/init/RestoringInitializer.java +++ /dev/null @@ -1,112 +0,0 @@ -/* - * 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.v3po.vpp.data.init; - -import static com.google.common.base.Preconditions.checkArgument; - -import io.fd.honeycomb.v3po.translate.util.JsonUtils; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.StandardOpenOption; -import javax.annotation.Nonnull; -import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; -import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; -import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker; -import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; -import org.opendaylight.controller.sal.core.api.model.SchemaService; -import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.vpp.data.init.rev160407.RestorationType; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; -import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -public class RestoringInitializer implements DataTreeInitializer { - - private static final Logger LOG = LoggerFactory.getLogger(RestoringInitializer.class); - - private final SchemaService schemaService; - private final Path path; - private final DOMDataBroker dataTree; - private final RestorationType restorationType; - private final LogicalDatastoreType datastoreType; - - public RestoringInitializer(@Nonnull final SchemaService schemaService, - @Nonnull final Path path, - @Nonnull final DOMDataBroker dataTree, - @Nonnull final RestorationType restorationType, - @Nonnull final LogicalDatastoreType datastoreType) { - this.schemaService = schemaService; - this.datastoreType = datastoreType; - this.path = checkStorage(path); - this.dataTree = dataTree; - this.restorationType = restorationType; - } - - private Path checkStorage(final Path path) { - if (Files.exists(path)) { - checkArgument(!Files.isDirectory(path), "File %s is a directory", path); - checkArgument(Files.isReadable(path), "File %s is not readable", path); - } - - return path; - } - - @Override - public void initialize() throws InitializeException { - LOG.debug("Starting restoration of {} from {} using {}", dataTree, path, restorationType); - if(!Files.exists(path)) { - LOG.debug("Persist file {} does not exist. Skipping restoration", path); - return; - } - - try { - final ContainerNode containerNode = JsonUtils - .readJsonRoot(schemaService.getGlobalContext(), Files.newInputStream(path, StandardOpenOption.READ)); - - final DOMDataWriteTransaction domDataWriteTransaction = dataTree.newWriteOnlyTransaction(); - for (DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild : containerNode - .getValue()) { - final YangInstanceIdentifier iid = YangInstanceIdentifier.create(dataContainerChild.getIdentifier()); - LOG.trace("Restoring {} from {}", iid, path); - - switch (restorationType) { - case Merge: - domDataWriteTransaction.merge(datastoreType, iid, dataContainerChild); - break; - case Put: - domDataWriteTransaction.put(datastoreType, iid, dataContainerChild); - break; - default: - throw new InitializeException( - "Unable to initialize data using " + restorationType + " restoration strategy. Unsupported"); - } - } - - // Block here to prevent subsequent initializers processing before context is fully restored - domDataWriteTransaction.submit().checkedGet(); - LOG.debug("Data from {} restored successfully", path); - - } catch (IOException | TransactionCommitFailedException e) { - throw new InitializeException("Unable to restore data from " + path, e); - } - } - - @Override - public void close() {} -} |