framework/src/main/java/org/onap/cli/fw/conf/Constants.java

   1 /*
   2  * Copyright 2017 Huawei Technologies Co., Ltd.
   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 org.onap.cli.fw.conf;
  18
  19 /**
  20  * Constants.
  21  *
  22  */
  23 public class Constants {
  24
  25     public static final String SSLCONTEST_TLS = "TLSV1.2";
  26     public static final String APPLICATION_JSON = "application/json";
  27     public static final String X_AUTH_TOKEN = "X-Auth-Token";
  28
  29     public static final String AUTH_SERVICE = "cli.auth_service";
  30     public static final String AUTH_SERVICE_VERSION = "v1";
  31     public static final String TOKEN = "{\"userName\": \"%s\",\"password\": \"%s\"}";
  32     public static final String MSB_URI = "/api/microservices/v1";
  33     public static final String MSB_SERVICE_URI = MSB_URI + "/services/%s/version/%s";
  34
  35     public static final String API_GATEWAY = "cli.api_gateway";
  36     public static final String SERVICE_NAME = "cli.service_name";
  37
  38     //http
  39     public static final String URI = "uri";
  40     public static final String BODY = "body";
  41     public static final String MERHOD = "method";
  42     public static final String HEADERS = "headers";
  43     public static final String QUERIES = "queries";
  44     public static final String COOKIES = "cookies";
  45
  46     public static final String HTTP = "http";
  47     public static final String REQUEST = "request";
  48     public static final String SAMPLE_RESPONSE = "sample_response";
  49     public static final String SUCCESS_CODES = "success_codes";
  50     public static final String RESULT_MAP = "result_map";
  51
  52     //swagger
  53     public static final String EXECUTOR = "exec";
  54
  55     public static final String API = "api";
  56     public static final String CLIENT = "client";
  57     public static final String ENTITY = "entity";
  58     public static final String METHOD = "method";
  59     public static final String EXCEPTION = "exception";
  60
  61     public static final String SCOPE = "scope";
  62
  63     public static final String ONAP_CMD_SCHEMA_VERSION_VALUE = "1.0";
  64     public static final String DESCRIPTION = "description";
  65     public static final String SERVICE = "service";
  66     public static final String PARAMETERS = "parameters";
  67     public static final String DEFAULT_PARAMETERS = "default_parameters";
  68     public static final String DEFAULT_PARAMETERS_INCLUDE = "include";
  69     public static final String DEFAULT_PARAMETERS_EXCLUDE = "exclude";
  70
  71     public static final String RESULTS = "results";
  72
  73     public static final String ONAP_CMD_SCHEMA_VERSION = "onap_cmd_schema_version";
  74     public static final String NAME = "name";
  75     public static final String VERSION = "version";
  76     public static final String BASE_PATH = "base_path";
  77     public static final String AUTH = "auth";
  78     public static final String AUTH_NONE = "none";
  79     public static final String AUTH_BASIC = "basic";
  80     public static final String MODE = "mode";
  81     public static final String MODE_DIRECT = "direct";
  82     public static final String MODE_CATALOG = "catalog";
  83
  84     public static final String SHORT_OPTION = "short_option";
  85     public static final String LONG_OPTION = "long_option";
  86     public static final String TYPE = "type";
  87     public static final String IS_OPTIONAL = "is_optional";
  88     public static final String DEFAULT_VALUE = "default_value";
  89     public static final String IS_SECURED = "is_secured";
  90
  91     public static final String DIRECTION = "direction";
  92     public static final String ATTRIBUTES = "attributes";
  93
  94     public static final String DEFAULT_PARAMETER_FILE_NAME = "default_input_parameters.yaml";
  95
  96     // Common parameters used across all commands.
  97     public static final String DEAFULT_PARAMETER_USERNAME = "onap-username";
  98     public static final String DEAFULT_PARAMETER_PASS_WORD = "onap-password";
  99     public static final String DEAFULT_PARAMETER_HOST_URL = "host-url";
 100     public static final String DEFAULT_PARAMETER_HELP = "help";
 101     public static final String DEFAULT_PARAMETER_VERSION = "version";
 102     public static final String DEFAULT_PARAMETER_DEBUG = "debug";
 103     public static final String DEFAULT_PARAMETER_OUTPUT_FORMAT = "format";
 104     public static final String DEFAULT_PARAMETER_OUTPUT_ATTR_LONG = "long";
 105     public static final String DEFAULT_PARAMETER_OUTPUT_NO_TITLE = "no-title";
 106     public static final String DEFAULT_PARAMETER_OUTPUT_NO_AUTH = "no-auth";
 107
 108     // Configuration properties
 109     public static final String CONF = "onap.properties";
 110     public static final String ONAP_IGNORE_AUTH = "cli.ignore_auth";
 111     public static final String ONAP_CLI_VERSION = "cli.version";
 112     public static final String HTTP_API_KEY_USE_COOKIES = "http.api_key_use_cookies";
 113     public static final String HTTP_X_AUTH_TOKEN = "http.x_auth_token";
 114     public static final String EXCLUDE_PARAMS_INTERNAL_CMD = "cli.exclude_params_internal_cmd";
 115     public static final String NO_AUTH_DISABLE_INCLUDE_PARAMS_EXTERNAL_CMD = "cli.no_auth_disable_include_params_external_cmd";
 116     public static final String NO_AUTH_ENABLE_EXCLUDE_PARAMS_EXTERNAL_CMD = "cli.no_auth_enable_exclude_params_external_cmd";
 117     public static final String NO_AUTH_ENABLE_INCLUDE_PARAMS_EXTERNAL_CMD = "cli.no_auth_enable_include_params_external_cmd";
 118
 119     // Used while printing the column name during PORTRAIT mode print
 120     public static final String PORTRAINT_COLUMN_NAME_PROPERTY = "property";
 121     public static final String PORTRAINT_COLUMN_NAME_VALUE = "value";
 122
 123     public static final String EXTERNAL_SCHEMA_DIRECTORY = "onap-cli-schema";
 124     public static final String EXTERNAL_YAML_PATTERN = "/**/*.yaml";
 125     public static final String EXTERNAL_JSON_PATTERN = "/**/*.json";
 126     public static final String EXTERNAL_SCHEMA_PATH_PATERN = EXTERNAL_SCHEMA_DIRECTORY + EXTERNAL_YAML_PATTERN;
 127     public static final String EXTERNAL_DISCOVERY_DIRECTORY = "data";
 128     public static final String EXTERNAL_DISCOVERY_FILE = "external-schema.json";
 129     public static final String EXTERNAL_DISCOVERY_DIRECTORY_PATTERN = EXTERNAL_DISCOVERY_DIRECTORY
 130             + EXTERNAL_JSON_PATTERN;
 131
 132     public static final String PARAMETER_TYPE_JSON = "json";
 133     public static final String PARAMETER_TYPE_YAML = "yaml";
 134     public static final String PARAMETER_TYPE_STRING = "string";
 135     public static final String PARAMETER_TYPE_LONG = "long";
 136     public static final String PARAMETER_TYPE_URL = "url";
 137     public static final String PARAMETER_TYPE_BOOL = "bool";
 138     public static final String PARAMETER_TYPE_ARRAY = "array";
 139     public static final String PARAMETER_TYPE_BINARY = "binary";
 140     public static final String PARAMETER_TYPE_MAP = "map";
 141
 142     public static final String BOOLEAN_TRUE = "true";
 143     public static final String BOOLEAN_FALSE = "false";
 144
 145     public static final String DIRECTION_PORTRAIT = "portrait";
 146     public static final String DIRECTION_LANDSCAPE = "landscape";
 147
 148     public static final String RESULT_SCOPE_SHORT = "short";
 149     public static final String RESULT_SCOPE_LONG = "long";
 150
 151     public static final String POST = "post";
 152     public static final String GET = "get";
 153     public static final String DELETE = "delete";
 154     public static final String PUT = "put";
 155     public static final String HEAD = "delete";
 156
 157     public static final String DEFAULT_SCHEMA_FILE_NAME = "default_input_parameters.yaml";
 158
 159     // Error message
 160     public static final String SCHEMA_INVALID_DEFAULT_PARAMS_SECTION = "Invalid default_parameter section";
 161     public static final String SCHEMA_FILE_EMPTY = "The schema file cann't be null or empty";
 162     public static final String SCHEMA_FILE_WRONG_EXTN = "Schema file should be '.yaml' extension";
 163     public static final String SCHEMA_FILE_NOT_EXIST = "Schema file doesn't exist";
 164     public static final String HTTP_SECTION_EMPTY = "Http Section cann't be null or empty";
 165     public static final String HTTP_BODY_SECTION_EMPTY = "http body section under 'request:' cann't be null or empty";
 166     public static final String HTTP_BODY_FAILED_PARSING = "The http body json is failed to parse";
 167     public static final String HTTP_BODY_JSON_EMPTY = "The http body json cann't be null or empty";
 168     public static final String HTTP_SUCCESS_CODE_INVALID = "Invalid http success code.";
 169     public static final String HTTP_SAMPLE_RESPONSE_EMPTY = "Sample response cann't be null or empty";
 170     public static final String HTTP_SAMPLE_RESPONSE_FAILED_PARSING = "The http Sample response json is failed to parse.";
 171
 172     private Constants() {
 173     }
 174
 175 }
 176