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

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