org.mule.tooling.client.api.artifact.resources

Interface ResourceLoader

public interface ResourceLoader

A resource loader that allows to load ToolingArtifact resources with the resource:: prefix or just as relative paths. This resource loader honors the class loader filtering rules defined by the application and plugins as in Runtime environments.

Since:

1.2.0, 1.1.4

Method Summary

Modifier and Type	Method and Description
default Optional<URL>	findIn(String resource, String groupId, String artifactId, Optional<String> version) Same as findIn(String, String, String, Optional, String, String) but using no classifier and jar as type.
Optional<URL>	findIn(String resource, String groupId, String artifactId, Optional<String> version, String classifier, String type) Looks for a resource based on the calling class classloader and the current context classloader, specifically within the artifact specified by it's GAV coordinates, considering it's classifier and type as well.
URL	getResource(String resource) Returns the resources URL, useful when the actual resource will be loaded by another component.
InputStream	getResourceAsStream(String resource) Returns an InputStream with the resource's data ready to be consumed.
default Optional<InputStream>	loadFrom(String resource, String groupId, String artifactId, Optional<String> version) Same as loadFrom(String, String, String, Optional, String, String) but using no classifier and jar as type.
Optional<InputStream>	loadFrom(String resource, String groupId, String artifactId, Optional<String> version, String classifier, String type) Looks for a resource as in findIn(String, String, String, Optional, String, String) and returns it's InputStream if possible.

Method Detail

getResourceAsStream

InputStream getResourceAsStream(String resource)

Returns an InputStream with the resource's data ready to be consumed.

Parameters:

resource - the resource to be found.

Returns:

a stream to read data from the resource.

getResource

URL getResource(String resource)

Returns the resources URL, useful when the actual resource will be loaded by another component.

Parameters:

resource - the resource to be found.

Returns:

A URL pointing to the resource.

loadFrom

default Optional<InputStream> loadFrom(String resource,
                                       String groupId,
                                       String artifactId,
                                       Optional<String> version)

Same as loadFrom(String, String, String, Optional, String, String) but using no classifier and jar as type.

Parameters:

resource - the name of the resource to load

groupId - the group ID of the artifact where to look

artifactId - the artifact ID of the artifact where to look

version - the optional version of the artifact where to look

Returns:

a stream for this resource

loadFrom

Optional<InputStream> loadFrom(String resource,
                               String groupId,
                               String artifactId,
                               Optional<String> version,
                               String classifier,
                               String type)

Looks for a resource as in findIn(String, String, String, Optional, String, String) and returns it's InputStream if possible.

Parameters:

resource - the name of the resource to load

groupId - the group ID of the artifact where to look

artifactId - the artifact ID of the artifact where to look

version - the optional version of the artifact where to look

classifier - the classifier of the artifact where to look

type - the type of the artifact where to look

Returns:

a stream for this resource

findIn

Optional<URL> findIn(String resource,
                     String groupId,
                     String artifactId,
                     Optional<String> version,
                     String classifier,
                     String type)

Looks for a resource based on the calling class classloader and the current context classloader, specifically within the artifact specified by it's GAV coordinates, considering it's classifier and type as well.

Parameters:

resource - the name of the resource to load

groupId - the group ID of the artifact where to look

artifactId - the artifact ID of the artifact where to look

version - the optional version of the artifact where to look

classifier - the classifier of the artifact where to look

type - the type of the artifact where to look

Returns:

the URL for this resource

findIn

default Optional<URL> findIn(String resource,
                             String groupId,
                             String artifactId,
                             Optional<String> version)

Same as findIn(String, String, String, Optional, String, String) but using no classifier and jar as type.

Parameters:

resource - the name of the resource to load

groupId - the group ID of the artifact where to look

artifactId - the artifact ID of the artifact where to look

version - the optional version of the artifact where to look

Returns:

the URL for this resource