dcae-analytics-cdap-common/src/main/java/org/onap/dcae/apod/analytics/cdap/common/settings/CDAPBasePluginConfig.java

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