From 0ce0fa21ea0ae4f6e2b56546a8275901f9cf8196 Mon Sep 17 00:00:00 2001 From: Marek Gradzki Date: Fri, 5 Aug 2016 14:49:14 +0200 Subject: HONEYCOMB-117: add support for jvpp plugins Change-Id: I9f1dd5562b13a37392ce92b170a466c48d61bcc5 Signed-off-by: Marek Gradzki --- vpp-common/minimal-distribution/pom.xml | 7 ++- .../honeycomb/vpp/distro/JVppCoreProvider.groovy | 54 ++++++++++++++++++++ .../io/fd/honeycomb/vpp/distro/JVppProvider.groovy | 58 ---------------------- .../vpp/distro/JVppRegistryProvider.groovy | 55 ++++++++++++++++++++ .../fd/honeycomb/vpp/distro/VppCommonModule.groovy | 6 ++- vpp-common/vpp-translate-utils/pom.xml | 7 ++- .../v3po/util/AbstractInterfaceTypeCustomizer.java | 6 +-- .../translate/v3po/util/FutureJVppCustomizer.java | 12 ++--- .../v3po/util/cache/DumpCacheManagerTest.java | 4 +- 9 files changed, 136 insertions(+), 73 deletions(-) create mode 100644 vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppCoreProvider.groovy delete mode 100644 vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppProvider.groovy create mode 100644 vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppRegistryProvider.groovy (limited to 'vpp-common') diff --git a/vpp-common/minimal-distribution/pom.xml b/vpp-common/minimal-distribution/pom.xml index 4efe12b54..e80f0eb7e 100644 --- a/vpp-common/minimal-distribution/pom.xml +++ b/vpp-common/minimal-distribution/pom.xml @@ -90,7 +90,12 @@ io.fd.vpp - jvpp + jvpp-registry + 16.09-SNAPSHOT + + + io.fd.vpp + jvpp-core 16.09-SNAPSHOT diff --git a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppCoreProvider.groovy b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppCoreProvider.groovy new file mode 100644 index 000000000..1d4fd1af5 --- /dev/null +++ b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppCoreProvider.groovy @@ -0,0 +1,54 @@ +/* + * 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.vpp.distro + +import com.google.inject.Inject +import groovy.transform.ToString +import groovy.util.logging.Slf4j +import io.fd.honeycomb.infra.distro.ProviderTrait +import org.openvpp.jvpp.JVppRegistry +import org.openvpp.jvpp.core.JVppCoreImpl +import org.openvpp.jvpp.core.future.FutureJVppCore +import org.openvpp.jvpp.core.future.FutureJVppCoreFacade + +/** + * Provides future API for jvpp-core plugin. Must be a singleton due to shutdown hook usage. + * Registers shutdown hook to free plugin's resources on shutdown. + */ +@Slf4j +@ToString +class JVppCoreProvider extends ProviderTrait { + + @Inject + JVppRegistry registry + + def create() { + try { + def jVpp = new JVppCoreImpl() + // Free jvpp-core plugin's resources on shutdown + Runtime.addShutdownHook { + log.info("Unloading jvpp-core plugin") + jVpp.close() + log.info("Successfully unloaded jvpp-core plugin") + } + log.info("Successfully loaded jvpp-core plugin") + new FutureJVppCoreFacade(registry, jVpp) + } catch (IOException e) { + throw new IllegalStateException("Unable to open VPP management connection", e) + } + } +} diff --git a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppProvider.groovy b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppProvider.groovy deleted file mode 100644 index 51bf5be9e..000000000 --- a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppProvider.groovy +++ /dev/null @@ -1,58 +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.vpp.distro - -import com.google.inject.Inject -import groovy.transform.ToString -import groovy.util.logging.Slf4j -import io.fd.honeycomb.infra.distro.ProviderTrait -import org.openvpp.jvpp.JVppImpl -import org.openvpp.jvpp.VppJNIConnection -import org.openvpp.jvpp.future.FutureJVpp -import org.openvpp.jvpp.future.FutureJVppFacade - -/** - * This must be a singleton due to shutdown hook usage. - */ -@Slf4j -@ToString -class JVppProvider extends ProviderTrait { - - @Inject - VppConfigAttributes config - - def create() { - try { - def connection = new VppJNIConnection(config.jvppConnectionName) - def jVpp = new JVppImpl(connection) - - // Closing JVpp connection with shutdown hook to erase the connection from VPP so HC will be able - // to connect next time. If JVM is force closed, this will not be executed and VPP connection - // with name from config will stay open and prevent next startup of HC to success - Runtime.addShutdownHook { - log.info("Disconnecting from VPP") - jVpp.close() - connection.close() - log.info("Successfully disconnected from VPP as {}", config.jvppConnectionName) - } - log.info("JVpp connection opened successfully as: {}", config.jvppConnectionName) - new FutureJVppFacade(jVpp) - } catch (IOException e) { - throw new IllegalStateException("Unable to open VPP management connection", e) - } - } -} diff --git a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppRegistryProvider.groovy b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppRegistryProvider.groovy new file mode 100644 index 000000000..125f7660b --- /dev/null +++ b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/JVppRegistryProvider.groovy @@ -0,0 +1,55 @@ +/* + * 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.vpp.distro + +import com.google.inject.Inject +import groovy.transform.ToString +import groovy.util.logging.Slf4j +import io.fd.honeycomb.infra.distro.ProviderTrait +import org.openvpp.jvpp.JVppRegistry +import org.openvpp.jvpp.JVppRegistryImpl + +/** + * Provides JVppRegistry. Must be a singleton due to shutdown hook usage. + * Registers shutdown hook to disconnect from VPP. + */ +@Slf4j +@ToString +class JVppRegistryProvider extends ProviderTrait { + + @Inject + VppConfigAttributes config + + def create() { + try { + def registry = new JVppRegistryImpl(config.jvppConnectionName); + + // Closing JVpp connection with shutdown hook to erase the connection from VPP so HC will be able + // to connect next time. If JVM is force closed, this will not be executed and VPP connection + // with name from config will stay open and prevent next startup of HC to success + Runtime.addShutdownHook { + log.info("Disconnecting from VPP") + registry.close() + log.info("Successfully disconnected from VPP as {}", config.jvppConnectionName) + } + log.info("JVpp connection opened successfully as: {}", config.jvppConnectionName) + registry + } catch (IOException e) { + throw new IllegalStateException("Unable to open VPP management connection", e) + } + } +} diff --git a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/VppCommonModule.groovy b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/VppCommonModule.groovy index 68261c34d..cd5816f11 100644 --- a/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/VppCommonModule.groovy +++ b/vpp-common/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/distro/VppCommonModule.groovy @@ -22,7 +22,8 @@ import com.google.inject.multibindings.Multibinder import groovy.util.logging.Slf4j import io.fd.honeycomb.translate.read.ReaderFactory import net.jmob.guice.conf.core.ConfigurationModule -import org.openvpp.jvpp.future.FutureJVpp +import org.openvpp.jvpp.JVppRegistry +import org.openvpp.jvpp.core.future.FutureJVppCore @Slf4j public final class VppCommonModule extends AbstractModule { @@ -32,7 +33,8 @@ public final class VppCommonModule extends AbstractModule { // Inject non-dependency configuration requestInjection(VppConfigAttributes) - bind(FutureJVpp).toProvider(JVppProvider).in(Singleton) + bind(JVppRegistry).toProvider(JVppRegistryProvider).in(Singleton) + bind(FutureJVppCore).toProvider(JVppCoreProvider).in(Singleton) // Naming contexts reader exposing context storage over REST/HONEYCOMB_NETCONF Multibinder.newSetBinder(binder(), ReaderFactory.class).with { diff --git a/vpp-common/vpp-translate-utils/pom.xml b/vpp-common/vpp-translate-utils/pom.xml index 613fc0bff..32466c2e1 100644 --- a/vpp-common/vpp-translate-utils/pom.xml +++ b/vpp-common/vpp-translate-utils/pom.xml @@ -53,7 +53,12 @@ io.fd.vpp - jvpp + jvpp-registry + 16.09-SNAPSHOT + + + io.fd.vpp + jvpp-core 16.09-SNAPSHOT diff --git a/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/AbstractInterfaceTypeCustomizer.java b/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/AbstractInterfaceTypeCustomizer.java index 7f3422fb8..cf6f29370 100644 --- a/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/AbstractInterfaceTypeCustomizer.java +++ b/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/AbstractInterfaceTypeCustomizer.java @@ -28,7 +28,7 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces. import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.openvpp.jvpp.future.FutureJVpp; +import org.openvpp.jvpp.core.future.FutureJVppCore; /** * Validation WriteCustomizers for Interface subnodes. @@ -40,8 +40,8 @@ import org.openvpp.jvpp.future.FutureJVpp; public abstract class AbstractInterfaceTypeCustomizer extends FutureJVppCustomizer implements WriterCustomizer { - protected AbstractInterfaceTypeCustomizer(final FutureJVpp futureJvpp) { - super(futureJvpp); + protected AbstractInterfaceTypeCustomizer(final FutureJVppCore futureJVppCore) { + super(futureJVppCore); } private void checkProperInterfaceType(@Nonnull final WriteContext writeContext, diff --git a/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/FutureJVppCustomizer.java b/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/FutureJVppCustomizer.java index 45453259f..d0379e7d2 100644 --- a/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/FutureJVppCustomizer.java +++ b/vpp-common/vpp-translate-utils/src/main/java/io/fd/honeycomb/translate/v3po/util/FutureJVppCustomizer.java @@ -18,7 +18,7 @@ package io.fd.honeycomb.translate.v3po.util; import com.google.common.annotations.Beta; import com.google.common.base.Preconditions; -import org.openvpp.jvpp.future.FutureJVpp; +import org.openvpp.jvpp.core.future.FutureJVppCore; import javax.annotation.Nonnull; @@ -28,10 +28,10 @@ import javax.annotation.Nonnull; @Beta public abstract class FutureJVppCustomizer { - private final FutureJVpp futureJvpp; + private final FutureJVppCore futureJVppCore; - public FutureJVppCustomizer(@Nonnull final FutureJVpp futureJvpp) { - this.futureJvpp = Preconditions.checkNotNull(futureJvpp, "futureJvpp should not be null"); + public FutureJVppCustomizer(@Nonnull final FutureJVppCore futureJVppCore) { + this.futureJVppCore = Preconditions.checkNotNull(futureJVppCore, "futureJVppCore should not be null"); } /** @@ -39,7 +39,7 @@ public abstract class FutureJVppCustomizer { * * @return vppApi reference */ - public FutureJVpp getFutureJVpp() { - return futureJvpp; + public FutureJVppCore getFutureJVpp() { + return futureJVppCore; } } diff --git a/vpp-common/vpp-translate-utils/src/test/java/io/fd/honeycomb/translate/v3po/util/cache/DumpCacheManagerTest.java b/vpp-common/vpp-translate-utils/src/test/java/io/fd/honeycomb/translate/v3po/util/cache/DumpCacheManagerTest.java index 9eaa024e3..21b3646c4 100644 --- a/vpp-common/vpp-translate-utils/src/test/java/io/fd/honeycomb/translate/v3po/util/cache/DumpCacheManagerTest.java +++ b/vpp-common/vpp-translate-utils/src/test/java/io/fd/honeycomb/translate/v3po/util/cache/DumpCacheManagerTest.java @@ -27,8 +27,8 @@ import org.junit.Before; import org.junit.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import org.openvpp.jvpp.dto.IpDetails; -import org.openvpp.jvpp.dto.IpDetailsReplyDump; +import org.openvpp.jvpp.core.dto.IpDetails; +import org.openvpp.jvpp.core.dto.IpDetailsReplyDump; public class DumpCacheManagerTest { -- cgit 1.2.3-korg