aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-cdap-common/src/main/java/org/openecomp/dcae/apod/analytics/cdap/common/settings/CDAPBasePluginConfig.java
blob: a293175c31a2d4f59d3c46fc138bd007ed2999df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 *  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.
 *  ============================LICENSE_END===========================================
 */

package org.openecomp.dcae.apod.analytics.cdap.common.settings;

import co.cask.cdap.api.annotation.Description;
import co.cask.cdap.api.annotation.Macro;
import co.cask.cdap.api.annotation.Name;
import co.cask.cdap.api.plugin.PluginConfig;
import org.openecomp.dcae.apod.analytics.cdap.common.CDAPPluginConstants;

/**
 * <p>
 *      Base class for all DCAE Analytics CDAP Plugin config
 * </p>
 * <p>
 * @author Rajiv Singla . Creation Date: 1/17/2017.
 */
public abstract class CDAPBasePluginConfig extends PluginConfig implements CDAPPluginSettings {

    @Name(CDAPPluginConstants.Reference.REFERENCE_NAME)
    @Description(CDAPPluginConstants.Reference.REFERENCE_NAME_DESCRIPTION)
    @Macro
    protected String referenceName;

    /**
     * Provides Reference Name that can be used to trace lineage or meta data information inside CDAP container
     *
     * @return reference name
     */
    public String getReferenceName() {
        return referenceName;
    }


}