All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.mule-module.xsd Maven / Gradle / Ivy




    
    

    
        
            
                Root element of a module that contains either properties, operations, or mule global elements as child.
            
        
    

    
        
            
                An operation that will be exposed by the module, it behaves like a function as it has a set of input parameters and a single output
            
        
    

    
        
            
                
                    
                        
                            
                                Set of parameters that wil be used to feed a new event, that will be passed through the scope defined by the body
                            
                        
                        
                            
                                
                            
                        
                    
                    
                        
                            
                                Collection of message processors that can be callable from a scope.
                            
                        
                        
                            
                                
                            
                        
                    
                    
                    
                    
                        
                            
                                Collection of errors that might be thrown by the current operation.
                            
                        
                        
                            
                                
                            
                        
                    
                
                
                    
                        
                            Every operation must be named so that it can be called in a mule application.
                        
                    
                
                
                    
                        
                            Display name of the operation. It can be any string. When empty, it will default to an auto generated one from the name attribute.
                        
                    
                
                
                    
                        
                            A very brief overview about this operation.
                        
                    
                
                
                    
                        
                            An example about the content of this operation.
                        
                    
                
            
        
    

    
        
            
                Defined error for the current operation.
            
        
    

    
        
            
                
            
        
    

    
        
            
                A parameter element defines an input value for the operation in which it is define. Such parameter must be defined with a meaningful name, a type which defines the kind of content the parameter must have and optionally a default value that will be used if the invocation to the operation does not defines a value for the parameter. The parameter can be accessed within the body definition of the operation using an expression such as #[mel: param.paramName]
            
        
    

    
        
            
                
                
                
                
                
                
                
                
                
                
                
            
        
    

    
        
            
                Defines the output of the operation if exists, void otherwise.
            
        
    

    
        
            
                
            
        
    

    
        
            
                Defines the attribute's output of the operation if exists, void otherwise.
            
        
    

    
        
            
                
            
        
    

    
        
            
                A property element defines an input value for the operation in which it is define. Such property must be defined with a meaningful name, a type which defines the kind of content the property must have and optionally a default value that will be used if the invocation to the operation does not defines a value for the property. The property can be accessed within the body definition of the operation using an expression such as #[mel: property.paramName]
            
        
    

    
        
            
                
                
                
                
                
                
                
                
                
                
            
        
    

    
        
            
                A module is defined by three types of elements: properties, global elements and operations.
            
        
        
            
                
                    
                        
                        
                        
                        
                            
                                
                                    Any global element that can be used in a mule application must be able to put within a module.
                                
                            
                        
                    
                
                
                    
                        
                            Name of the module that identifies it.
                        
                    
                
                
                    
                        
                            Expected category of the module.
                        
                    
                
                
                    
                        
                            Expected vendor of the module.
                        
                    
                
                
                    
                        
                            The required entitlement in the customer module license.
                        
                    
                
                
                    
                        
                            If the module can be run with an evaluation license.
                        
                    
                
                
                
                    
                        
                            Expected namespace of the module to look for when generating the schemas. If left empty it will
                            default to http://www.mulesoft.org/schema/mule/[prefix], where [prefix] is the attribute prefix attribute value.
                        
                    
                
                
                    
                        
                            Expected prefix of the module to look for when generating the schemas. If left empty it will create a
                            default one based on the extension's name, removing the words "extension", "module" or "connector" at
                            the end if they are present and hyphenizing the resulting name.
                        
                    
                
            
        
    

    
        
            
                Set of defined categories for a module.
            
        
        
            
            
            
            
        
    

    
        
            
                Set of defined roles for a given parameter.
                BEHAVIOUR will render attributes;
                CONTENT implies support for DataWeave in place;
                PRIMARY works similarly to CONTENT although it also implies it will map to the payload
            
        
        
            
            
            
        
    

    
        
            
                Set of defined uses for a given property/parameter.
                REQUIRED implies the property/parameter must be present. It can not be REQUIRED if the parameter/property has a defaultValue;
                OPTIONAL implies the property/parameter could be absent.
                AUTO will default at runtime to REQUIRED if defaultValue is absent, otherwise it will be marked as OPTIONAL.
            
        
        
            
            
            
        
    

    
        
            
                A connection defines a set of properties that will be tight to the connection provider mechanism rather than the
                configuration (default behaviour).
            
        
    

    
        
            
                
                    
                        
                    
                
            
        
    





© 2015 - 2024 Weber Informatics LLC | Privacy Policy