}, which is how the users would address it in InstanceIdentifier terms.
* The implicit assumption being made is that {@code Baz} identifies a particular instantiation and hence provides
* unambiguous reference to an effective schema statement.
*
*
* Unfortunately this does not quite work with groupings, as their generation has changed: we do not have interfaces
* that would capture grouping instantiations, hence we do not have a proper addressing point and users need to specify
* the interfaces generated in the grouping's definition. These can be very much ambiguous, as a {@code grouping} can be
* used in multiple modules independently within an {@code augment} targeting {@code choice}, as each instantiation is
* guaranteed to have a unique namespace -- but we do not have the appropriate instantiations of those nodes.
*
*
* To address this issue we have a two-class lookup mechanism, which relies on the interface generated for the
* {@code case} statement to act as the namespace anchor bridging the nodes inside the grouping to the namespace in
* which they are instantiated.
*
*
* Furthermore downstream code relies on historical mechanics, which would guess what the instantiation is, silently
* assuming the ambiguity is theoretical and does not occur in practice.
*
*
* This leads to three classes of addressing, in order descending performance requirements.
*
* - Direct DataObject, where we name an exact child
* - Case DataObject + Grouping DataObject
* - Grouping DataObject, which is ambiguous
*
*
* {@link #byCaseChildClass} supports direct DataObject mapping and contains only unambiguous children, while
* {@link #byClass} supports indirect mapping and contains {@code case} sub-statements.
*
* {@link #ambiguousByCaseChildClass} contains ambiguous mappings, for which we end up issuing warnings. We track each
* ambiguous reference and issue warn once when they are encountered -- tracking warning information in
* {@link #ambiguousByCaseChildWarnings}.
*/
final class ChoiceCodecContext extends CommonDataObjectCodecContext
implements BindingDataObjectCodecTreeNode {
private static final Logger LOG = LoggerFactory.getLogger(ChoiceCodecContext.class);
private final ImmutableListMultimap, CommonDataObjectCodecPrototype> ambiguousByCaseChildClass;
private final ImmutableMap, CommonDataObjectCodecPrototype> byCaseChildClass;
private final ImmutableMap byYangCaseChild;
private final ImmutableMap, CommonDataObjectCodecPrototype> byClass;
private final Set> ambiguousByCaseChildWarnings;
ChoiceCodecContext(final Class cls, final ChoiceRuntimeType type, final CodecContextFactory factory) {
this(new ChoiceCodecPrototype(Item.of(cls), type, factory));
}
ChoiceCodecContext(final ChoiceCodecPrototype prototype) {
super(prototype);
final var byYangCaseChildBuilder = new HashMap();
final var byClassBuilder = new HashMap, CommonDataObjectCodecPrototype>();
final var childToCase = SetMultimapBuilder.hashKeys().hashSetValues()
., CommonDataObjectCodecPrototype>build();
// Load case statements valid in this choice and keep track of their names
final var choiceType = prototype.runtimeType();
final var factory = prototype.contextFactory();
final var localCases = new HashSet();
for (var caseType : choiceType.validCaseChildren()) {
@SuppressWarnings("unchecked")
final var caseClass = (Class) loadCase(factory.getRuntimeContext(), caseType);
final var caseProto = new CaseCodecPrototype(caseClass, caseType, factory);
localCases.add(caseType.getIdentifier());
byClassBuilder.put(caseClass, caseProto);
// Updates collection of case children
for (var cazeChild : getChildrenClasses(caseClass)) {
childToCase.put(cazeChild, caseProto);
}
// Updates collection of YANG instance identifier to case
for (var stmt : caseType.statement().effectiveSubstatements()) {
if (stmt instanceof DataSchemaNode cazeChild) {
byYangCaseChildBuilder.put(NodeIdentifier.create(cazeChild.getQName()), caseProto);
}
}
}
byYangCaseChild = ImmutableMap.copyOf(byYangCaseChildBuilder);
// Move unambiguous child->case mappings to byCaseChildClass, removing them from childToCase
final var ambiguousByCaseBuilder = ImmutableListMultimap., CommonDataObjectCodecPrototype>builder();
final var unambiguousByCaseBuilder = ImmutableMap., CommonDataObjectCodecPrototype>builder();
for (var entry : Multimaps.asMap(childToCase).entrySet()) {
final var cases = entry.getValue();
if (cases.size() != 1) {
// Sort all possibilities by their FQCN to retain semi-predictable results
final var list = new ArrayList<>(entry.getValue());
list.sort(Comparator.comparing(proto -> proto.javaClass().getCanonicalName()));
ambiguousByCaseBuilder.putAll(entry.getKey(), list);
} else {
unambiguousByCaseBuilder.put(entry.getKey(), cases.iterator().next());
}
}
byCaseChildClass = unambiguousByCaseBuilder.build();
// Setup ambiguous tracking, if needed
ambiguousByCaseChildClass = ambiguousByCaseBuilder.build();
ambiguousByCaseChildWarnings = ambiguousByCaseChildClass.isEmpty() ? ImmutableSet.of()
: ConcurrentHashMap.newKeySet();
/*
* Choice/Case mapping across groupings is compile-time unsafe and we therefore need to also track any
* CaseRuntimeTypes added to the choice in other contexts. This is necessary to discover when a case represents
* equivalent data in a different instantiation context.
*
* This is required due property of binding specification, that if choice is in grouping schema path location is
* lost, and users may use incorrect case class using copy builders.
*/
final var bySubstitutionBuilder = new HashMap, CommonDataObjectCodecPrototype>();
final var context = factory.getRuntimeContext();
for (var caseType : context.getTypes().allCaseChildren(choiceType)) {
final var caseName = caseType.getIdentifier();
if (!localCases.contains(caseName)) {
// FIXME: do not rely on class loading here, the check we are performing should be possible on
// GeneratedType only -- or it can be provided by BindingRuntimeTypes -- i.e. rather than
// 'allCaseChildren()' it would calculate additional mappings we can use off-the-bat.
final var substitution = loadCase(context, caseType);
search: for (var real : byClassBuilder.entrySet()) {
if (isSubstitutionFor(substitution, real.getKey())) {
bySubstitutionBuilder.put(substitution, real.getValue());
break search;
}
}
}
}
byClassBuilder.putAll(bySubstitutionBuilder);
byClass = ImmutableMap.copyOf(byClassBuilder);
}
private static Class loadCase(final BindingRuntimeContext context, final CaseRuntimeType caseType) {
final var className = caseType.getIdentifier();
try {
return context.loadClass(className);
} catch (ClassNotFoundException e) {
throw new LinkageError("Failed to load class for " + className, e);
}
}
@Override
public WithStatus getSchema() {
// FIXME: Bad cast, we should be returning an EffectiveStatement perhaps?
return (WithStatus) type().statement();
}
@Override
CommonDataObjectCodecPrototype streamChildPrototype(final Class childClass) {
return byClass.get(childClass);
}
Iterable> getCaseChildrenClasses() {
return Iterables.concat(byCaseChildClass.keySet(), ambiguousByCaseChildClass.keySet());
}
@Override
public CodecContext yangPathArgumentChild(final YangInstanceIdentifier.PathArgument arg) {
return ((CaseCodecContext) super.yangPathArgumentChild(arg)).yangPathArgumentChild(arg);
}
@Override
CaseCodecPrototype yangChildSupplier(final NodeIdentifier arg) {
return byYangCaseChild.get(arg);
}
@Override
@SuppressWarnings("unchecked")
@SuppressFBWarnings(value = "NP_NONNULL_RETURN_VIOLATION", justification = "See FIXME below")
public D deserialize(final NormalizedNode data) {
final var casted = checkDataArgument(ChoiceNode.class, data);
final var first = Iterables.getFirst(casted.body(), null);
if (first == null) {
// FIXME: this needs to be sorted out
return null;
}
final var caze = byYangCaseChild.get(first.name());
return ((CaseCodecContext) caze.getCodecContext()).deserialize(data);
}
@Override
public NormalizedNode serialize(final D data) {
return serializeImpl(data);
}
@Override
protected Object deserializeObject(final NormalizedNode normalizedNode) {
return deserialize(normalizedNode);
}
@Override
public PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
checkArgument(getDomPathArgument().equals(arg));
return null;
}
@Override
public YangInstanceIdentifier.PathArgument serializePathArgument(final PathArgument arg) {
// FIXME: check for null, since binding container is null.
return getDomPathArgument();
}
@Override
public BindingNormalizedNodeCachingCodec createCachingCodec(
final ImmutableCollection> cacheSpecifier) {
return createCachingCodec(this, cacheSpecifier);
}
DataContainerCodecContext getCaseByChildClass(final @NonNull Class type) {
var result = byCaseChildClass.get(type);
if (result == null) {
// We have not found an unambiguous result, try ambiguous ones
final var inexact = ambiguousByCaseChildClass.get(type);
if (!inexact.isEmpty()) {
result = inexact.get(0);
// Issue a warning, but only once so as not to flood the logs
if (ambiguousByCaseChildWarnings.add(type)) {
LOG.warn("""
Ambiguous reference {} to child of {} resolved to {}, the first case in {} This mapping is \
not guaranteed to be stable and is subject to variations based on runtime circumstances. \
Please see the stack trace for hints about the source of ambiguity.""",
type, bindingArg(), result.javaClass(),
Lists.transform(inexact, CommonDataObjectCodecPrototype::javaClass), new Throwable());
}
}
}
return childNonNull(result, type, "Class %s is not child of any cases for %s", type, bindingArg())
.getCodecContext();
}
/**
* Scans supplied class and returns an iterable of all data children classes.
*
* @param type
* YANG Modeled Entity derived from DataContainer
* @return Iterable of all data children, which have YANG modeled entity
*/
// FIXME: MDSAL-780: replace use of this method
@SuppressWarnings("unchecked")
private static Iterable> getChildrenClasses(final Class type) {
checkArgument(type != null, "Target type must not be null");
checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
final var ret = new LinkedList>();
for (var method : type.getMethods()) {
DataContainerAnalysis.getYangModeledReturnType(method, Naming.GETTER_PREFIX)
.ifPresent(entity -> ret.add((Class) entity));
}
return ret;
}
}