vnfs/honeycomb_plugin/sample_plugin/sample-plugin-impl/src/main/java/io/fd/honeycomb/tutorial/ModuleConfiguration.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.tutorial;
  18
  19 import net.jmob.guice.conf.core.BindConfig;
  20 import net.jmob.guice.conf.core.InjectConfig;
  21 import net.jmob.guice.conf.core.Syntax;
  22
  23 /**
  24  * Class containing static configuration for sample-plugin module,<br>
  25  * either loaded from property file sample-plugin.json from classpath.
  26  * <p/>
  27  * Further documentation for the configuration injection can be found at:
  28  * https://github.com/yyvess/gconf
  29  */
  30 @BindConfig(value = "sample-plugin", syntax = Syntax.JSON)
  31 public final class ModuleConfiguration {
  32
  33     // TODO change the sample property to real plugin configuration
  34     // If there is no such configuration, remove this, sample-plugin.json resource and its wiring from Module class
  35
  36     /**
  37      * Sample property that's injected from external json configuration file.
  38      */
  39     @InjectConfig("sample-prop")
  40     public String sampleProp;
  41
  42     /**
  43      * Constant name used to identify sample-plugin plugin specific components during dependency injection.
  44      */
  45     public static final String ELEMENT_SERVICE_NAME = "element-service";
  46 }