1 tosca_definitions_version: tosca_simple_yaml_1_3
3 onap.datatypes.ToscaConceptIdentifier:
4 derived_from: tosca.datatypes.Root
13 onap.datatypes.native.apex.EngineService:
14 derived_from: tosca.datatypes.Root
18 description: Specifies the engine name
20 default: "ApexEngineService"
23 description: Specifies the engine version in double dotted format
28 description: Specifies the engine id
32 description: Specifies the number of engine threads that should be run
36 description: Specifies the port to connect to for engine administration
39 policy_model_file_name:
41 description: The name of the file from which to read the APEX policy model
45 description: The policy type implementation from which to read the APEX policy model
47 periodic_event_period:
49 description: The time interval in milliseconds for the periodic scanning event, 0 means don't scan
52 type: onap.datatypes.native.apex.engineservice.Engine
53 description: The parameters for all engines in the APEX engine service
55 onap.datatypes.native.apex.EventHandler:
56 derived_from: tosca.datatypes.Root
60 description: Specifies the event handler name, if not specified this is set to the key name
63 type: onap.datatypes.native.apex.CarrierTechnology
64 description: Specifies the carrier technology of the event handler (such as REST/Web Socket/Kafka)
67 type: onap.datatypes.native.apex.EventProtocol
68 description: Specifies the event protocol of events for the event handler (such as Yaml/JSON/XML/POJO)
72 description: Specifies the event name for events on this event handler, if not specified, the event name is read from or written to the event being received or sent
76 description: Specifies a filter as a regular expression, events that do not match the filter are dropped, the default is to let all events through
80 description: Specifies the event handler is syncronous (receive event and send response)
85 description: The peer event handler (output for input or input for output) of this event handler in synchronous mode, this parameter is mandatory if the event handler is in synchronous mode
89 description: The timeout in milliseconds for responses to be issued by APEX torequests, this parameter is mandatory if the event handler is in synchronous mode
93 description: Specifies the event handler is in requestor mode (send event and wait for response mode)
98 description: The peer event handler (output for input or input for output) of this event handler in requestor mode, this parameter is mandatory if the event handler is in requestor mode
102 description: The timeout in milliseconds for wait for responses to requests, this parameter is mandatory if the event handler is in requestor mode
104 onap.datatypes.native.apex.CarrierTechnology:
105 derived_from: tosca.datatypes.Root
109 description: The label (name) of the carrier technology (such as REST, Kafka, WebSocket)
111 plugin_parameter_class_name:
113 description: The class name of the class that overrides default handling of event input or output for this carrier technology, defaults to the supplied input or output class
115 onap.datatypes.native.apex.EventProtocol:
116 derived_from: tosca.datatypes.Root
120 description: The label (name) of the event protocol (such as Yaml, JSON, XML, or POJO)
122 event_protocol_plugin_class:
124 description: The class name of the class that overrides default handling of the event protocol for this carrier technology, defaults to the supplied event protocol class
126 onap.datatypes.native.apex.Environment:
127 derived_from: tosca.datatypes.Root
131 description: The name of the environment variable
135 description: The value of the environment variable
137 onap.datatypes.native.apex.engineservice.Engine:
138 derived_from: tosca.datatypes.Root
141 type: onap.datatypes.native.apex.engineservice.engine.Context
142 description: The properties for handling context in APEX engines, defaults to using Java maps for context
146 description: The plugins for policy executors used in engines such as javascript, MVEL, Jython
149 description: The plugin class path for this policy executor
151 onap.datatypes.native.apex.engineservice.engine.Context:
152 derived_from: tosca.datatypes.Root
155 type: onap.datatypes.native.apex.Plugin
156 description: The plugin to be used for distributing context between APEX PDPs at runtime
160 description: The plugins for context schemas available in APEX PDPs such as Java and Avro
163 type: onap.datatypes.native.apex.Plugin
165 type: onap.datatypes.native.apex.Plugin
166 description: The plugin to be used for locking context in and between APEX PDPs at runtime
169 type: onap.datatypes.native.apex.Plugin
170 description: The plugin to be used for persisting context for APEX PDPs at runtime
172 onap.datatypes.native.apex.Plugin:
173 derived_from: tosca.datatypes.Root
177 description: The name of the executor such as Javascript, Jython or MVEL
181 description: The class path of the plugin class for this executor
184 onap.policies.Native:
185 derived_from: tosca.policies.Root
186 description: a base policy type for all native PDP policies
188 name: onap.policies.Native
189 onap.policies.native.Apex:
190 derived_from: onap.policies.Native
191 description: a policy type for native apex policies
193 name: onap.policies.native.Apex
196 type: onap.datatypes.native.apex.EngineService
197 description: APEX Engine Service Parameters
200 description: Inputs for handling events coming into the APEX engine
202 type: onap.datatypes.native.apex.EventHandler
205 description: Outputs for handling events going out of the APEX engine
207 type: onap.datatypes.native.apex.EventHandler
210 description: Envioronmental parameters for the APEX engine
212 type: onap.datatypes.native.apex.Environment
216 org.onap.policy.clamp.acm.Participant:
218 derived_from: tosca.nodetypes.Root
223 org.onap.policy.clamp.acm.AutomationCompositionElement:
225 derived_from: tosca.nodetypes.Root
232 description: Specifies the organization that provides the automation composition element
237 - greater_or_equal: 0
240 description: A value indicating the start phase in which this automation composition element will be started, the
241 first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
242 in reverse start phase order. Automation Composition Elements with the same start phase are started and
243 stopped simultaneously
244 uninitializedToPassiveTimeout:
248 - greater_or_equal: 0
252 description: The maximum time in seconds to wait for a state chage from uninitialized to passive
253 passiveToRunningTimeout:
257 - greater_or_equal: 0
261 description: The maximum time in seconds to wait for a state chage from passive to running
262 runningToPassiveTimeout:
266 - greater_or_equal: 0
270 description: The maximum time in seconds to wait for a state chage from running to passive
271 passiveToUninitializedTimeout:
275 - greater_or_equal: 0
279 description: The maximum time in seconds to wait for a state chage from passive to uninitialized
280 org.onap.policy.clamp.acm.AutomationComposition:
282 derived_from: tosca.nodetypes.Root
289 description: Specifies the organization that provides the automation composition element
296 type: onap.datatypes.ToscaConceptIdentifier
297 description: Specifies a list of automation composition element definitions that make up this automation composition definition
298 org.onap.policy.clamp.acm.PolicyAutomationCompositionElement:
300 derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
303 type: onap.datatypes.ToscaConceptIdentifier
306 type: onap.datatypes.ToscaConceptIdentifier
313 type: onap.datatypes.ToscaConceptIdentifier
314 description: The ID of the operational policy to use
316 name: onap.policies.native.apex.ac.element
319 org.onap.policy.clamp.acm.PolicyParticipant:
321 type: org.onap.policy.clamp.acm.Participant
323 description: Participant for Policy microservices
326 onap.policy.clamp.ac.element.Policy_AutomationCompositionElement:
328 type: org.onap.policy.clamp.acm.PolicyAutomationCompositionElement
330 description: Automation composition element for the operational policy for Performance Management Subscription Handling
334 name: onap.policies.operational.pm-subscription-handler
338 get_input: acm_element_policy
340 onap.policy.clamp.ac.element.AutomationCompositionDefinition:
342 type: org.onap.policy.clamp.acm.AutomationComposition
344 description: Automation composition for Demp
348 - name: onap.policy.clamp.ac.element.Policy_AutomationCompositionElement
352 - onap.policies.native.apex.ac.element:
353 type: onap.policies.native.Apex
356 engineServiceParameters:
361 deploymentPort: 12561
365 parameterClassName: org.onap.policy.apex.plugins.executor.javascript.JavascriptExecutorParameters
367 parameterClassName: org.onap.policy.apex.context.parameters.ContextParameters
370 parameterClassName: org.onap.policy.apex.plugins.context.schema.json.JsonSchemaHelperParameters
374 name: APEXacElementPolicy_Policies
379 name: ReceiveEventPolicy
383 name: ReceiveEventPolicy
388 - key: DecideForwardingState
391 parentKeyName: ReceiveEventPolicy
392 parentKeyVersion: 0.0.1
393 parentLocalName: 'NULL'
394 localName: DecideForwardingState
400 - key: CreateForwardPayload
403 parentKeyName: ReceiveEventPolicy
404 parentKeyVersion: 0.0.1
405 parentLocalName: DecideForwardingState
406 localName: CreateForwardPayload
408 name: DmaapResponseStatusEvent
410 outgoingEventReference:
411 - name: DmaapResponseStatusEvent
414 parentKeyName: 'NULL'
415 parentKeyVersion: 0.0.0
416 parentLocalName: 'NULL'
418 contextAlbumReference: []
421 parentKeyName: 'NULL'
422 parentKeyVersion: 0.0.0
423 parentLocalName: 'NULL'
425 logicFlavour: UNDEFINED
427 stateFinalizerLogicMap:
430 name: ForwardPayloadTask
435 name: ForwardPayloadTask
439 parentKeyName: ReceiveEventPolicy
440 parentKeyVersion: 0.0.1
441 parentLocalName: DecideForwardingState
442 localName: ReceiveEventPolicy
445 parentKeyName: ReceiveEventPolicy
446 parentKeyVersion: 0.0.1
447 parentLocalName: DecideForwardingState
448 localName: CreateForwardPayload
449 firstState: DecideForwardingState
452 name: APEXacElementPolicy_Tasks
457 name: ForwardPayloadTask
461 name: ForwardPayloadTask
467 nameSpace: org.onap.policy.apex.ac.element
472 - key: DmaapResponseEvent
475 parentKeyName: AcElementEvent
476 parentKeyVersion: 0.0.1
477 parentLocalName: 'NULL'
478 localName: DmaapResponseEvent
483 toscaPolicyState: ENTRY
486 - key: DmaapResponseStatusEvent
489 name: DmaapResponseStatusEvent
491 nameSpace: org.onap.policy.apex.ac.element
496 - key: DmaapResponseStatusEvent
499 parentKeyName: DmaapResponseStatusEvent
500 parentKeyVersion: 0.0.1
501 parentLocalName: 'NULL'
502 localName: DmaapResponseStatusEvent
510 contextAlbumReference:
511 - name: ACElementAlbum
515 parentKeyName: ForwardPayloadTask
516 parentKeyVersion: 0.0.1
517 parentLocalName: 'NULL'
519 logicFlavour: JAVASCRIPT
520 logic: "/*\n * ============LICENSE_START=======================================================\n\
521 \ * Copyright (C) 2022 Nordix. All rights reserved.\n * ================================================================================\n\
522 \ * Licensed under the Apache License, Version 2.0 (the 'License');\n\
523 \ * you may not use this file except in compliance with the\
524 \ License.\n * You may obtain a copy of the License at\n *\n\
525 \ * http://www.apache.org/licenses/LICENSE-2.0\n *\n\
526 \ * Unless required by applicable law or agreed to in writing,\
527 \ software\n * distributed under the License is distributed\
528 \ on an 'AS IS' BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS\
529 \ OF ANY KIND, either express or implied.\n * See the License\
530 \ for the specific language governing permissions and\n *\
531 \ limitations under the License.\n *\n * SPDX-License-Identifier:\
532 \ Apache-2.0\n * ============LICENSE_END=========================================================\n\
533 \ */\n\nexecutor.logger.info(executor.subject.id);\nexecutor.logger.info(executor.inFields);\n\
534 \nvar msgResponse = executor.inFields.get('DmaapResponseEvent');\n\
535 executor.logger.info('Task in progress with mesages: ' + msgResponse);\n\
536 \nvar elementId = msgResponse.get('elementId').get('name');\n\
537 \nif (msgResponse.get('messageType') == 'STATUS' &&\n (elementId\
538 \ == 'onap.policy.clamp.ac.startertobridge'\n || elementId\
539 \ == 'onap.policy.clamp.ac.bridgetosink')) {\n\n var receiverId\
540 \ = '';\n if (elementId == 'onap.policy.clamp.ac.startertobridge')\
541 \ {\n receiverId = 'onap.policy.clamp.ac.bridge';\n\
542 \ } else {\n receiverId = 'onap.policy.clamp.ac.sink';\n\
543 \ }\n\n var elementIdResponse = new java.util.HashMap();\n\
544 \ elementIdResponse.put('name', receiverId);\n elementIdResponse.put('version',\
545 \ msgResponse.get('elementId').get('version'));\n\n var\
546 \ dmaapResponse = new java.util.HashMap();\n dmaapResponse.put('elementId',\
547 \ elementIdResponse);\n\n var message = msgResponse.get('message')\
548 \ + ' trace added from policy';\n dmaapResponse.put('message',\
549 \ message);\n dmaapResponse.put('messageType', 'STATUS');\n\
550 \ dmaapResponse.put('messageId', msgResponse.get('messageId'));\n\
551 \ dmaapResponse.put('timestamp', msgResponse.get('timestamp'));\n\
552 \n executor.logger.info('Sending forwarding Event to Ac\
553 \ element: ' + dmaapResponse);\n\n executor.outFields.put('DmaapResponseStatusEvent',\
554 \ dmaapResponse);\n}\n\ntrue;"
557 name: APEXacElementPolicy_Events
568 nameSpace: org.onap.policy.apex.ac.element
573 - key: DmaapResponseEvent
576 parentKeyName: AcElementEvent
577 parentKeyVersion: 0.0.1
578 parentLocalName: 'NULL'
579 localName: DmaapResponseEvent
584 toscaPolicyState: ENTRY
586 name: DmaapResponseStatusEvent
590 name: DmaapResponseStatusEvent
592 nameSpace: org.onap.policy.apex.ac.element
597 - key: DmaapResponseStatusEvent
600 parentKeyName: DmaapResponseStatusEvent
601 parentKeyVersion: 0.0.1
602 parentLocalName: 'NULL'
603 localName: DmaapResponseStatusEvent
616 nameSpace: org.onap.policy.apex.ac.element
624 parentKeyName: LogEvent
625 parentKeyVersion: 0.0.1
626 parentLocalName: 'NULL'
627 localName: final_status
629 name: SimpleStringType
635 parentKeyName: LogEvent
636 parentKeyVersion: 0.0.1
637 parentLocalName: 'NULL'
640 name: SimpleStringType
646 name: APEXacElementPolicy_Albums
664 name: APEXacElementPolicy_Schemas
676 schemaDefinition: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\
677 ,\n \"type\": \"object\",\n \"properties\": {\n \
678 \ \"elementId\": {\n \"type\": \"object\",\n \
679 \ \"properties\": {\n \"name\": {\n \
680 \ \"type\": \"string\"\n },\n\
681 \ \"version\": {\n \"type\"\
682 : \"string\"\n }\n },\n \
683 \ \"required\": [\n \"name\",\n \
684 \ \"version\"\n ]\n },\n \"message\"\
685 : {\n \"type\": \"string\"\n },\n \"\
686 messageType\": {\n \"type\": \"string\"\n \
687 \ }\n },\n \"required\": [\n \"elementId\",\n \
688 \ \"message\",\n \"messageType\"\n ]\n}"
697 schemaDefinition: java.lang.Integer
699 name: SimpleStringType
703 name: SimpleStringType
706 schemaDefinition: java.lang.String
715 schemaDefinition: java.util.UUID
717 name: APEXacElementPolicy
721 name: APEXacElementPolicy_KeyInfo
732 UUID: 7cddfab8-6d3f-3f7f-8ac3-e2eb5979c900
733 description: Generated description for concept referred to by
734 key "ACElementAlbum:0.0.1"
742 UUID: dab78794-b666-3929-a75b-70d634b04fe5
743 description: Generated description for concept referred to by
744 key "ACEventType:0.0.1"
746 name: APEXacElementPolicy
750 name: APEXacElementPolicy
752 UUID: da478611-7d77-3c46-b4be-be968769ba4e
753 description: Generated description for concept referred to by
754 key "APEXacElementPolicy:0.0.1"
756 name: APEXacElementPolicy_Albums
760 name: APEXacElementPolicy_Albums
762 UUID: fa8dc15e-8c8d-3de3-a0f8-585b76511175
763 description: Generated description for concept referred to by
764 key "APEXacElementPolicy_Albums:0.0.1"
766 name: APEXacElementPolicy_Events
770 name: APEXacElementPolicy_Events
772 UUID: 8508cd65-8dd2-342d-a5c6-1570810dbe2b
773 description: Generated description for concept referred to by
774 key "APEXacElementPolicy_Events:0.0.1"
776 name: APEXacElementPolicy_KeyInfo
780 name: APEXacElementPolicy_KeyInfo
782 UUID: 09e6927d-c5ac-3779-919f-9333994eed22
783 description: Generated description for concept referred to by
784 key "APEXacElementPolicy_KeyInfo:0.0.1"
786 name: APEXacElementPolicy_Policies
790 name: APEXacElementPolicy_Policies
792 UUID: cade3c9a-1600-3642-a6f4-315612187f46
793 description: Generated description for concept referred to by
794 key "APEXacElementPolicy_Policies:0.0.1"
796 name: APEXacElementPolicy_Schemas
800 name: APEXacElementPolicy_Schemas
802 UUID: 5bb4a8e9-35fa-37db-9a49-48ef036a7ba9
803 description: Generated description for concept referred to by
804 key "APEXacElementPolicy_Schemas:0.0.1"
806 name: APEXacElementPolicy_Tasks
810 name: APEXacElementPolicy_Tasks
812 UUID: 2527eeec-0d1f-3094-ad3f-212622b12836
813 description: Generated description for concept referred to by
814 key "APEXacElementPolicy_Tasks:0.0.1"
822 UUID: 32c013e2-2740-3986-a626-cbdf665b63e9
823 description: Generated description for concept referred to by
824 key "AcElementEvent:0.0.1"
826 name: DmaapResponseStatusEvent
830 name: DmaapResponseStatusEvent
832 UUID: 2715cb6c-2778-3461-8b69-871e79f95935
833 description: Generated description for concept referred to by
834 key "DmaapResponseStatusEvent:0.0.1"
836 name: ForwardPayloadTask
840 name: ForwardPayloadTask
842 UUID: 51defa03-1ecf-3314-bf34-2a652bce57fa
843 description: Generated description for concept referred to by
844 key "ForwardPayloadTask:0.0.1"
852 UUID: c540f048-96af-35e3-a36e-e9c29377cba7
853 description: Generated description for concept referred to by
856 name: ReceiveEventPolicy
860 name: ReceiveEventPolicy
862 UUID: 568b7345-9de1-36d3-b6a3-9b857e6809a1
863 description: Generated description for concept referred to by
864 key "ReceiveEventPolicy:0.0.1"
872 UUID: 153791fd-ae0a-36a7-88a5-309a7936415d
873 description: Generated description for concept referred to by
874 key "SimpleIntType:0.0.1"
876 name: SimpleStringType
880 name: SimpleStringType
882 UUID: 8a4957cf-9493-3a76-8c22-a208e23259af
883 description: Generated description for concept referred to by
884 key "SimpleStringType:0.0.1"
892 UUID: 6a8cc68e-dfc8-3403-9c6d-071c886b319c
893 description: Generated description for concept referred to by
895 eventInputParameters:
897 carrierTechnologyParameters:
898 carrierTechnology: RESTCLIENT
899 parameterClassName: org.onap.policy.apex.plugins.event.carrier.restclient.RestClientCarrierTechnologyParameters
901 url: http://message-router:3904/events/AC_ELEMENT_MSG/APEX/1?timeout=30000
902 eventProtocolParameters:
905 pojoField: DmaapResponseEvent
906 eventName: AcElementEvent
907 eventNameFilter: AcElementEvent
908 eventOutputParameters:
910 carrierTechnologyParameters:
911 carrierTechnology: FILE
913 fileName: outputevents.log
914 eventProtocolParameters:
917 carrierTechnologyParameters:
918 carrierTechnology: RESTCLIENT
919 parameterClassName: org.onap.policy.apex.plugins.event.carrier.restclient.RestClientCarrierTechnologyParameters
921 url: http://message-router:3904/events/POLICY_UPDATE_MSG
922 eventProtocolParameters:
925 pojoField: DmaapResponseStatusEvent
926 eventNameFilter: (LogEvent|DmaapResponseStatusEvent)
927 name: onap.policies.native.apex.ac.element