gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openecomp.sdc.logging.api;
  18
  19 /**
  20  * @author KATYR
  21  * @since February 15, 2018
  22  * This interface defines part of the Audit log application is responsible to provide.
  23  * Fields list is according to ONAP application logging guidelines
  24  * (https://wiki.onap.org/download/attachments/1015849/ONAP%20application%20logging%20guidelines.pdf?api=v2)
  25  * StartTime -> BeginTimestamp (Date-time that processing for the activities begins)
  26  * EndTime-> EndTimestamp (Date-time that processing for the activities being logged ends)
  27  * StatusCode -> StatusCode (indicate high level success or failure of the operation activities that is invoked)
  28  * ResponseCode -> ResponseCode(application-specific response code returned by the operation activities)
  29  * ResponseDescription - > ResponseDescription (human readable description of the response code)
  30  * ClientIpAddress -> ClientIpAddress (Requesting remote client application’s IP address)
  31  */
  32
  33 public interface AuditData {
  34
  35     enum StatusCode {
  36         COMPLETE, ERROR
  37     }
  38
  39     long getStartTime();
  40
  41     long getEndTime();
  42
  43     StatusCode getStatusCode();
  44
  45     String getResponseCode();
  46
  47     String getResponseDescription();
  48
  49     String getClientIpAddress();
  50 }