aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/main/java/org/onap/cli/fw/conf/OnapCommandConstants.java
blob: 408f4f694ddb5b3075c0424953fb286b6f6bbc24 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright 2017 Huawei Technologies Co., Ltd.
 *
 * 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 org.onap.cli.fw.conf;

/**
 * OnapCommandHttpConstants.
 *
 */
public class OnapCommandConstants {

    //config
    public static final String CONF = "open-cli.properties";
    public static final String OPEN_CLI_VERSION = "cli.version";
    public static final String TOP_LEVEL_PARAMS_LIST = "cli.schema.base.sections";
    public static final String TOP_LEVEL_MANDATORY_LIST = "cli.schema.base.sections.mandatory";
    public static final String SERVICE_PARAMS_LIST = "cli.schema.http.service.sections";
    public static final String SERVICE_PARAMS_MANDATORY_LIST = "cli.schema.http.service.sections.mandatory";
    public static final String INFO_PARAMS_LIST = "cli.schema.base.info.sections";
    public static final String INFO_PARAMS_MANDATORY_LIST = "cli.schema.base.info.sections.mandatory";
    public static final String INPUT_PARAMS_LIST = "cli.schema.base.parameters.sections";
    public static final String INPUT_PARAMS_MANDATORY_LIST = "cli.schema.base.parameters.sections.mandatory";
    public static final String RESULT_PARAMS_LIST = "cli.schema.base.results.sections";
    public static final String RESULT_PARAMS_MANDATORY_LIST = "cli.schema.base.results.sections.mandatory";
    public static final String BOOLEAN_VALUE = "cli.schema.boolean_values";

    public static final String COMMAND_TYPE_VALUES = "cli.schema.command.type";
    public static final String SCHEMA_TYPES_SUPPORTED = "cli.schema.profile.available";
    public static final String OPEN_CLI_PRODUCT_NAME = "cli.product_name";
    public static final String OPEN_CLI_PLUGIN_PRPS = "cli.schema.profile.confs";

    //schema
    public static final String OPEN_CLI_SCHEMA_VERSION = "open_cli_schema_version";
    public static final String OPEN_CLI_SCHEMA_VERSION_VALUE_1_0 = "1.0";
    public static final String NAME = "name";
    public static final String DESCRIPTION = "description";

    //Info
    public static final String INFO = "info";
    public static final String INFO_PRODUCT = "product";
    public static final String OPEN_CLI_PRODUCT_IN_USE_ENV_NAME = "OPEN_CLI_PRODUCT_IN_USE";

    public static final String INFO_SERVICE = "service";
    public static final String INFO_TYPE = "type";
    public static final String INFO_AUTHOR = "author";
    public static final String INFO_IGNORE = "ignore";

    //parameters
    public static final String PARAMETERS = "parameters";
    public static final String SHORT_OPTION = "short_option";
    public static final String LONG_OPTION = "long_option";
    public static final String TYPE = "type";
    public static final String IS_OPTIONAL = "is_optional";
    public static final String DEFAULT_VALUE = "default_value";
    public static final String IS_SECURED = "is_secured";
    public static final String IS_INCLUDE = "is_include";
    public static final String IS_DEFAULT_PARAM = "is_default_param";

    public static final String PARAMETER_TYPE_JSON = "json";
    public static final String PARAMETER_TYPE_YAML = "yaml";
    public static final String PARAMETER_TYPE_STRING = "string";
    public static final String PARAMETER_TYPE_LONG = "long";
    public static final String PARAMETER_TYPE_URL = "url";
    public static final String PARAMETER_TYPE_BOOL = "bool";
    public static final String PARAMETER_TYPE_ARRAY = "array";
    public static final String PARAMETER_TYPE_BINARY = "binary";
    public static final String PARAMETER_TYPE_MAP = "map";

    public static final String DEFAULT_PARAMETER_FILE_NAME = "default_input_parameters.yaml";
    public static final String DEFAULT_PARAMETER_HELP = "help";
    public static final String DEFAULT_PARAMETER_VERSION = "version";
    public static final String DEFAULT_PARAMETER_DEBUG = "debug";
    public static final String DEFAULT_PARAMETER_OUTPUT_FORMAT = "format";
    public static final String DEFAULT_PARAMETER_OUTPUT_ATTR_LONG = "long";

    public static final String DEFAULT_PARAMETER_OUTPUT_NO_TITLE = "no-title";

    //results
    public static final String RESULTS = "results";

    public static final String DIRECTION = "direction";
    public static final String DIRECTION_PORTRAIT = "portrait";
    public static final String DIRECTION_LANDSCAPE = "landscape";

    public static final String ATTRIBUTES = "attributes";

    public static final String SCOPE = "scope";
    public static final String RESULT_SCOPE_SHORT = "short";
    public static final String RESULT_SCOPE_LONG = "long";
    public static final String IS_DEFAULT_ATTR = "is_default_attr";

    //print
    public static final String PORTRAINT_COLUMN_NAME_PROPERTY = "property";
    public static final String PORTRAINT_COLUMN_NAME_VALUE = "value";

    //discovery
    public static final String SCHEMA_DIRECTORY = "open-cli-schema";
    public static final String YAML_PATTERN = "/**/*.yaml";
    public static final String JSON_PATTERN = "/**/*.json";
    public static final String SCHEMA_PATH_PATERN = SCHEMA_DIRECTORY + YAML_PATTERN;
    public static final String DATA_DIRECTORY = "data";
    public static final String DISCOVERY_FILE = "cli-schema.json";
    public static final String DATA_PATH_JSON_PATTERN = DATA_DIRECTORY + JSON_PATTERN;
    public static final String DISCOVER_ALWAYS = "discover_always";
    public static final String PARAM_CACHE_FILE_NAME = "global-profile";

    //normal
    public static final String BASIC_SCHEMA_PROFILE = "basic";
    public static final String EXCEPTION = "exception";
    public static final String BOOLEAN_TRUE = "true";
    public static final String BOOLEAN_FALSE = "false";

    // Error message
    public static final String ERROR= "error";
    public static final String ERROR_CODE= "code";
    public static final String ERROR_MESSAGE= "message";

    public static final String SCHEMA_INVALID_DEFAULT_PARAMS_SECTION = "Invalid default_parameter section";
    public static final String SCHEMA_FILE_EMPTY = "The schema file cann't be null or empty";
    public static final String SCHEMA_FILE_WRONG_EXTN = "Schema file should be '.yaml' extension";
    public static final String SCHEMA_FILE_NOT_EXIST = "Schema file doesn't exist";
    public static final String USE_DIRECTIVE = "use";


    public static final String SPL_ENTRY_UUID = "uuid";
    public static final String SPL_ENTRY_ENV = "env:";

    public static final String VERSION_INFO = "version.info";
    public static final String VERSION_INFO_PLACE_HOLDER_VERSION = "__VERSION__";
    public static final String VERSION_INFO_PLACE_HOLDER_AVL_PRD_VER = "__AVAILABLE_PRODUCT_VERSIONS__";
    public static final String VERSION_INFO_PLACE_HOLDER_ENB_PRD_VER = "__ENABLED_PRODUCT_VERSIONS__";

    public static final String SAMPLE_GEN_ENABLED = "cli.sample.gen.enable";
    public static final String SAMPLE_GEN_TARGET_FOLDER = "cli.sample.gen.target";

    private OnapCommandConstants() {
    }

}