Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.data.sample

Interface ComponentSampleDataProvider

@NoImplement public interface ComponentSampleDataProvider
Contract for components capable of providing sample data.
Since:
1.4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    org.mule.runtime.api.message.Message
    getSampleData()
    Retrieves sample data based on the component's current configuration

  • Method Details

    • getSampleData

      org.mule.runtime.api.message.Message getSampleData() throws org.mule.sdk.api.data.sample.SampleDataException
      Retrieves sample data based on the component's current configuration
      Returns:
      a Message carrying sample data
      Throws:
      org.mule.sdk.api.data.sample.SampleDataException - if resolution fails