Module org.mule.sdk.api

Package org.mule.sdk.api.data.sample

Class SampleDataException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.mule.runtime.api.exception.MuleException

org.mule.sdk.api.data.sample.SampleDataException

All Implemented Interfaces:

Serializable

@Experimental
@MinMuleVersion("4.4")
@DoNotEnforceMinMuleVersion
public class SampleDataException
extends org.mule.runtime.api.exception.MuleException

Exception to indicate than an error occurred fetching sample data through a SampleDataProvider. NOTE: Experimental feature. Backwards compatibility not guaranteed.

Since:

1.4.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTION_FAILURE	Indicates that a connection couldn't be established
static final String	INVALID_LOCATION	Indicates that Sample Data resolution was attempted on a Location which doesn't exist
static final String	INVALID_TARGET_EXTENSION	Indicates that Sample Data resolution was attempted on an unregistered Extension
static final String	MISSING_REQUIRED_PARAMETERS	Indicates that the Sample Data resolution was attempted but the underlying SampleDataProvider has required parameters which weren't supplied
static final String	NO_DATA_AVAILABLE	Indicates that the SampleDataProvider didn't return any information
static final String	NOT_SUPPORTED	Indicates that Sample Data resolution was attempted on a component which doesn't support that capability
static final String	UNKNOWN	Signals an unexpected exception

Fields inherited from class org.mule.runtime.api.exception.MuleException

EXCEPTION_MESSAGE_DELIMITER, EXCEPTION_MESSAGE_SECTION_DELIMITER, INFO_ALREADY_LOGGED_KEY, INFO_ERROR_TYPE_KEY, INFO_LOCATION_KEY, INFO_SOURCE_XML_KEY, MISSING_DEFAULT_VALUE, MULE_VERBOSE_EXCEPTIONS, verboseExceptions

Constructor Summary

Constructors

Constructor	Description
SampleDataException(String message, String failureCode)
SampleDataException(String message, String failureCode, Throwable cause)
SampleDataException(org.mule.runtime.api.i18n.I18nMessage message, String failureCode)
SampleDataException(org.mule.runtime.api.i18n.I18nMessage message, String failureCode, Throwable cause)

Method Summary

Modifier and Type	Method	Description
String	getFailureCode()

Methods inherited from class org.mule.runtime.api.exception.MuleException

addInfo, appendMessage, equals, getDetailedMessage, getI18nMessage, getInfo, getMessage, getMessageCode, getSummaryMessage, getVerboseMessage, hashCode, isVerboseExceptions, prependMessage, refreshVerboseExceptions, setMessage, setMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNKNOWN

public static final String UNKNOWN

Signals an unexpected exception

See Also:

• Constant Field Values

NO_DATA_AVAILABLE

public static final String NO_DATA_AVAILABLE

Indicates that the SampleDataProvider didn't return any information

See Also:

• Constant Field Values

CONNECTION_FAILURE

public static final String CONNECTION_FAILURE

Indicates that a connection couldn't be established

See Also:

• Constant Field Values

INVALID_LOCATION

public static final String INVALID_LOCATION

Indicates that Sample Data resolution was attempted on a Location which doesn't exist

See Also:

• Constant Field Values

MISSING_REQUIRED_PARAMETERS

public static final String MISSING_REQUIRED_PARAMETERS

Indicates that the Sample Data resolution was attempted but the underlying SampleDataProvider has required parameters which weren't supplied

See Also:

• Constant Field Values

NOT_SUPPORTED

public static final String NOT_SUPPORTED

Indicates that Sample Data resolution was attempted on a component which doesn't support that capability

See Also:

• Constant Field Values

INVALID_TARGET_EXTENSION

public static final String INVALID_TARGET_EXTENSION

Indicates that Sample Data resolution was attempted on an unregistered Extension

See Also:

• Constant Field Values

Constructor Details

SampleDataException

public SampleDataException(String message,
 String failureCode)

SampleDataException

public SampleDataException(String message,
 String failureCode,
 Throwable cause)

SampleDataException

public SampleDataException(org.mule.runtime.api.i18n.I18nMessage message,
 String failureCode)

SampleDataException

public SampleDataException(org.mule.runtime.api.i18n.I18nMessage message,
 String failureCode,
 Throwable cause)

Method Details

getFailureCode

public String getFailureCode()

Returns:

The failure code of the error that produced the error