Package com.tibco.ep.tcs.runtime.config

Interface ICustomAdapterConfigProducer

public interface ICustomAdapterConfigProducer

An interface describing conversion of a HOCON block configuration to the information required to instantiate an EventFlow custom operator or adapter. The producer interface provides:

• Validation that a particular configuration schema can be processed by this producer.
• A map of adapter properties and associated values.
• A set of input port descriptions, each with an optional tuple schema hint.
• A set of output port descriptions.

Method Summary

Modifier and Type	Method	Description
boolean	canProcessConfigurationsFor(String schemaURL)	Return true if this producer can process configurations that conform to the specified JSON schema, false otherwise.
Map<String,String>	getEventFlowAdapterProperties(com.typesafe.config.Config config)	Produce the adapter properties.
Map<String,DataInputPortConfig>	getInputPorts(com.typesafe.config.Config config, TupleSchemaFactory tupleSchemaFactory, FlowValidationProblemList problems)	Produce input port descriptions.
Map<String,DataOutputPortConfig>	getOutputPorts(com.typesafe.config.Config config)	Produce output port descriptions.

Method Detail

canProcessConfigurationsFor

boolean canProcessConfigurationsFor(String schemaURL)

Return true if this producer can process configurations that conform to the specified JSON schema, false otherwise.

Parameters:

schemaURL - schema to check

Returns:

true or false as described above

getEventFlowAdapterProperties

Map<String,String> getEventFlowAdapterProperties(com.typesafe.config.Config config)

Produce the adapter properties.

Parameters:

config - instance configuration to process

Returns:

EventFlow adapter properties

getInputPorts

Map<String,DataInputPortConfig> getInputPorts(com.typesafe.config.Config config,
                                                    TupleSchemaFactory tupleSchemaFactory,
                                                    FlowValidationProblemList problems)

Produce input port descriptions. The result is an associative array of port descriptions, indexed by port name.

Parameters:

config - instance configuration to process

tupleSchemaFactory - used to create optional EventFlow tuple schemas associated with the input ports

problems - container for any problems encountered while creating tuple schemas

Returns:

input port descriptions

getOutputPorts

Map<String,DataOutputPortConfig> getOutputPorts(com.typesafe.config.Config config)

Produce output port descriptions. The result is an associative array of port descriptions, indexed by port name.

Parameters:

config - instance configuration to process

Returns:

output port descriptions