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