From 5952721d74f9e1af59c3deb1018054aa4424c461 Mon Sep 17 00:00:00 2001 From: Marek Gradzki Date: Fri, 30 Jun 2017 21:53:23 +0200 Subject: HONEYCOMB-360 - Utility for conditional initialization of HC guice modules Change-Id: Ia1a3f44c7dae0b4b0be99f96abb017e1b022ec32 Signed-off-by: Marek Gradzki Signed-off-by: Jan Srnicek --- .../northbound/ConfigurationSupplier.java | 30 +++++++++++++ .../northbound/NorthboundAbstractModule.java | 50 ++++++++++++++++++++++ .../northbound/NorthboundPrivateModule.java | 50 ++++++++++++++++++++++ 3 files changed, 130 insertions(+) create mode 100644 infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/ConfigurationSupplier.java create mode 100644 infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundAbstractModule.java create mode 100644 infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundPrivateModule.java (limited to 'infra/northbound/common/src/main') diff --git a/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/ConfigurationSupplier.java b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/ConfigurationSupplier.java new file mode 100644 index 000000000..0002d431f --- /dev/null +++ b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/ConfigurationSupplier.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2017 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.northbound; + +import com.google.inject.Module; + +/** + * Supplies configuration class of type T and module used for its initialization. + * + * @param module configuration type + */ +public interface ConfigurationSupplier { + Module getConfigurationModule(); + + T getConfiguration(); +} diff --git a/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundAbstractModule.java b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundAbstractModule.java new file mode 100644 index 000000000..b3d31d731 --- /dev/null +++ b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundAbstractModule.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2017 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.northbound; + +import com.google.inject.AbstractModule; +import com.google.inject.Guice; +import com.google.inject.Injector; +import com.google.inject.Module; + +/** + * Base class for Honeycomb's AbstractModules, that are initialized conditionally based on specific configuration. + * + * @param module configuration type + */ +public abstract class NorthboundAbstractModule extends AbstractModule implements ConfigurationSupplier { + + private final Class configClass; + private final Module configurationModule; + private final Injector injector; + + protected NorthboundAbstractModule(final Module configurationModule, final Class configClass) { + this.configurationModule = configurationModule; + this.configClass = configClass; + this.injector = Guice.createInjector(configurationModule); + } + + @Override + public final Module getConfigurationModule() { + return configurationModule; + } + + @Override + public final T getConfiguration() { + return injector.getInstance(configClass); + } +} diff --git a/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundPrivateModule.java b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundPrivateModule.java new file mode 100644 index 000000000..da471a06a --- /dev/null +++ b/infra/northbound/common/src/main/java/io/fd/honeycomb/northbound/NorthboundPrivateModule.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2017 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.northbound; + +import com.google.inject.Guice; +import com.google.inject.Injector; +import com.google.inject.Module; +import com.google.inject.PrivateModule; + +/** + * Base class for Honeycomb's PrivateModules, that are initialized conditionally based on specific configuration. + * + * @param module configuration type + */ +public abstract class NorthboundPrivateModule extends PrivateModule implements ConfigurationSupplier { + + private final Class configClass; + private final Module configurationModule; + private final Injector injector; + + protected NorthboundPrivateModule(final Module configurationModule, final Class configClass) { + this.configurationModule = configurationModule; + this.configClass = configClass; + this.injector = Guice.createInjector(configurationModule); + } + + @Override + public final Module getConfigurationModule() { + return configurationModule; + } + + @Override + public final T getConfiguration() { + return injector.getInstance(configClass); + } +} -- cgit 1.2.3-korg