gerrit.onap Code Review - dcaegen2/analytics/tca.git/blob

   1 /*\r
   2  * ===============================LICENSE_START======================================\r
   3  *  dcae-analytics\r
   4  * ================================================================================\r
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   8  *  you may not use this file except in compliance with the License.\r
   9  *   You may obtain a copy of the License at\r
  10  *\r
  11  *          http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  *  Unless required by applicable law or agreed to in writing, software\r
  14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  *  See the License for the specific language governing permissions and\r
  17  *  limitations under the License.\r
  18  *  ============================LICENSE_END===========================================\r
  19  */\r
  20 \r
  21 package org.openecomp.dcae.apod.analytics.cdap.common.settings;\r
  22 \r
  23 import co.cask.cdap.api.annotation.Description;\r
  24 import co.cask.cdap.api.annotation.Macro;\r
  25 import co.cask.cdap.api.annotation.Name;\r
  26 import co.cask.cdap.api.plugin.PluginConfig;\r
  27 import org.openecomp.dcae.apod.analytics.cdap.common.CDAPPluginConstants;\r
  28 \r
  29 /**\r
  30  * <p>\r
  31  *      Base class for all DCAE Analytics CDAP Plugin config\r
  32  * </p>\r
  33  * <p>\r
  34  * @author Rajiv Singla . Creation Date: 1/17/2017.\r
  35  */\r
  36 public abstract class CDAPBasePluginConfig extends PluginConfig implements CDAPPluginSettings {\r
  37 \r
  38     @Name(CDAPPluginConstants.Reference.REFERENCE_NAME)\r
  39     @Description(CDAPPluginConstants.Reference.REFERENCE_NAME_DESCRIPTION)\r
  40     @Macro\r
  41     protected String referenceName;\r
  42 \r
  43     /**\r
  44      * Provides Reference Name that can be used to trace lineage or meta data information inside CDAP container\r
  45      *\r
  46      * @return reference name\r
  47      */\r
  48     public String getReferenceName() {\r
  49         return referenceName;\r
  50     }\r
  51 \r
  52 \r
  53 }\r