summaryrefslogtreecommitdiffstats
path: root/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/controller/FunctionalMenuController.java
blob: 5e13127c02fa1d607290bcfa05cbb715417dc76e (plain)
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
/*-
 * ============LICENSE_START==========================================
 * ONAP Portal
 * ===================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ===================================================================
 *
 * Unless otherwise specified, all software contained herein is licensed
 * under the Apache License, Version 2.0 (the "License");
 * you may not use this software 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.
 *
 * Unless otherwise specified, all documentation contained herein is licensed
 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
 * you may not use this documentation except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             https://creativecommons.org/licenses/by/4.0/
 *
 * Unless required by applicable law or agreed to in writing, documentation
 * 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.
 *
 * ============LICENSE_END============================================
 *
 *
 */
package org.onap.portalapp.portal.controller;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.core.Response;

import org.json.JSONObject;
import org.onap.portalapp.controller.EPRestrictedBaseController;
import org.onap.portalapp.portal.domain.EPUser;
import org.onap.portalapp.portal.domain.SharedContext;
import org.onap.portalapp.portal.ecomp.model.PortalRestResponse;
import org.onap.portalapp.portal.ecomp.model.PortalRestStatusEnum;
import org.onap.portalapp.portal.logging.aop.EPAuditLog;
import org.onap.portalapp.portal.service.AdminRolesService;
import org.onap.portalapp.portal.service.FunctionalMenuService;
import org.onap.portalapp.portal.service.SearchService;
import org.onap.portalapp.portal.service.SharedContextService;
import org.onap.portalapp.portal.transport.BusinessCardApplicationRole;
import org.onap.portalapp.portal.transport.BusinessCardApplicationRolesList;
import org.onap.portalapp.portal.transport.FavoritesFunctionalMenuItem;
import org.onap.portalapp.portal.transport.FavoritesFunctionalMenuItemJson;
import org.onap.portalapp.portal.transport.FieldsValidator;
import org.onap.portalapp.portal.transport.FunctionalMenuItem;
import org.onap.portalapp.portal.transport.FunctionalMenuItemWithRoles;
import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
import org.onap.portalapp.portal.utils.EcompPortalUtils;
import org.onap.portalapp.util.EPUserUtils;
import org.onap.portalapp.validation.DataValidator;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.portalsdk.core.util.SystemProperties;
import org.onap.portalsdk.core.web.support.UserUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * Supports menus at the top of the Portal app landing page.
 */
@RestController
@Configuration
@EnableAspectJAutoProxy
@EPAuditLog
public class FunctionalMenuController extends EPRestrictedBaseController {

	private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(FunctionalMenuController.class);
	private final DataValidator dataValidator = new DataValidator();

	@Autowired
	private AdminRolesService adminRolesService;
	@Autowired
	private FunctionalMenuService functionalMenuService;
	@Autowired
	private SharedContextService sharedContextService;
	@Autowired
	private SearchService searchService;

	/**
	 * RESTful service method to fetch all the FunctionalMenuItems.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = { "/portalApi/functionalMenu" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItems(HttpServletRequest request, HttpServletResponse response) {
		// TODO: should only the superuser be allowed to use this API?
		List<FunctionalMenuItem> menuItems = null;
		try {
			menuItems = functionalMenuService.getFunctionalMenuItems();
			functionalMenuService.assignHelpURLs(menuItems);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenu", "result =", menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItems failed", e);
		}
		return menuItems;
	}

	/**
	 * RESTful service method to get ONAP Portal Title.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return PortalRestResponse of ONAP portal title
	 */
	@RequestMapping(value = { "/portalApi/ecompTitle" }, method = RequestMethod.GET, produces = "application/json")
	public PortalRestResponse<String> getECOMPTitle(HttpServletRequest request, HttpServletResponse response) {
		PortalRestResponse<String> portalRestResponse = null;
		try {
			String ecompTitle = SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME);
			portalRestResponse = new PortalRestResponse<String>(PortalRestStatusEnum.OK, "success", ecompTitle);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/ecompTitle", "result =", ecompTitle);
		} catch (Exception e) {
			portalRestResponse = new PortalRestResponse<String>(PortalRestStatusEnum.ERROR, e.getMessage(), null);
			logger.error(EELFLoggerDelegate.errorLogger, "getEcompTitle failed", e);
		}
		return portalRestResponse;
	}

	/**
	 * RESTful service method to fetch all the FunctionalMenuItems, both active and
	 * inactive, for the EditFunctionalMenu feature. Can only be accessed by the
	 * portal admin.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuForEditing" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItemsForEditing(HttpServletRequest request, HttpServletResponse response) {
		// TODO: should only the superuser be allowed to use this API?
		EPUser user = EPUserUtils.getUserSession(request);
		List<FunctionalMenuItem> menuItems = null;
		try {
			if (!adminRolesService.isSuperAdmin(user)) {
				EcompPortalUtils.setBadPermissions(user, response, "getFunctionalMenuItemDetails");
			} else {
				menuItems = functionalMenuService.getFunctionalMenuItems(true);
			}
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuForEditing", "result =",
					menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItemsForEditing failed", e);
		}
		return menuItems;
	}

	/**
	 * RESTful service method to fetch all the FunctionalMenuItems, active , for the
	 * Functional menu in notification Tree feature.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuForNotificationTree" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItemsForNotifications(HttpServletRequest request,
			HttpServletResponse response) {
		// TODO: should only the superuser be allowed to use this API?
		// EPUser user = EPUserUtils.getUserSession(request);
		List<FunctionalMenuItem> menuItems = null;
		try {
			menuItems = functionalMenuService.getFunctionalMenuItemsForNotificationTree(true);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuForNotificationTree", "result =",
					menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItemsForNotifications failed", e);
		}
		return menuItems;
	}

	/**
	 * RESTful service method to fetch all FunctionalMenuItems associated with an
	 * application.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param appId
	 *            application ID
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuForApp/{appId}" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItemsForApp(HttpServletRequest request,
			@PathVariable("appId") Integer appId) {
		// TODO: should only the superuser be allowed to use this API?
		List<FunctionalMenuItem> menuItems = null;
		try {
			menuItems = functionalMenuService.getFunctionalMenuItemsForApp(appId);
			functionalMenuService.assignHelpURLs(menuItems);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuForApp/" + appId, "result =",
					menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItemsForApp failed", e);
		}
		return menuItems;
	}

	/**
	 * RESTful service method to fetch all FunctionalMenuItems associated with the
	 * applications and roles that a user has access to.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param orgUserId
	 *            user ID
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuForUser/{orgUserId}" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItemsForUser(HttpServletRequest request,
			@PathVariable("orgUserId") String orgUserId) {
		// TODO: should only the superuser be allowed to use this API?
		List<FunctionalMenuItem> menuItems = null;
		try {
			menuItems = functionalMenuService.getFunctionalMenuItemsForUser(orgUserId);
			functionalMenuService.assignHelpURLs(menuItems);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuForUser/" + orgUserId, "result =",
					menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItemsForUser failed", e);
		}

		return menuItems;
	}

	/**
	 * RESTful service method to fetch all FunctionalMenuItems associated with the
	 * applications and roles that the authenticated user has access to.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return List of FunctionalMenuItem objects
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuForAuthUser" }, method = RequestMethod.GET, produces = "application/json")
	public List<FunctionalMenuItem> getMenuItemsForAuthUser(HttpServletRequest request, HttpServletResponse response) {

		EPUser user = EPUserUtils.getUserSession(request);
		List<FunctionalMenuItem> menuItems = null;
		try {
			if (user == null) {
				EcompPortalUtils.setBadPermissions(user, response, "getMenuItemsForAuthUser");
			} else if (adminRolesService.isSuperAdmin(user)) {
				menuItems = functionalMenuService.getFunctionalMenuItems();
			} else {
				// calculate the menu items
				String orgUserId = user.getOrgUserId();
				menuItems = functionalMenuService.getFunctionalMenuItemsForUser(orgUserId);
				EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuForUser/" + orgUserId,
						"result =", menuItems);
			}
			functionalMenuService.assignHelpURLs(menuItems);
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getMenuItemsForAuthUser failed", e);
		}
		return menuItems;
	}

	/**
	 * RESTful service method to fetch the details for a functional menu item.
	 * Requirement: you must be the ONAP portal super admin user.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuId
	 *            menu ID
	 * @return FunctionalMenuItem object
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuItemDetails/{menuId}" }, method = RequestMethod.GET, produces = "application/json")
	public FunctionalMenuItem getFunctionalMenuItemDetails(HttpServletRequest request,
			@PathVariable("menuId") Long menuId, HttpServletResponse response) {
		// TODO: return FunctionalMenuItemJson
		// TODO: modify FunctionalMenuItem to not include the transient fields
		FunctionalMenuItem menuItem = null;
		try {
			EPUser user = EPUserUtils.getUserSession(request);
			if (!adminRolesService.isSuperAdmin(user)) {
				EcompPortalUtils.setBadPermissions(user, response, "getFunctionalMenuItemDetails");
			} else {
				menuItem = functionalMenuService.getFunctionalMenuItemDetails(menuId);
				EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuItemDetails/" + menuId,
						"result =", menuItem);
			}
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getFunctionalMenuItemDetails failed", e);
		}

		return menuItem;
	}

	/**
	 * RESTful service method to create a new menu item.
	 *
	 * Requirement: you must be the ONAP portal super admin user.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuItemJson
	 *            FunctionalMenuItemWithRoles
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/functionalMenuItem" }, method = RequestMethod.POST)
	public FieldsValidator createFunctionalMenuItem(HttpServletRequest request,
			@RequestBody FunctionalMenuItemWithRoles menuItemJson, HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;

		if(!dataValidator.isValid(menuItemJson)){
			fieldsValidator = new FieldsValidator();
			logger.warn(EELFLoggerDelegate.debugLogger,"FunctionalMenuController.createFunctionalMenuItem not valid object");
			fieldsValidator.httpStatusCode = (long)HttpServletResponse.SC_NOT_ACCEPTABLE;
			return fieldsValidator;
		}

		if (!adminRolesService.isSuperAdmin(user)) {
			logger.debug(EELFLoggerDelegate.debugLogger,
					"FunctionalMenuController.createFunctionalMenuItem bad permissions");
			EcompPortalUtils.setBadPermissions(user, response, "createFunctionalMenuItem");
		} else {
			fieldsValidator = functionalMenuService.createFunctionalMenuItem(menuItemJson);
			response.setStatus(fieldsValidator.httpStatusCode.intValue());
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuItem", "POST result =",
					response.getStatus());
		}

		return fieldsValidator;
	}

	/**
	 * RESTful service method to update an existing menu item
	 *
	 * Requirement: you must be the ONAP portal super admin user.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuItemJson
	 *            FunctionalMenuItemWithRoles
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/functionalMenuItem" }, method = RequestMethod.PUT)
	public FieldsValidator editFunctionalMenuItem(HttpServletRequest request,
			@RequestBody FunctionalMenuItemWithRoles menuItemJson, HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;

           if(!dataValidator.isValid(menuItemJson)){
			   fieldsValidator = new FieldsValidator();
			   logger.warn(EELFLoggerDelegate.debugLogger,"FunctionalMenuController.createFunctionalMenuItem not valid object");
			   fieldsValidator.httpStatusCode = (long)HttpServletResponse.SC_NOT_ACCEPTABLE;
			   return fieldsValidator;
           }

		if (!adminRolesService.isSuperAdmin(user)) {
			EcompPortalUtils.setBadPermissions(user, response, "editFunctionalMenuItem");
		} else {
			fieldsValidator = functionalMenuService.editFunctionalMenuItem(menuItemJson);
			response.setStatus(fieldsValidator.httpStatusCode.intValue());
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuItem", "PUT result =",
					response.getStatus());
		}

		return fieldsValidator;
	}

	/**
	 * RESTful service method to delete a menu item
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuId
	 *            menu identifier
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/functionalMenuItem/{menuId}" }, method = RequestMethod.DELETE)
	public FieldsValidator deleteFunctionalMenuItem(HttpServletRequest request, @PathVariable("menuId") Long menuId,
			HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;
		if (!adminRolesService.isSuperAdmin(user)) {
			EcompPortalUtils.setBadPermissions(user, response, "deleteFunctionalMenuItem");
		} else {
			fieldsValidator = functionalMenuService.deleteFunctionalMenuItem(menuId);
			response.setStatus(fieldsValidator.httpStatusCode.intValue());
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuItem", "DELETE result =",
					response.getStatus());
		}

		return fieldsValidator;
	}

	/**
	 * RESTful service to regenerate table
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/regenerateFunctionalMenuAncestors" }, method = RequestMethod.GET)
	public FieldsValidator regenerateAncestorTable(HttpServletRequest request, HttpServletResponse response) {
		// TODO: should only the superuser be allowed to use this API?
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;

		if (!adminRolesService.isSuperAdmin(user)) {
			EcompPortalUtils.setBadPermissions(user, response, "deleteFunctionalMenuItem");
		} else {
			fieldsValidator = functionalMenuService.regenerateAncestorTable();
			response.setStatus(fieldsValidator.httpStatusCode.intValue());
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/regenerateAncestorTable", "GET result =",
					response.getStatus());
		}

		return fieldsValidator;
	}

	/**
	 * RESful service to set a favorite item.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuItemJson
	 *            FunctionalMenuItemWithRoles
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/setFavoriteItem" }, method = RequestMethod.POST)
	public FieldsValidator addFavoriteItem(HttpServletRequest request,
			@RequestBody FavoritesFunctionalMenuItem menuItemJson, HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;
		menuItemJson.userId = user.getId();
		fieldsValidator = functionalMenuService.setFavoriteItem(menuItemJson);
		response.setStatus(fieldsValidator.httpStatusCode.intValue());
		EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/setFavoriteItem", "Post result =",
				response.getStatus());

		return fieldsValidator;
	}

	/**
	 * RESTful service to get favorites for the current user as identified in the
	 * session
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return List of FavoritesFunctionalMenuItemJson
	 */
	@RequestMapping(value = {
			"/portalApi/getFavoriteItems" }, method = RequestMethod.GET, produces = "application/json")
	public List<FavoritesFunctionalMenuItemJson> getFavoritesForUser(HttpServletRequest request,
			HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		List<FavoritesFunctionalMenuItemJson> favorites = functionalMenuService.getFavoriteItems(user.getId());
		FieldsValidator fieldsValidator = new FieldsValidator();
		response.setStatus(fieldsValidator.httpStatusCode.intValue());
		EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/getFavoriteItems", "GET result =",
				response.getStatus());
		return favorites;
	}

	/**
	 * RESTful service to delete a favorite menu item for the current user as
	 * identified in the session.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @param menuId
	 *            menu identifier
	 * @return FieldsValidator
	 */
	@RequestMapping(value = { "/portalApi/removeFavoriteItem/{menuId}" }, method = RequestMethod.DELETE)
	public FieldsValidator deleteFavoriteItem(HttpServletRequest request, @PathVariable("menuId") Long menuId,
			HttpServletResponse response) {
		EPUser user = EPUserUtils.getUserSession(request);
		FieldsValidator fieldsValidator = null;
		Long userId = user.getId();
		fieldsValidator = functionalMenuService.removeFavoriteItem(userId, menuId);
		response.setStatus(fieldsValidator.httpStatusCode.intValue());
		EcompPortalUtils.logAndSerializeObject(logger, "/deleteFavoriteItem", "DELETE result =", response.getStatus());

		return fieldsValidator;
	}

	/**
	 * RESTful service to get user information: user's first and last names, org
	 * user ID, email and last-login. (Actually has nothing to do with the real
	 * functional menu.) First attempts to get the information from the Tomcat
	 * session (i.e., the CSP cookie); if that fails, calls the shared context
	 * service to read the information from the database. Gives back what it found,
	 * any of which may be null, as a JSON collection.
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param response
	 *            HttpServletResponse
	 * @return JSON collection of key-value pairs shown below.
	 */
	@RequestMapping(value = {
			"/portalApi/functionalMenuStaticInfo" }, method = RequestMethod.GET, produces = "application/json")
	public String getFunctionalMenuStaticInfo(HttpServletRequest request, HttpServletResponse response) {

		// Get user details from session
		logger.debug(EELFLoggerDelegate.debugLogger, "getFunctionalMenuStaticInfo: getting user info");
		String fnMenuStaticResponse = null;
		try {
			String orgUserIdStr = null, firstNameStr = null, lastNameStr = null, emailStr = null, lastLogin = null;
			EPUser user = EPUserUtils.getUserSession(request);
			firstNameStr = user.getFirstName();
			lastNameStr = user.getLastName();
			orgUserIdStr = user.getOrgUserId();
			emailStr = user.getEmail();
			if (emailStr == null || emailStr.equals("")) {
				EPUser userResult = searchService.searchUserByUserId(orgUserIdStr);
				emailStr = userResult.getEmail();
			}
			SimpleDateFormat sdf = new SimpleDateFormat("MM/dd/yyyy hh:mm:ss Z a");
			Date lastLoginDate = user.getLastLoginDate();
			if (lastLoginDate == null) {
				// should never happen
				logger.error(EELFLoggerDelegate.errorLogger, "getFunctionalMenuStaticInfo: no last login in session");
				lastLogin = "no last login available";
			} else {
				lastLogin = sdf.format(lastLoginDate);
			}

			// If any item is missing from session, try the Shared Context
			// service.
			SharedContext orgUserIdSC = null, firstNameSC = null, lastNameSC = null, emailSC = null;
			String sessionId = request.getSession().getId();
			if (firstNameStr == null)
				firstNameSC = sharedContextService.getSharedContext(sessionId,
						EPCommonSystemProperties.USER_FIRST_NAME);
			if (lastNameStr == null)
				lastNameSC = sharedContextService.getSharedContext(sessionId, EPCommonSystemProperties.USER_LAST_NAME);
			if (emailStr == null)
				emailSC = sharedContextService.getSharedContext(sessionId, EPCommonSystemProperties.USER_EMAIL);
			if (orgUserIdStr == null)
				orgUserIdSC = sharedContextService.getSharedContext(sessionId,
						EPCommonSystemProperties.USER_ORG_USERID);

			// Build the response
			Map<String, String> map = new HashMap<String, String>();
			map.put("firstName",
					firstNameStr != null ? firstNameStr : (firstNameSC != null ? firstNameSC.getCvalue() : null));
			map.put("lastName",
					lastNameStr != null ? lastNameStr : (lastNameSC != null ? lastNameSC.getCvalue() : null));
			map.put("email", emailStr != null ? emailStr : (emailSC != null ? emailSC.getCvalue() : null));
			map.put("userId",
					orgUserIdStr != null ? orgUserIdStr : (orgUserIdSC != null ? orgUserIdSC.getCvalue() : null));
			map.put("last_login", lastLogin);
			JSONObject j = new JSONObject(map);
			fnMenuStaticResponse = j.toString();
			// Be chatty in the log
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/functionalMenuStaticInfo", "GET result =",
					fnMenuStaticResponse);
		} catch (Exception e) {
			// Should never happen.
			logger.error(EELFLoggerDelegate.errorLogger, "getFunctionalMenuStaticInfo failed", e);
			// Return a real error?
			// fnMenuStaticResponse = "{ \"status\": \"error\", \"message\": \""
			// + e.toString() + "\" }";
			// But the angular controller expects null on error.
		}
		return fnMenuStaticResponse;
	}

	private Comparator<BusinessCardApplicationRole> getUserAppRolesComparator = new Comparator<BusinessCardApplicationRole>() {
		public int compare(BusinessCardApplicationRole o1, BusinessCardApplicationRole o2) {
			return o1.getAppName().compareTo(o2.getAppName());
		}
	};

	/**
	 *
	 * @param request
	 *            HttpServletRequest
	 * @param userId
	 *            user ID
	 * @return List<BusinessCardApplicationRolesList>
	 * @throws IOException
	 *             on error
	 */
	@RequestMapping(value = {
			"/portalApi/userApplicationRoles" }, method = RequestMethod.GET, produces = "application/json")
	public List<BusinessCardApplicationRolesList> getAppList(HttpServletRequest request, HttpServletResponse response,
			@RequestParam("userId") String userId) throws IOException {

		List<BusinessCardApplicationRolesList> AppRoles = null;
		
		if(!UserUtils.getUserSession(request).getOrgUserId().equalsIgnoreCase(userId)) {
			logger.error(EELFLoggerDelegate.errorLogger, "Not authorized to view roles of others ");
			response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
			response.getWriter().flush();
			return null;
		}
			
		try {
			List<BusinessCardApplicationRole> userAppRoleList = functionalMenuService.getUserAppRolesList(userId);

			Collections.sort(userAppRoleList, getUserAppRolesComparator);
			EcompPortalUtils.logAndSerializeObject(logger, "/portalApi/userApplicationRoles", "result =",
					userAppRoleList);

			AppRoles = new ArrayList<BusinessCardApplicationRolesList>();
			for (BusinessCardApplicationRole userAppRole : userAppRoleList) {
				boolean found = false;
				List<String> roles = null;

				for (BusinessCardApplicationRolesList app : AppRoles) {
					if (app.getAppName().equals(userAppRole.getAppName())) {
						roles = app.getRoleNames();
						roles.add(userAppRole.getRoleName());
						app.setRoleNames(roles);
						found = true;
						break;
					}
				}

				if (!found) {
					roles = new ArrayList<String>();
					roles.add(userAppRole.getRoleName());
					AppRoles.add(new BusinessCardApplicationRolesList(userAppRole.getAppName(), roles));
				}

				Collections.sort(roles);
			}
		} catch (Exception e) {
			logger.error(EELFLoggerDelegate.errorLogger, "getAppList failed", e);
		}

		return AppRoles;

	}
}