1 tosca_definitions_version: tosca_simple_yaml_1_0_0
4 derived_from: tosca.policies.Root
5 description: a base policy type for all native PDP policies
7 onap.policies.native.Apex:
8 derived_from: onap.policies.Native
9 description: a policy type for native apex policies
13 type: onap.datatypes.native.apex.EngineService
14 description: APEX Engine Service Parameters
17 description: Inputs for handling events coming into the APEX engine
19 type: onap.datatypes.native.apex.EventHandler
22 description: Outputs for handling events going out of the APEX engine
24 type: onap.datatypes.native.apex.EventHandler
27 description: Envioronmental parameters for the APEX engine
29 type: onap.datatypes.native.apex.Environment
32 onap.datatypes.native.apex.EngineService:
33 derived_from: tosca.datatypes.Root
37 description: Specifies the engine name
39 default: "ApexEngineService"
42 description: Specifies the engine version in double dotted format
47 description: Specifies the engine id
51 description: Specifies the number of engine threads that should be run
55 description: Specifies the port to connect to for engine administration
58 policy_model_file_name:
60 description: The name of the file from which to read the APEX policy model
64 description: The policy type implementation from which to read the APEX policy model
66 periodic_event_period:
68 description: The time interval in milliseconds for the periodic scanning event, 0 means don't scan
71 type: onap.datatypes.native.apex.engineservice.Engine
72 description: The parameters for all engines in the APEX engine service
74 onap.datatypes.native.apex.EventHandler:
75 derived_from: tosca.datatypes.Root
79 description: Specifies the event handler name, if not specified this is set to the key name
82 type: onap.datatypes.native.apex.CarrierTechnology
83 description: Specifies the carrier technology of the event handler (such as REST/Web Socket/Kafka)
86 type: onap.datatypes.native.apex.EventProtocol
87 description: Specifies the event protocol of events for the event handler (such as Yaml/JSON/XML/POJO)
91 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
95 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
99 description: Specifies the event handler is syncronous (receive event and send response)
104 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
108 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
112 description: Specifies the event handler is in requestor mode (send event and wait for response mode)
117 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
121 description: The timeout in milliseconds for wait for responses to requests, this parameter is mandatory if the event handler is in requestor mode
123 onap.datatypes.native.apex.CarrierTechnology:
124 derived_from: tosca.datatypes.Root
128 description: The label (name) of the carrier technology (such as REST, Kafka, WebSocket)
130 plugin_parameter_class_name:
132 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
134 onap.datatypes.native.apex.EventProtocol:
135 derived_from: tosca.datatypes.Root
139 description: The label (name) of the event protocol (such as Yaml, JSON, XML, or POJO)
141 event_protocol_plugin_class:
143 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
145 onap.datatypes.native.apex.Environment:
146 derived_from: tosca.datatypes.Root
150 description: The name of the environment variable
154 description: The value of the environment variable
156 onap.datatypes.native.apex.engineservice.Engine:
157 derived_from: tosca.datatypes.Root
160 type: onap.datatypes.native.apex.engineservice.engine.Context
161 description: The properties for handling context in APEX engines, defaults to using Java maps for context
165 description: The plugins for policy executors used in engines such as javascript, MVEL, Jython
168 description: The plugin class path for this policy executor
170 onap.datatypes.native.apex.engineservice.engine.Context:
171 derived_from: tosca.datatypes.Root
174 type: onap.datatypes.native.apex.Plugin
175 description: The plugin to be used for distributing context between APEX PDPs at runtime
179 description: The plugins for context schemas available in APEX PDPs such as Java and Avro
182 type: onap.datatypes.native.apex.Plugin
184 type: onap.datatypes.native.apex.Plugin
185 description: The plugin to be used for locking context in and between APEX PDPs at runtime
188 type: onap.datatypes.native.apex.Plugin
189 description: The plugin to be used for persisting context for APEX PDPs at runtime
191 onap.datatypes.native.apex.Plugin:
192 derived_from: tosca.datatypes.Root
196 description: The name of the executor such as Javascript, Jython or MVEL
200 description: The class path of the plugin class for this executor