Package io.confluent.kafka.schemaregistry.rules

Class RuleContext

java.lang.Object

io.confluent.kafka.schemaregistry.rules.RuleContext

public class RuleContext
extends Object

A rule context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RuleContext.FieldContext
static enum	RuleContext.Type

Constructor Summary

Constructors

Constructor	Description
RuleContext(Map<String,?> configs, ExecutionEnvironment enabledEnv, ParsedSchema source, ParsedSchema target, String subject, String topic, org.apache.kafka.common.header.Headers headers, Object originalKey, Object originalValue, boolean isKey, RuleMode ruleMode, Rule rule, int index, List<Rule> rules, boolean includeRuleResults)

Method Summary

Modifier and Type	Method	Description
Map<String,?>	configs()
RuleContext.FieldContext	currentField()
Map<Object,Object>	customData()
static boolean	disjoint(Set<String> set1, Set<String> set2)
ExecutionEnvironment	enabledEnv()
RuleContext.FieldContext	enterField(Object containingMessage, String fullName, String name, RuleContext.Type type, Set<String> tags)
Map<String,Map<String,String>>	fieldMetadata()	Live view of per-field metadata collected so far, keyed by field path.
String	getParameter(String name)
Set<String>	getTags(String fullName)
org.apache.kafka.common.header.Headers	headers()
int	index()
boolean	isKey()
Map<String,String>	messageMetadata()	Live view of message-level metadata collected so far.
Object	originalKey()
Object	originalValue()
void	putFieldMetadata(String fieldPath, String key, String value)	Record a per-field metadata key/value for this rule's execution.
void	putMessageMetadata(String key, String value)	Record a message-level metadata key/value for this rule's execution.
Rule	rule()
RuleMode	ruleMode()
List<Rule>	rules()
ParsedSchema	source()
String	subject()
ParsedSchema	target()
String	topic()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RuleContext

public RuleContext(Map<String,?> configs,
 ExecutionEnvironment enabledEnv,
 ParsedSchema source,
 ParsedSchema target,
 String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 Object originalKey,
 Object originalValue,
 boolean isKey,
 RuleMode ruleMode,
 Rule rule,
 int index,
 List<Rule> rules,
 boolean includeRuleResults)

Method Details

configs

public Map<String,?> configs()

enabledEnv

public ExecutionEnvironment enabledEnv()

source

public ParsedSchema source()

target

public ParsedSchema target()

subject

public String subject()

topic

public String topic()

headers

public org.apache.kafka.common.header.Headers headers()

originalKey

public Object originalKey()

originalValue

public Object originalValue()

isKey

public boolean isKey()

ruleMode

public RuleMode ruleMode()

rule

public Rule rule()

index

public int index()

rules

public List<Rule> rules()

customData

public Map<Object,Object> customData()

putMessageMetadata

public void putMessageMetadata(String key,
 String value)

Record a message-level metadata key/value for this rule's execution. When the enclosing deserialize call did not opt into rule-result collection, or when value is null, the key is not stored. Consumers can rely on key presence to mean "value known".

putFieldMetadata

public void putFieldMetadata(String fieldPath,
 String key,
 String value)

Record a per-field metadata key/value for this rule's execution. When the enclosing deserialize call did not opt into rule-result collection, or when value is null, the key is not stored.

messageMetadata

public Map<String,String> messageMetadata()

Live view of message-level metadata collected so far.

fieldMetadata

public Map<String,Map<String,String>> fieldMetadata()

Live view of per-field metadata collected so far, keyed by field path.

getTags

public Set<String> getTags(String fullName)

getParameter

public String getParameter(String name)

currentField

public RuleContext.FieldContext currentField()

enterField

public RuleContext.FieldContext enterField(Object containingMessage,
 String fullName,
 String name,
 RuleContext.Type type,
 Set<String> tags)

disjoint

public static boolean disjoint(Set<String> set1,
 Set<String> set2)