ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/api/data/BlueprintProcessorData.kt

   1 /*
   2  *  Copyright © 2017-2018 AT&T Intellectual Property.
   3  *  Modifications Copyright © 2018 IBM.
   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  */
  17
  18 package org.onap.ccsdk.cds.blueprintsprocessor.core.api.data
  19
  20 import com.fasterxml.jackson.annotation.JsonFormat
  21 import com.fasterxml.jackson.annotation.JsonIgnore
  22 import com.fasterxml.jackson.databind.JsonNode
  23 import com.fasterxml.jackson.databind.node.ObjectNode
  24 import io.swagger.annotations.ApiModelProperty
  25 import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType
  26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
  27 import java.util.Date
  28
  29 /**
  30  * BlueprintProcessorData
  31  * @author Brinda Santh
  32  * DATE : 8/15/2018
  33  */
  34
  35 open class ExecutionServiceInput {
  36
  37     @get:ApiModelProperty(required = true, value = "Headers providing request context.")
  38     lateinit var commonHeader: CommonHeader
  39     @get:ApiModelProperty(required = true, value = "Provide information about the action to execute.")
  40     lateinit var actionIdentifiers: ActionIdentifiers
  41     @get:ApiModelProperty(
  42         required = true,
  43         value = "Contain the information to be passed as input to the action." +
  44                 "The payload is constituted of two section: the workflow input which is the higher level block (xxx-request)" +
  45                 " and the input for resource resolution located within the xxx-request block, contained within xxx-properties"
  46     )
  47     lateinit var payload: ObjectNode
  48     @get:ApiModelProperty(hidden = true)
  49     @get:JsonIgnore
  50     var stepData: StepData? = null
  51 }
  52
  53 open class ExecutionServiceOutput {
  54     @get:ApiModelProperty(required = true, value = "Headers providing request context.")
  55     lateinit var commonHeader: CommonHeader
  56     @get:ApiModelProperty(required = true, value = "Provide information about the action to execute.")
  57     lateinit var actionIdentifiers: ActionIdentifiers
  58     @get:ApiModelProperty(required = true, value = "Status of the request.")
  59     lateinit var status: Status
  60     @get:ApiModelProperty(
  61         required = true,
  62         value = "Contain the information to be passed as input to the action." +
  63                 "The payload is constituted of two section: the workflow input which is the higher level block (xxx-request)" +
  64                 " and the input for resource resolution located within the xxx-request block, contained within xxx-properties"
  65     )
  66     lateinit var payload: ObjectNode
  67     @get:ApiModelProperty(hidden = true)
  68     @get:JsonIgnore
  69     var stepData: StepData? = null
  70 }
  71
  72 const val ACTION_MODE_ASYNC = "async"
  73 const val ACTION_MODE_SYNC = "sync"
  74
  75 open class ActionIdentifiers {
  76     @get:ApiModelProperty(required = false, value = "Name of the CBA.")
  77     lateinit var blueprintName: String
  78     @get:ApiModelProperty(required = false, value = "Version of the CBA.")
  79     lateinit var blueprintVersion: String
  80     @get:ApiModelProperty(required = true, value = "Name of the workflow to execute.")
  81     lateinit var actionName: String
  82     @get:ApiModelProperty(
  83         required = true,
  84         value = "Async processing is only supported for gRPC client.",
  85         allowableValues = "sync, async"
  86     )
  87     lateinit var mode: String
  88 }
  89
  90 open class CommonHeader {
  91     @get:ApiModelProperty(required = true, value = "Date of the execution", example = "2012-04-23T18:25:43.511Z")
  92     @get:JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
  93     var timestamp: Date = Date()
  94     @get:ApiModelProperty(required = true, value = "Identify the system/person triggering the request.")
  95     lateinit var originatorId: String
  96     @get:ApiModelProperty(required = true, value = "Uniquely identify a request.")
  97     lateinit var requestId: String
  98     @get:ApiModelProperty(required = true, value = "Allow for fine-grain request identifier")
  99     lateinit var subRequestId: String
 100     @get:ApiModelProperty(required = false, hidden = true)
 101     var flags: Flags? = null
 102 }
 103
 104 open class Flags {
 105     @get:ApiModelProperty(value = "Whether or not to force the action.")
 106     var isForce: Boolean = false
 107     @get:ApiModelProperty(value = "3600")
 108     var ttl: Int = 3600
 109 }
 110
 111 open class Status {
 112     @get:ApiModelProperty(required = true, value = "HTTP status code equivalent.")
 113     var code: Int = 200
 114     @get:ApiModelProperty(required = true, value = "Type of the event being emitted by CDS.")
 115     var eventType: String = EventType.EVENT_COMPONENT_EXECUTED.name
 116     @get:ApiModelProperty(
 117         required = true,
 118         value = "Time when the execution ended.",
 119         example = "2012-04-23T18:25:43.511Z"
 120     )
 121     @get:JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
 122     var timestamp: Date = Date()
 123     @get:ApiModelProperty(required = false, value = "Error message when system failed")
 124     var errorMessage: String? = null
 125     @get:ApiModelProperty(required = true, value = "Message providing request status")
 126     var message: String = BluePrintConstants.STATUS_SUCCESS
 127 }
 128
 129 open class StepData {
 130     lateinit var name: String
 131     var properties: MutableMap<String, JsonNode> = mutableMapOf()
 132 }