PolicyEngineAPI/src/main/java/org/openecomp/policy/api/EventRequestParameters.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.policy.api;
  22
  23 import java.util.Map;
  24 import java.util.UUID;
  25
  26 /**
  27  * <code>EventRequestParameters</code> defines the Event Policy Request Parameters
  28  *  which retrieve(s) the response from PDP if the request parameters match with any Action Policy.
  29  *
  30  * @version 0.1
  31  */
  32 public class EventRequestParameters {
  33         private Map<String,String> eventAttributes;
  34         private UUID requestID;
  35
  36         /**
  37          * Constructor with no Parameters
  38          */
  39         public EventRequestParameters(){
  40         }
  41
  42         /**
  43          * Constructor with Parameters
  44          *
  45          * @param eventAttributes the <code>Map</code> of <code>String,String</code> format of the eventAttributes that contains the event ID and values.
  46          * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
  47          */
  48         public EventRequestParameters(Map<String,String> eventAttributes, UUID requestID){
  49                 this.eventAttributes = eventAttributes;
  50                 this.requestID = requestID;
  51         }
  52
  53         /**
  54          * Gets the eventAttributes of Event Request Parameters.
  55          *
  56          * @return eventAttributes the <code>Map</code> of <code>String,String</code> format of the eventAttributes that contains the event ID and values.
  57          */
  58         public Map<String,String> getEventAttributes() {
  59                 return eventAttributes;
  60         }
  61
  62         /**
  63          * Sets the eventAttributes that contain the eventID and values to the Event Request Parameters.
  64          *
  65          * @param eventAttributes the <code>Map</code> of <code>String,String</code> format of the eventAttributes that must contain the event ID and values.
  66          */
  67         public void setEventAttributes(Map<String,String> eventAttributes) {
  68                 this.eventAttributes = eventAttributes;
  69         }
  70
  71         /**
  72          * Gets the ReqestID of Event Request Parameters which will be passed around ECOMP requests.
  73          *
  74          * @return requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
  75          */
  76         public UUID getRequestID() {
  77                 return requestID;
  78         }
  79
  80         /**
  81          * Sets the ReqestID of Event Request Parameters which will be passed around ECOMP requests.
  82          *
  83          * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
  84          */
  85         public void setRequestID(UUID requestID) {
  86                 this.requestID = requestID;
  87         }
  88
  89 }