1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/*-
* ================================================================================
* eCOMP Portal SDK
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ================================================================================
*/
package org.openecomp.portalsdk.core.util;
import javax.servlet.ServletContext;
import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;
/**
* SystemProperties contains a list of constants used throughout portions of the
* application. Populated by Spring from multiple configuration files.
*
* Should be used like this:
*
* <pre>
*
* @Autowired
* SystemProperties systemProperties;
* </pre>
*/
@Configuration
@PropertySource(value = { "${container.classpath:}/WEB-INF/conf/system.properties",
"${container.classpath:}/WEB-INF/fusion/conf/fusion.properties",
"${container.classpath:}/WEB-INF/conf/sql.properties" })
public class SystemProperties {
private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(SystemProperties.class);
private static Environment environment;
private ServletContext servletContext;
public SystemProperties() {
}
protected Environment getEnvironment() {
return environment;
}
@Autowired
public void setEnvironment(Environment environment) {
SystemProperties.environment = environment;
}
public ServletContext getServletContext() {
return servletContext;
}
public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
}
/**
* Tests whether a property value is available for the specified key.
*
* @param key
* @return True if the key is known, otherwise false.
*/
public static boolean containsProperty(String key) {
return environment.containsProperty(key);
}
/**
* Returns the property value associated with the given key (never
* {@code null}), after trimming any trailing space.
*
* @throws IllegalStateException
* if the key cannot be resolved
* @param key
* Property key
* @return Property value; the empty string if the environment was not
* autowired, which should never happen.
*/
public static String getProperty(String key) {
String value = "";
if (environment == null) {
logger.error(EELFLoggerDelegate.errorLogger, "getProperty: environment is null, should never happen!");
}
else {
value = environment.getRequiredProperty(key);
// java.util.Properties preserves trailing space
if (value != null)
value = value.trim();
}
return value;
}
/**
* Gets the property value for the key {@link #APPLICATION_NAME}.
*
* method created to get around JSTL 1.0 limitation of not being able to
* access a static method of a bean
*
* @return Application name
*/
public String getApplicationName() {
return getProperty(APPLICATION_NAME);
}
/**
* Gets the property value for the key {@link #APP_DISPLAY_NAME}.
*
* @return Application display name
*/
public String getAppDisplayName() {
return getProperty(APP_DISPLAY_NAME);
}
// keys used to reference values in the system properties file
public static final String DOMAIN_CLASS_LOCATION = "domain_class_location";
public static final String DEFAULT_ERROR_MESSAGE = "default_error_message";
public static final String CSP_COOKIE_NAME = "csp_cookie_name";
public static final String CSP_GATE_KEEPER_DATA_KEY = "csp_gate_keeper_data_key";
public static final String CSP_GATE_KEEPER_PROD_KEY = "csp_gate_keeper_prod_key";
public static final String CSP_LOGIN_URL = "csp_login_url";
public static final String CSP_LOGOUT_URL = "csp_logout_url";
public static final String WEB_JUNCTION_USER_ID_HEADER_NAME = "web_junction_user_id_header_name";
public static final String AUTHENTICATION_MECHANISM = "authentication_mechanism";
public static final String APPLICATION_NAME = "application_name";
public static final String HIBERNATE_CONFIG_FILE_PATH = "hibernate_config_file_path";
public static final String APPLICATION_USER_ID = "application_user_id";
public static final String POST_INITIAL_CONTEXT_FACTORY = "post_initial_context_factory";
public static final String POST_PROVIDER_URL = "post_provider_url";
public static final String POST_SECURITY_PRINCIPAL = "post_security_principal";
public static final String POST_MAX_RESULT_SIZE = "post_max_result_size";
public static final String POST_DEFAULT_ROLE_ID = "post_default_role_id";
public static final String FILES_PATH = "files_path";
public static final String TEMP_PATH = "temp_path";
public static final String NUM_UPLOAD_FILES = "num_upload_files";
public static final String SYS_ADMIN_ROLE_ID = "sys_admin_role_id";
public static final String SYS_ADMIN_ROLE_FUNCTION_DELETE_FROM_UI = "sys_admin_role_function_delete_from_ui";
public static final String USER_NAME = "user_name";
public static final String FIRST_NAME = "first_name";
public static final String LAST_NAME = "last_name";
public static final String APP_DISPLAY_NAME = "app_display_name";
// Application base URL is a proper prefix of the on-boarding URL
public static final String APP_BASE_URL = "app_base_url";
public static final String MENU_PROPERTIES_FILE_LOCATION = "menu_properties_file_location";
public static final String MENU_QUERY_NAME = "menu_query_name";
public static final String APPLICATION_MENU_SET_NAME = "application_menu_set_name";
public static final String APPLICATION_MENU_ATTRIBUTE_NAME = "application_menu_attribute_name";
public static final String APPLICATION_MENU_PROPERTIES_NAME = "application_menu_properties_name";
public static final String BUSINESS_DIRECT_MENU_SET_NAME = "business_direct_menu_set_name";
public static final String BUSINESS_DIRECT_MENU_ATTRIBUTE_NAME = "business_direct_menu_attribute_name";
public static final String BUSINESS_DIRECT_MENU_PROPERTIES_NAME = "business_direct_menu_properties_name";
public static final String RAPTOR_CONFIG_FILE_PATH = "raptor_config_file_path";
public static final String HOMEPAGE_DATA_CALLBACK_CLASS = "homepage_data_callback_class";
public static final String ERROR_EMAIL_DISTRIBUTION = "error_email_distribution";
public static final String ERROR_EMAIL_SOURCE_ADDRESS = "error_email_source_address";
public static final String ERROR_EMAIL_SUBJECT_LINE = "error_email_subject_line";
public static final String PROFILE_SEARCH_REPORT_ID = "profile_search_report_id";
public static final String CALLABLE_PROFILE_SEARCH_REPORT_ID = "callable_profile_search_report_id";
public static final String CLUSTERED = "clustered";
public static final String USER_ATTRIBUTE_NAME = "user_attribute_name";
public static final String ROLES_ATTRIBUTE_NAME = "roles_attribute_name";
public static final String ROLE_FUNCTIONS_ATTRIBUTE_NAME = "role_functions_attribute_name";
public static final String CLIENT_DEVICE_ATTRIBUTE_NAME = "client_device_attribute_name";
public static final String CLIENT_DEVICE_EMULATION = "client_device_emulation";
public static final String CLIENT_DEVICE_TYPE_TO_EMULATE = "client_device_type_to_emulate";
// File generation - Document
public static final String TEMPLATES_PATH = "templates_path";
public static final String DOCUMENT_XML_ENCODING = "document_xml_encoding";
// Transaction
public static final String ROUTING_DATASOURCE_KEY = "routing_datasource_key";
// Document Library keys
public static final String DOCLIB_ADMIN_ROLE_ID = "doclib_admin_role_id";
public static final String DOCLIB_USER_ROLE_ID = "doclib_user_role_id";
public static final String SYSTEM_PROPERTIES_FILENAME = "system.properties";
public static final String FUSION_PROPERTIES_FILENAME = "fusion.properties";
public static final String SUCCESS_TASKS_PROPERTIES_FILENAME = "success_tasks.properties";
// login methods
public static final String LOGIN_METHOD_CSP = "login_method_csp";
public static final String LOGIN_METHOD_WEB_JUNCTION = "login_method_web_junction";
public static final String LOGIN_METHOD_BACKDOOR = "login_method_backdoor";
public static final String LOGIN_METHOD_ATTRIBUTE_NAME = "login_method_attribute_name";
// login error message keys
public static final String MESSAGE_KEY_LOGIN_ERROR_COOKIE_EMPTY = "login.error.hrid.empty";
public static final String MESSAGE_KEY_LOGIN_ERROR_HEADER_EMPTY = "login.error.header.empty";
public static final String MESSAGE_KEY_LOGIN_ERROR_USER_INACTIVE = "login.error.user.inactive";
public static final String MESSAGE_KEY_LOGIN_ERROR_USER_NOT_FOUND = "login.error.hrid.not-found";
public static final String MESSAGE_KEY_LOGIN_ERROR_APPLICATION_LOCKED = "login.error.application.locked";
public static final String MESSAGE_KEY_AUTOLOGIN_NONE = "webphone.autoimport.nouser";
public static final String MESSAGE_KEY_AUTOLOGIN_MULTIPLE = "webphone.autoimport.multiple";
// Application Mobile capability
public static final String MOBILE_ENABLE = "mobile_enable";
public static final String DATABASE_TIME_ZONE = "db.time_zone";
public static final String AUTO_USER_IMPORT_ENABLE = "auto_user_import_enable";
public static final String AUTO_USER_IMPORT_ROLE = "auto_user_import_role";
public static final String ITRACKER_EMAIL_SOURCE_ADDRESS = "itracker_email_source_address";
public static final String ITRACKER_EMAIL_DISTRIBUTION = "itracker_email_distribution";
public static final String ITRACKER_SYSTEM_USER = "itracker_system_user_id";
public static final String MAIL_SERVER_HOST = "mail_server_host";
public static final String MAIL_SERVER_PORT = "mail_server_port";
// Routing Data Source keys
public static final String ROUTING_DATASOURCE_KEY_NON_XA = "NON-XA";
public static final String ROUTING_DATASOURCE_KEY_XA = "XA";
public static final String QUARTZ_JOB_ENABLED = "quartz_job_enable";
public static final String WORKFLOW_EMAIL_SENDER = "workflow_email_sender";
public static final String DROOLS_GUVNOR_HOME = "drools.guvnor.home";
// Hibernate Config
public static final String HB_DIALECT = "hb.dialect";
public static final String HB_SHOW_SQL = "hb.show_sql";
// DataSource
public static final String DB_DRIVER = "db.driver";
public static final String DB_CONNECTIONURL = "db.connectionURL";
public static final String DB_USERNAME = "db.userName";
public static final String DB_PASSWOR = "db.password";
public static final String DB_MIN_POOL_SIZE = "db.min_pool_size";
public static final String DB_MAX_POOL_SIZE = "db.max_pool_size";
public static final String IDLE_CONNECTION_TEST_PERIOD = "hb.idle_connection_test_period";
public static final String MYLOGINS_FEED_CRON = "mylogins_feed_cron";
public static final String SESSIONTIMEOUT_FEED_CRON = "sessiontimeout_feed_cron";
public static final String LOG_CRON = "log_cron";
public static final String DB_ENCRYPT_FLAG = "db.encrypt_flag";
// Decryption Key
public static final String Decryption_Key = "decryption_key";
// Logging/Audit Fields
public static final String MDC_APPNAME = "AppName";
public static final String MDC_REST_PATH = "RestPath";
public static final String MDC_REST_METHOD = "RestMethod";
public static final String INSTANCE_UUID = "instance_uuid";
public static final String MDC_CLASS_NAME = "ClassName";
public static final String MDC_LOGIN_ID = "LoginId";
public static final String MDC_TIMER = "Timer";
public static final String SDK_NAME = "ECOMP_SDK";
public static final String ECOMP_REQUEST_ID = "X-ECOMP-RequestID";
public static final String PARTNER_NAME = "PartnerName";
public static final String FULL_URL = "Full-URL";
public static final String AUDITLOG_BEGIN_TIMESTAMP = "AuditLogBeginTimestamp";
public static final String AUDITLOG_END_TIMESTAMP = "AuditLogEndTimestamp";
public static final String METRICSLOG_BEGIN_TIMESTAMP = "MetricsLogBeginTimestamp";
public static final String METRICSLOG_END_TIMESTAMP = "MetricsLogEndTimestamp";
public static final String CLIENT_IP_ADDRESS = "ClientIPAddress";
public static final String STATUS_CODE = "StatusCode";
public static final String RESPONSE_CODE = "ResponseCode";
// Component or sub component name
public static final String TARGET_ENTITY = "TargetEntity";
// API or operation name
public static final String TARGET_SERVICE_NAME = "TargetServiceName";
// Logging Compliance
public static final String DOUBLE_WHITESPACE_SEPARATOR = " ";
public static final String SINGLE_WHITESPACE_SEPARATOR = " ";
public static final String SINGLE_QUOTE = "'";
public static final String NA = "N/A";
public static final String UNKNOWN = "Unknown";
public static final String SECURITY_LOG_TEMPLATE = "Protocol:{0} Security-Event-Type:{1} Login-ID:{2} {3}";
public static final String ECOMP_PORTAL_BE = "ECOMP_PORTAL_BE";
public static final String PROTOCOL = "PROTOCOL";
public static final String SECURIRY_EVENT_TYPE = "SECURIRY_EVENT_TYPE";
public static final String LOGIN_ID = "LOGIN_ID";
public static final String ACCESSING_CLIENT = "ACCESSING_CLIENT";
public static final String RESULT_STR = "RESULT";
public static final String ECOMP_PORTAL_FE = "ECOMP_PORTAL_FE";
public static final String ADDITIONAL_INFO = "ADDITIONAL_INFO";
public static final String INTERFACE_NAME = "INTERFACE_NAME";
public static final String USERAGENT_NAME = "user-agent";
// Protocols
public static final String HTTP = "HTTP";
public static final String HTTPS = "HTTPS";
public static final String SSO_VALUE = "sso";
public enum RESULT_ENUM {
SUCCESS, FAILURE
}
public enum SecurityEventTypeEnum {
FE_LOGIN_ATTEMPT, FE_LOGOUT, SSO_LOGIN_ATTEMPT_PHASE_1, SSO_LOGIN_ATTEMPT_PHASE_2, SSO_LOGOUT, LDAP_PHONEBOOK_USER_SEARCH, INCOMING_REST_MESSAGE, OUTGOING_REST_MESSAGE, REST_AUTHORIZATION_CREDENTIALS_MODIFIED, ECOMP_PORTAL_USER_MODIFIED, ECOMP_PORTAL_USER_ADDED, ECOMP_PORTAL_USER_REMOVED, ECOMP_PORTAL_WIDGET, INCOMING_UEB_MESSAGE, ECOMP_PORTAL_HEALTHCHECK
}
// Menu
public static final String CONTACT_US_LINK = "contact_us_link";
// Left Menu
public static final String LEFT_MENU_PARENT = "parentList";
public static final String LEFT_MENU_CHILDREND = "childItemList";
}
|
