b4d0476d8cfb205b6086e47f7c86a63a45d5becb
[aai/traversal.git] / aai-traversal / ajsc-shared-config / etc / csm-config-app.properties
1 Global.ExtendedProperty.AuthoritativeServers=${ChangeMe_csm.acfshost}:${ChangeMe_csm.acfsport}
2
3 #
4 # The settings in this file control the behavior of the CSM Framework. 
5 # The majority of the settings in this file adhere to the following
6 # pattern:
7
8 #  [EntityType].[EntityId].[PropertyName]=[PropertyValue]
9
10 # Where:
11
12 #  [EntityType]    Identifies the type of entity (service or
13 #                  service group) that's being configured.
14 #  [EntityId]      Identifies the individual entity.
15 #  [PropertyName]  Identifies the property that is being set.
16 #  [PropertyValue] Is the actual property value.
17
18 # In the formatting sample above, the EntityType can be setto one of the
19 # following values:
20
21 #  * 'Service' if an individual service is being configured.
22 #  * 'Group 'if a service group is being configured.
23
24 # The reference to 'entity' in the above description is intentionally
25 # generic.  The CSM Framework supports the configuration of individual
26 # services as well as groups of services.  The type of entity that is
27 # actually being configured is determined by the value of the
28 # [EntityType] portion of the property.
29
30 # There are two values for [EntityId] that have a special meaning within
31 # the CSM Framework:
32
33
34 # DefaultService - Identifies the default configuration for any service
35 #     that is not explicitly configured elsewhere in this file.
36
37 # DefaultServiceGroup - This identifies the entity that provides the
38 #     default configuration for any service group that is not explicitly
39 #     configured elsewhere in this file.
40
41 # DO NOT use either of these as the identifier for any of your
42 # application-specific services or service groups.
43
44 # The CSM Framework treats all entity identifiers in a case-insensitive
45 # manner.  The entity ids 'Service1' and 'SERVICE1' are equivalant.  All
46 # properties with the same [EntityId] will be applied to the same
47 # configuration.  The CSM Framework framework also treats property names
48 # in a case-insensitive manner.  'MaxRequestCount' and 'MAXREQUESTCOUNT'
49 # are considered equivalent within the CSM framework.
50
51 # The following properties are supported by the CSM Framework.  Any
52 # properties that are entity-specific will include the '[EntityId].'
53 # prefix.
54
55 # [EntityType].[EntityId].Enabled - Indicates if the entity is enabled
56 #     or disabled by default.  The value of this property must be either
57 #     'true' or 'false'.
58
59 # [EntityType].[EntityId].MaxRequestCount - The maximum number of
60 #     requests that can be running at any point in time.  Once this limit is
61 #     reached, the service is considered  to be 'flooded', and subsequent
62 #     requests are refused until the request count drops to the level
63 #     specified by the RestartThreshold property.  Once the restart
64 #     threshold is reached, the service will be 'restarted' based on the
65 #     values of the 'RestartFrequency' and 'RestartIncrement' properties.
66 #     The value of this property must be a numeric value.
67 #     The default value for this property is 20.
68
69 # [EntityType].[EntityId].MaxStalledRequestCount - the maximum number of
70 #     'stalled' requests that are allowed before subsequent requests are
71 #     refused
72 #     The value of this property must be a numeric value.
73 #     The default value for this property is 10.
74
75 # [EntityType].[EntityId].RestartThreshold - the process count level at
76 #     which requests will be allowed to proceed whenever a service becomes
77 #     'flooded'.  This property is only used if the total process count
78 #     reaches the level set by the 'MaxRequestCount' property.  Once that
79 #     occurs, subsequent requests will be refused until the active request
80 #     count drops to the level specified by this property.  Once the active
81 #     request count drops to the level specified by this property, the
82 #     service will be 'restarted' based on the values of the
83 #     'RestartFrequency' and 'RestartIncrement' properties.  To cause the
84 #     CSM framework to allow subsequent requests to proceed as soon as the
85 #     active request count drops below level level set by the
86 #     'MaxRequestCount' property, just set this property to either -1 or 1
87 #     less than the value of the 'MaxRequestCount' property.
88 #     The value of this property must be a numeric value.
89 #     The default value for this property is -1.
90
91 # [EntityType].[EntityId].RestartIncrement - This property, along with
92 #     the 'RestartFrequency' property helps determine how quickly the active
93 #     request count will rise to the 'maximum request count' whenever a
94 #     service is 'restarted' after becoming 'flooded'. The
95 #     'RestartFrequency' property determines how frequenty the permissable
96 #     number of active requests will be increased.  This property determines
97 #     how much the permissible number of active requests will increase by
98 #     whenever it is raised.  If this property is set to a positive value,
99 #     then the 'RestartFrequency' property must also be set to a positive
100 #     value.  If this property is set to 0, then the 'RestartFrequency'
101 #     property must also be set to 0.  In other words, either both
102 #     properties are 0 or both properties are greater than 0.  When both
103 #     properties are set to 0, then the permissable number of active
104 #     requests immediately rises back up to the maximum request count once
105 #     it has droppedback down to the 'restart threshold'.  When both
106 #     properties are greater than 0, then the permissable number of active
107 #     requests gradually rises to the maximum request count.
108 #     The value of this property must be a numeric value greater than or equal to 0.
109 #     The default value for this property is 0.
110
111 # [EntityType].[EntityId].RestartFrequency - This property, along with
112 #     the 'RestartIncrement' property helps determine how quickly the active
113 #     request count will rise to the 'maximum request count' whenever a
114 #     service is 'restarted' after becoming 'flooded'. The
115 #     'RestartIncrement' property determines how quickly the permissable
116 #     number of active requests will be increased.  This property determines
117 #     how frequently  that increase will occur.  If this property is set to
118 #     a positive value, then the 'RestartIncrement' property must also be
119 #     set to a positive value.  If this property is set to 0, then the
120 #     'RestartIncrement' property must also be set to 0.  In other words,
121 #     either both properties are 0 or both properties are greater than 0. 
122 #     When both properties are set to 0, then the permissable number of
123 #     active requests immediately rises back up to the maximum request count
124 #     once it has droppedback down to the 'restart threshold'.  When both
125 #     properties are greater than 0, then the permissable number of active
126 #     requests gradually rises to the maximum request count.
127 #     The value of this property must be a numeric value greater than or equal to 0.
128 #     The default value for this property is 0.
129
130 # [EntityType].[EntityId].ServiceGroupId - This property is only
131 #     relevant for entities that are configured as services (i.e. the
132 #     [EntityType] portion of the property is set to 'Service').  When the
133 #     'ServiceGroupId' property is set to a non-blank value, the behavior of
134 #     the service is controled by the configuration of the corresponding
135 #     service group.  There is no default value for this property.
136
137 # [EntityType].[EntityId].Timeout - the timeout, in milliseconds, for
138 #     each process that is controlled by this configuration.  Once the
139 #     duration of a process exceeds this value, the process will be
140 #     considered to have entered a 'stalled' state.  The default value for
141 #     this property is 10000.
142
143 # FrameworkEnabled: - This is the one property that is not specific to a
144 #     single entity.  This property determines whether the entire CSM
145 #     Framework is enabled or disabled.  When disabled, the CSM Framework
146 #     does not track any process counts.  All requests to access a service
147 #     are allowed, regardless of the current level of activity.  The value
148 #     of this property must be either 'true' or 'false'.
149
150
151 #
152 # Enables the CSM Framework so that it can manage interactions with external
153 # services and/or resources.  To disable the CSM Framework, simply set
154 # this property to false.
155 #
156 FrameworkEnabled=true
157
158 #
159 # These are the default settings for any service that is no explicitly configured
160 # below.  A few things to note about this configuration:
161 #  1) The "Enabled" property is not explicitly set.  Instead, we are relying
162 #     on the default value of 'true'.
163 #  2) The Timeout and Type properties are also not explicitly set.  Again, we
164 #     are relying on the default values for these properties.
165 #  
166 Service.DefaultService.Enabled=true
167 Service.DefaultService.MaxRequestCount=30
168 Service.DefaultService.MaxStalledRequestCount=20
169 Service.DefaultService.Timeout=30000
170 Service.DefaultService.RestartThreshold=-1
171 Service.DefaultService.AutoPurgeAfter=150000
172
173
174 #
175 # These are the default settings for any service group that is referenced in 
176 # a service configuration but not configured below.
177
178 # Currently CSI does not use any service group configurations!
179 #
180 #Group.DefaultGroup.MaxRequestCount=-1
181 #Group.DefaultGroup.MaxStalledRequestCount=-1
182 #Group.DefaultGroup.RestartThreshold=-1
183 #Group.DefaultGroup.Timeout=-1