org.mule.runtime.api.util

Interface ResourceLocator

@NoImplement
public interface ResourceLocator

Provides access to resources according to its calling object, even considering specific artifacts to search on.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
Optional<URL>	find(String resource, Object caller) Looks for a resource based on the calling class classloader and the current context classloader.
default Optional<URL>	findIn(String resource, String groupId, String artifactId, Optional<String> version, Object caller) Same as findIn(String, String, String, Optional, String, String, Object) but using no classifier and jar as type.
Optional<URL>	findIn(String resource, String groupId, String artifactId, Optional<String> version, String classifier, String type, Object caller) 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.
Optional<InputStream>	load(String resource, Object caller) Looks for a resource as in find(String, Object) and returns it's InputStream if possible.
default Optional<InputStream>	loadFrom(String resource, String groupId, String artifactId, Optional<String> version, Object caller) Same as loadFrom(String, String, String, Optional, String, String, Object) but using no classifier and jar as type.
Optional<InputStream>	loadFrom(String resource, String groupId, String artifactId, Optional<String> version, String classifier, String type, Object caller) Looks for a resource as in findIn(String, String, String, Optional, String, String, Object) and returns it's InputStream if possible.

Method Detail

load

Optional<InputStream> load(String resource,
                           Object caller)

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

Parameters:

resource - the name of the resource to load

caller - the calling object

Returns:

a stream for this resource

find

Optional<URL> find(String resource,
                   Object caller)

Looks for a resource based on the calling class classloader and the current context classloader.

Parameters:

resource - the name of the resource to load

caller - the calling object

Returns:

the URL for this resource

loadFrom

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

Same as loadFrom(String, String, String, Optional, String, String, Object) 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

caller - the calling object

Returns:

a stream for this resource

loadFrom

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

Looks for a resource as in findIn(String, String, String, Optional, String, String, Object) 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

caller - the calling object

Returns:

a stream for this resource

findIn

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

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

caller - the calling object

Returns:

the URL for this resource

findIn

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

Same as findIn(String, String, String, Optional, String, String, Object) 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

caller - the calling object

Returns:

the URL for this resource