appc-core/appc-common-bundle/java/org/onap/appc/Constants.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24
  25
  26 package org.onap.appc;
  27
  28 /**
  29  * This class contains the definitions of all constant values used in the APPC provider, adapters, and other components.
  30  * These constants define properties, settings, and context variables. The context variables can be referenced from
  31  * within the directed graph(s) to access information placed their by the provider and adapters.
  32  * <p>
  33  * Context properties are set in the graph context by the various adapters and the provider, or by the graph itself.
  34  * These properties may also be accessed by the graph, adapters, or the provider. It is these properties that allow
  35  * communication of state through the directed graph. All context properties have a symbolic name that starts with
  36  * "CONTEXT_".
  37  * </p>
  38  *
  39  */
  40
  41 public final class Constants {
  42
  43     /**
  44      * The name for the error code attribute to be set in the context
  45      */
  46     @SuppressWarnings("nls")
  47     public static final String ATTRIBUTE_ERROR_CODE = "error_code";
  48
  49     /**
  50      * The name for the error message attribute to be set in the context
  51      */
  52     @SuppressWarnings("nls")
  53     public static final String ATTRIBUTE_ERROR_MESSAGE = "error-message";
  54
  55     /**
  56      * The name for the success message attribute to be set in the context
  57      */
  58     @SuppressWarnings("nls")
  59     public static final String ATTRIBUTE_SUCCESS_MESSAGE = "success-message";
  60
  61     public static final String DG_ATTRIBUTE_STATUS = "SvcLogic.status";
  62     public static final String DG_OUTPUT_STATUS_CODE = "output.status.code";
  63     public static final String DG_OUTPUT_STATUS_MESSAGE = "output.status.message";
  64
  65     /**
  66      * The property that defines the name of the DG service logic to be loaded
  67      */
  68     public static final String PROPERTY_MODULE_NAME = "appc.service.logic.module.name";
  69
  70     /**
  71      * The property that defines the topology restart DG version to be used
  72      */
  73     public static final String PROPERTY_TOPOLOGY_VERSION = "appc.topology.dg.version";
  74
  75     /**
  76      * The method name of the DG that is used to perform topology restart operations
  77      */
  78     public static final String PROPERTY_TOPOLOGY_METHOD = "appc.topology.dg.method";
  79
  80     /**
  81      * The property that supplies the application name
  82      */
  83     public static final String PROPERTY_APPLICATION_NAME = "appc.application.name";
  84
  85     /**
  86      * The execution mode for the directed graph
  87      */
  88     public static final String SYNC_MODE = "sync";
  89
  90     /**
  91      * The name of the property that contains the service request enumerated value in the graph's context
  92      */
  93     public static final String CONTEXT_SERVICE = "org.onap.appc.service";
  94
  95     /**
  96      * The name of the property that contains the VM id value in the graph's context
  97      */
  98     public static final String CONTEXT_VMID = "org.onap.appc.vmid";
  99
 100     /**
 101      * The name of the property that contains the VM id value in the graph's context
 102      */
 103     public static final String CONTEXT_IDENTITY_URL = "org.onap.appc.identity.url";
 104
 105     /**
 106      * The name of the property that contains the service request id value in the graph's context
 107      */
 108     public static final String CONTEXT_REQID = "org.onap.appc.reqid";
 109
 110     /**
 111      * The name of the property that indicates which method of the IaaS adapter to call
 112      */
 113     public static final String CONTEXT_ACTION = "org.onap.appc.action";
 114
 115     /**
 116      * The enumerated value for restart of a VM. This is a constant for one possible value of CONTEXT_SERVICE.
 117      */
 118     public static final String SERVICE_RESTART = "RESTART";
 119
 120     /**
 121      * The enumerated value for rebuild of a VM. This is a constant for one possible value of CONTEXT_SERVICE.
 122      */
 123     public static final String SERVICE_REBUILD = "REBUILD";
 124
 125     /**
 126      * The name of the adapter. We get the name from a property file so that it can be changed easily if needed.
 127      */
 128     public static final String PROPERTY_ADAPTER_NAME = "org.onap.appc.provider.adaptor.name";
 129
 130     /**
 131      * The minimum number of contexts to cache in each provider/tenant pool
 132      */
 133     public static final String PROPERTY_MIN_POOL_SIZE = "org.onap.appc.provider.min.pool";
 134
 135     /**
 136      * The maximum number of contexts to cache in each provider/tenant pool
 137      */
 138     public static final String PROPERTY_MAX_POOL_SIZE = "org.onap.appc.provider.max.pool";
 139
 140     /**
 141      * The amount of time, in seconds, that the application waits for a change of state of a server to a known valid
 142      * state before giving up and failing the request.
 143      */
 144     public static final String PROPERTY_SERVER_STATE_CHANGE_TIMEOUT = "org.onap.appc.server.state.change.timeout";
 145
 146     /**
 147      * The amount of time, in seconds, between subsequent polls to the openstack provider to update the state of a
 148      * resource
 149      */
 150     public static final String PROPERTY_OPENSTACK_POLL_INTERVAL = "org.onap.appc.openstack.poll.interval";
 151
 152     /**
 153      * The amount of time, in seconds, to wait between retry attempts when a connection to a provider fails.
 154      */
 155     public static final String PROPERTY_RETRY_DELAY = "org.onap.appc.provider.retry.delay";
 156
 157     /**
 158      * The maximum number of times a connection retry will be attempted before the application fails the request
 159      */
 160     public static final String PROPERTY_RETRY_LIMIT = "org.onap.appc.provider.retry.limit";
 161     /**
 162      * The amount of time, in seconds, that the application waits for a change of state of a stacj to a known valid
 163      * state before giving up and failing the request.
 164      */
 165     public static final String PROPERTY_STACK_STATE_CHANGE_TIMEOUT ="org.onap.appc.stack.state.change.timeout" ;
 166
 167     @SuppressWarnings("nls")
 168     public static final String STATUS_GETTER = "status-getter";
 169
 170     @SuppressWarnings("nls")
 171     public static final String VM_FUSION_STATUS_GETTER = "fusion-vm-status-getter";
 172
 173     /**
 174      * The name for the status vm attribute to be set in the context when executing a vmstatuscheck.
 175      */
 176     @SuppressWarnings("nls")
 177     public static final String STATUS_OF_VM = "status-vm";
 178
 179     /**
 180      * Yang revision value to be used while generating YANG module
 181      */
 182     public static final String YANG_REVISION = "2017-03-03";
 183     /**
 184      * Yang revision format to be used while formatting YANG revision date
 185      */
 186     public static final String YANG_REVISION_FORMAT = "YYYY-MM-DD";
 187
 188     /**
 189      * Base container for  yang that is generated to store in MD-SAL datastore
 190      */
 191     public static final String YANG_BASE_CONTAINER = "vnf-config-repo";
 192
 193     /**
 194      *VNF config list for yang that is generated to store in MD-SAL datastore
 195      */
 196     public static final String YANG_VNF_CONFIG_LIST = "vnf-config-list";
 197
 198     /**
 199      *Base container of VNF configuration data for yang that is generated to store in MD-SAL datastore
 200      */
 201     public static final String YANG_VNF_CONFIG = "vnf-config";
 202
 203     /**
 204      * default constructor prevents instantiation
 205      */
 206     Constants() {
 207         throw new IllegalAccessError("Constants");
 208     }
 209 }