org.mule.devkit.generation.spring.beans.global.util

Interface GlobalElementBeanDefinitionParserResolver

public interface GlobalElementBeanDefinitionParserResolver

Resolver for global elements to be used along with org.mule.devkit.generation.spring.beans.AbstractBeanDefinitionParsersGenerator#generateConfigBeanDefinitionParserFor(Module, GlobalElementBeanDefinitionParserResolver).

Method Summary

Methods

Modifier and Type	Method and Description
void	generatePostBeanDefinition(GeneratedMethod parseMethod, GeneratedVariable elementParam, GeneratedVariable parserContextParam, GeneratedVariable builder, GeneratedVariable definition)
void	generatePostBuilder(Module module, GeneratedClass moduleObject, GeneratedMethod parseMethod, GeneratedVariable elementParam, GeneratedVariable parserContextParam, GeneratedVariable builder) This method will be called to fill the builder parameter with the concrete values of the concrete implementation, that will vary for each custom scenario.
GeneratedExpression	getClassForBeanDefinitionBuilder(Module module, GeneratedClass moduleObject)
String	getConfigElementName(Module module)
GeneratedClass	resolveConfigBeanDefinitionParserClass(Module module)
GeneratedClass	resolveModuleObject(Module module) Returns the module object that represents the bean object that the bean definition parser is going to use.

Method Detail

getConfigElementName

String getConfigElementName(Module module)

Parameters:

module -

Returns:

the global element name of the module to work with. This usually means "config" or "config-with-oauth", but it should depend on the connectors' developers customization

resolveModuleObject

GeneratedClass resolveModuleObject(Module module)

Returns the module object that represents the bean object that the bean definition parser is going to use. Example: 1) if the connector supports connection manager, then the return type should be the manager. 2) If the connector uses OAuth2, then the return type should be the manager for oauth2. 3) If the connector does not supports any strategy at all, then the return type would be the adapter of the connector. Keep in mind that this class will not be the same as the returned by resolveConfigBeanDefinitionParserClass(Module).

Parameters:

module - the module to work with

Returns:

the generated class that holds the bean object.

resolveConfigBeanDefinitionParserClass

GeneratedClass resolveConfigBeanDefinitionParserClass(Module module)

Parameters:

module - the module to work with

Returns:

the generated class that will be responsible for parsing the element hooked by the getConfigElementName(Module).

generatePostBuilder

void generatePostBuilder(Module module,
                       GeneratedClass moduleObject,
                       GeneratedMethod parseMethod,
                       GeneratedVariable elementParam,
                       GeneratedVariable parserContextParam,
                       GeneratedVariable builder)

This method will be called to fill the builder parameter with the concrete values of the concrete implementation, that will vary for each custom scenario.

Parameters:

module - the module to work with

moduleObject - the element generated by the resolveModuleObject(Module)

parseMethod - body of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

elementParam - element parameter of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

parserContextParam - parserContext parameter of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

builder - concrete BeanDefinitionBuilder to work with (e.g.: filling the values into the definition element)

generatePostBeanDefinition

void generatePostBeanDefinition(GeneratedMethod parseMethod,
                              GeneratedVariable elementParam,
                              GeneratedVariable parserContextParam,
                              GeneratedVariable builder,
                              GeneratedVariable definition)

Parameters:

parseMethod - body of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

elementParam - element parameter of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

parserContextParam - parserContext parameter of the generated method BeanDefinitionParser.parse(org.w3c.dom.Element, org.springframework.beans.factory.xml.ParserContext)

builder - concrete BeanDefinitionBuilder to work with (e.g.: filling the values into the definition element)

definition - concrete BeanDefinition to work with

getClassForBeanDefinitionBuilder

GeneratedExpression getClassForBeanDefinitionBuilder(Module module,
                                                   GeneratedClass moduleObject)

Parameters:

module - the module to work with

moduleObject - the element generated by the resolveModuleObject(Module)

Returns:

a concrete class that will be used in the generated "getBeanDefinitionBuilder()" method, where depending on the case it could be just an adapter class, or a manager. This reference will be encapsulated in the method trying to avoid the types of ClassNotFoundException