org.mule.metadata.api.annotation

Interface AnnotationsRegistry

public interface AnnotationsRegistry

Interface to be implemented to extend the functionality of MetadataType serialization. The implementation of this class is highly recommended when using custom TypeAnnotations in a MetadataType description to be able to create more human readable serialization output. This implementations will be located using SPI.

The purpose of this registry is to provide a mapping between a "friendly name" (TypeAnnotation.getName()) and the correspondent concrete class (TypeAnnotation#getClass()), this allows to the serialization to write a more compact and easy to read name, instead of using the full qualifier name of the concrete class.

Using this mapping the serialization goes from:

{"org.mule.metadata.api.annotation.TypeIdAnnotation":"java.lang.String"}

To:

{"typeId":"java.lang.String"}

By default the MetadataType serialization will provide mappings for out of the box TypeAnnotation implementations as TypeIdAnnotation, LabelAnnotation, etc. To contribute to the MetadataType's TypeAnnotation serialization, follow this steps steps:

1. Create an implementation of AnnotationsRegistry which must return a Map of String and Class that extends from TypeAnnotation
2. Create a file with org.mule.metadata.api.annotation.AnnotationsRegistry located a META-INF/services/
3. Complete fill the file with the full qualifier name of your AnnotationsRegistry implementation

Considerations:

1. The name used as Key of the map for a class, should be the same in TypeAnnotation.getName()
2. If a mapping is not found for a given TypeAnnotation the full qualifier name will be used
3. If a mapping tries to use a taken name from an already provided TypeAnnotation implementation, the serialization will fail
4. If the class defined for a TypeAnnotation implementation is not found in the in the ClassLoader, the deserialization of this object will be ignored.
5. If many AnnotationsRegistry are found, all mappings will be merged

Method Summary

Modifier and Type	Method and Description
Map<String,Class<? extends TypeAnnotation>>	getRegistry()

Method Detail

getRegistry

Map<String,Class<? extends TypeAnnotation>> getRegistry()