Update license; improve coverage; add docs dir

[portal.git] / ecomp-portal-BE-common / src / main / java / org / openecomp / portalapp / portal / controller / AuditLogController.java

diff --git a/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/AuditLogController.java b/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/AuditLogController.java
index 14ba94f..aa8d7bf 100644 (file)
--- a/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/AuditLogController.java
+++ b/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/AuditLogController.java
@@ -1,21 +1,39 @@
 /*-
- * ================================================================================
- * ECOMP Portal
- * ================================================================================
- * 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.
+ * ============LICENSE_START==========================================
+ * ONAP Portal
+ * ===================================================================
+ * Copyright © 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
- * 
+ *
+ *             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============================================
+ *
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  */
 package org.openecomp.portalapp.portal.controller;
 
@@ -52,17 +70,21 @@ public class AuditLogController extends EPRestrictedBaseController {
         * Store audit log of the specified access type.
         * 
         * @param request
+        *            HttpServletRequest
         * @param affectedAppId
+        *            App ID
         * @param type
+        *            Access type
         * @param comment
+        *            Comment
         */
        @RequestMapping(value = "/store", method = RequestMethod.GET, produces = "application/json")
        public void auditLog(HttpServletRequest request, @RequestParam String affectedAppId, @RequestParam String type,
                        @RequestParam String comment) {
-               logger.debug(EELFLoggerDelegate.debugLogger, "auditLog: appId {}, type {], comment {}", 
-                               affectedAppId, type, comment);
+               logger.debug(EELFLoggerDelegate.debugLogger, "auditLog: appId {}, type {], comment {}", affectedAppId, type,
+                               comment);
                String cd_type = null;
-               try {                                   
+               try {
                        EPUser user = EPUserUtils.getUserSession(request);
                        /* Check type of Activity CD */
                        if (type.equals("app")) {
@@ -74,15 +96,15 @@ public class AuditLogController extends EPRestrictedBaseController {
                        } else if (type.equals("leftMenu")) {
                                cd_type = AuditLog.CD_ACTIVITY_LEFT_MENU_ACCESS;
                        } else {
-                               logger.error(EELFLoggerDelegate.errorLogger, "Storing auditLog failed! Activity CD type is not correct.");
+                               logger.error(EELFLoggerDelegate.errorLogger,
+                                               "Storing auditLog failed! Activity CD type is not correct.");
                        }
                        /* Store the audit log only if it contains valid Activity CD */
                        if (cd_type != null) {
                                AuditLog auditLog = new AuditLog();
                                auditLog.setActivityCode(cd_type);
                                /*
-                                * Check affectedAppId and comment and see if these two values are
-                                * valid
+                                * Check affectedAppId and comment and see if these two values are valid
                                 */
                                if (comment != null && !comment.equals("") && !comment.equals("undefined"))
                                        auditLog.setComments(EcompPortalUtils.truncateString(comment, PortalConstants.AUDIT_LOG_COMMENT_SIZE));
@@ -93,10 +115,10 @@ public class AuditLogController extends EPRestrictedBaseController {
                                auditService.logActivity(auditLog, null);
 
                                // Log file
-                               MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,EPEELFLoggerAdvice.getCurrentDateTimeUTC());          
-                               MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP,EPEELFLoggerAdvice.getCurrentDateTimeUTC());
-                               logger.info(EELFLoggerDelegate.auditLogger, EPLogUtil.formatAuditLogMessage("AuditLogController.auditLog", 
-                                               cd_type, user.getOrgUserId(), affectedAppId, comment)); 
+                               MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
+                               MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
+                               logger.info(EELFLoggerDelegate.auditLogger, EPLogUtil.formatAuditLogMessage(
+                                               "AuditLogController.auditLog", cd_type, user.getOrgUserId(), affectedAppId, comment));
                                MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
                                MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);
                        }