appc-common/src/main/java/org/openecomp/appc/Constants.java

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