eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/TargetServiceLogInfo.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.utils.eelf.logger.api.info;
  21
  22 /**
  23  * Captures fields for logging application which is calling an external/target service
  24  *
  25  * @author Rajiv Singla
  26  */
  27 public interface TargetServiceLogInfo extends LogInfo {
  28
  29     /**
  30      * Required field containing name of EELF component/sub component or non-EELF entity which is invoked by the
  31      * logging application
  32      *
  33      * @return target entity name which is invoked by the logging application
  34      */
  35     String getTargetEntity();
  36
  37
  38     /**
  39      * Required field containing name of External API/operation activities invoked on {@link #getTargetEntity()}
  40      *
  41      * @return target service name invoked by the logging application
  42      */
  43     String getTargetServiceName();
  44
  45
  46     /**
  47      * Optional field containing target VNF or VM being acted upon by the logging application. This field contains the
  48      * virtual entity that is the target of the action for example the FQDN of the target virtual entity
  49      *
  50      * @return target Virtual Entity
  51      */
  52     String getTargetVirtualEntity();
  53
  54 }