1 tosca_definitions_version: tosca_simple_yaml_1_1_0
4 derived_from: tosca.policies.Root
5 description: a base policy type for all native PDP policies
7 name: onap.policies.Native
8 onap.policies.native.Apex:
9 derived_from: onap.policies.Native
10 description: a policy type for native apex policies
12 name: onap.policies.native.Apex
15 type: onap.datatypes.native.apex.EngineService
16 description: APEX Engine Service Parameters
19 description: Inputs for handling events coming into the APEX engine
21 type: onap.datatypes.native.apex.EventHandler
24 description: Outputs for handling events going out of the APEX engine
26 type: onap.datatypes.native.apex.EventHandler
29 description: Envioronmental parameters for the APEX engine
31 type: onap.datatypes.native.apex.Environment
34 onap.datatypes.native.apex.EngineService:
35 derived_from: tosca.datatypes.Root
39 description: Specifies the engine name
41 default: "ApexEngineService"
44 description: Specifies the engine version in double dotted format
49 description: Specifies the engine id
53 description: Specifies the number of engine threads that should be run
57 description: Specifies the port to connect to for engine administration
60 policy_model_file_name:
62 description: The name of the file from which to read the APEX policy model
66 description: The policy type implementation from which to read the APEX policy model
68 periodic_event_period:
70 description: The time interval in milliseconds for the periodic scanning event, 0 means don't scan
73 type: onap.datatypes.native.apex.engineservice.Engine
74 description: The parameters for all engines in the APEX engine service
76 onap.datatypes.native.apex.EventHandler:
77 derived_from: tosca.datatypes.Root
81 description: Specifies the event handler name, if not specified this is set to the key name
84 type: onap.datatypes.native.apex.CarrierTechnology
85 description: Specifies the carrier technology of the event handler (such as REST/Web Socket/Kafka)
88 type: onap.datatypes.native.apex.EventProtocol
89 description: Specifies the event protocol of events for the event handler (such as Yaml/JSON/XML/POJO)
93 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
97 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
101 description: Specifies the event handler is syncronous (receive event and send response)
106 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
110 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
114 description: Specifies the event handler is in requestor mode (send event and wait for response mode)
119 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
123 description: The timeout in milliseconds for wait for responses to requests, this parameter is mandatory if the event handler is in requestor mode
125 onap.datatypes.native.apex.CarrierTechnology:
126 derived_from: tosca.datatypes.Root
130 description: The label (name) of the carrier technology (such as REST, Kafka, WebSocket)
132 plugin_parameter_class_name:
134 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
136 onap.datatypes.native.apex.EventProtocol:
137 derived_from: tosca.datatypes.Root
141 description: The label (name) of the event protocol (such as Yaml, JSON, XML, or POJO)
143 event_protocol_plugin_class:
145 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
147 onap.datatypes.native.apex.Environment:
148 derived_from: tosca.datatypes.Root
152 description: The name of the environment variable
156 description: The value of the environment variable
158 onap.datatypes.native.apex.engineservice.Engine:
159 derived_from: tosca.datatypes.Root
162 type: onap.datatypes.native.apex.engineservice.engine.Context
163 description: The properties for handling context in APEX engines, defaults to using Java maps for context
167 description: The plugins for policy executors used in engines such as javascript, MVEL, Jython
170 description: The plugin class path for this policy executor
172 onap.datatypes.native.apex.engineservice.engine.Context:
173 derived_from: tosca.datatypes.Root
176 type: onap.datatypes.native.apex.Plugin
177 description: The plugin to be used for distributing context between APEX PDPs at runtime
181 description: The plugins for context schemas available in APEX PDPs such as Java and Avro
184 type: onap.datatypes.native.apex.Plugin
186 type: onap.datatypes.native.apex.Plugin
187 description: The plugin to be used for locking context in and between APEX PDPs at runtime
190 type: onap.datatypes.native.apex.Plugin
191 description: The plugin to be used for persisting context for APEX PDPs at runtime
193 onap.datatypes.native.apex.Plugin:
194 derived_from: tosca.datatypes.Root
198 description: The name of the executor such as Javascript, Jython or MVEL
202 description: The class path of the plugin class for this executor