Package org.mule.weave.extension.api.services.sample

Interface WeaveSampleDataResourcesService

All Superinterfaces:

org.mule.dx.platform.api.component.ComponentLifecycle, LanguageServerLifecycle, WeaveService

public interface WeaveSampleDataResourcesService
extends WeaveService

Method Summary

Modifier and Type	Method	Description
java.io.File	getInputSampleData(java.lang.String uri, java.lang.String scenarioName, java.lang.String inputFileName)	The file where the input sample data should be stored.
java.io.File	getSampleDataFolder(java.lang.String uri)	The folder were sample data should be stored.

Methods inherited from interface org.mule.weave.extension.api.lifecycle.LanguageServerLifecycle

initialize, initialized, shutdown

Methods inherited from interface org.mule.weave.extension.api.services.WeaveService

start, stop

Method Detail

getSampleDataFolder

java.io.File getSampleDataFolder(java.lang.String uri)

The folder were sample data should be stored.

Parameters:

uri - for the unique identifier of the element to get its sample data folder.

Returns:

File the folder were the sample data would be created. The folder is not created in the file system it is up to consumer to create it.

getInputSampleData

java.io.File getInputSampleData(java.lang.String uri,
                                java.lang.String scenarioName,
                                java.lang.String inputFileName)

The file where the input sample data should be stored. In order to check if input sample data exists use the File.exists() API.

Parameters:

uri - for the unique identifier of the element to get its sample data folder.

scenarioName - the name of the scenario where the input is defined.

inputFileName - the file name (with its extension, .json, .xml).

Returns:

File the file were the input sample data should be stored. The file is not created in the file system it is up to consumer to create it.