org.mule.runtime.api.meta.model

Class ExternalLibraryModel

java.lang.Object

org.mule.runtime.api.meta.model.ExternalLibraryModel

All Implemented Interfaces:

DescribedObject, NamedObject

public final class ExternalLibraryModel
extends Object
implements NamedObject, DescribedObject

Describes a library that the extension depends on but is not packaged with it.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalLibraryModel.ExternalLibraryModelBuilder A Builder for creating instances of ExternalLibraryModel.

Method Summary

Modifier and Type	Method and Description
static ExternalLibraryModel.ExternalLibraryModelBuilder	builder()
String	getDescription() Returns the component's description
String	getName() Gets the name of the object
Optional<String>	getRegexMatcher() If present, returns a regexp which must match the name of the library's file.
Optional<String>	getRequiredClassName() If present, the library should contain a class of the given name
Optional<String>	getSuggestedCoordinates() If provided, suggests Maven coordinates where the required library can be found.
ExternalLibraryType	getType()
boolean	isOptional()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ExternalLibraryModel.ExternalLibraryModelBuilder builder()

Returns:

a new ExternalLibraryModel.ExternalLibraryModelBuilder

getName

public String getName()

Description copied from interface: NamedObject

Gets the name of the object

Specified by:

getName in interface NamedObject

Returns:

The library's name. Will never be null

getDescription

public String getDescription()

Description copied from interface: DescribedObject

Returns the component's description

Specified by:

getDescription in interface DescribedObject

Returns:

The library's description

getRegexMatcher

public Optional<String> getRegexMatcher()

If present, returns a regexp which must match the name of the library's file.

Returns:

An Optional regexp to match the library's file name

getRequiredClassName

public Optional<String> getRequiredClassName()

If present, the library should contain a class of the given name

Returns:

The name of the required class

getSuggestedCoordinates

public Optional<String> getSuggestedCoordinates()

If provided, suggests Maven coordinates where the required library can be found. These coordinates should follow the Maven convention: groupId:artifactId:packaging:classifier:version.

Keep in mind that not all the values of the coordinates are required, for example: org.mule.modules:a-required-lib:1.0.0 are valid coordinates, which communicates the groupId, artifactId and version of the external library.

By default, the packaging is jar, so if is required to use a native library, like a .DLL, you will provide: org.mule.module:a-native-lib:dll:1.0.0 where dll is the packaging of the library.

More information in: https://maven.apache.org/pom.html#Maven_Coordinates

Returns:

The optional maven coordinates.

isOptional

public boolean isOptional()

Returns:

A boolean indicating whether the library is required or not to the basic functioning of the connector.

getType

public ExternalLibraryType getType()

Returns:

The library's type