Module org.mule.sdk.api

Package org.mule.sdk.api.connectivity

Class ConnectionValidationResult

java.lang.Object

org.mule.sdk.api.connectivity.ConnectionValidationResult

@MinMuleVersion("4.5")
public final class ConnectionValidationResult
extends Object

Represents the result of a Connection Validation.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static ConnectionValidationResult	failure(String message, Exception exception)
static ConnectionValidationResult	failure(String message, org.mule.runtime.api.message.ErrorType errorType, Exception exception)
Optional<org.mule.runtime.api.message.ErrorType>	getErrorType()
Exception	getException()
String	getMessage()
boolean	isValid()
static ConnectionValidationResult	success()

Methods inherited from class java.lang.Object

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

Method Details

success

public static ConnectionValidationResult success()

Returns:

a ConnectionValidationResult with a valid status.

failure

public static ConnectionValidationResult failure(String message,
 Exception exception)

Parameters:

message - Message in case of a invalid connection

exception - The exception that causes the connection invalidity

Returns:

a ConnectionValidationResult with a invalid status.

failure

public static ConnectionValidationResult failure(String message,
 org.mule.runtime.api.message.ErrorType errorType,
 Exception exception)

Parameters:

message - Message in case of a invalid connection

errorType - An ErrorType that represents the cause of the invalid connection

exception - The exception that causes the connection invalidity

Returns:

a ConnectionValidationResult with a invalid status.

isValid

public boolean isValid()

Returns:

A boolean indicating if the connection is valid or not.

getMessage

public String getMessage()

Returns:

A String indicating the Validation message. The message should not be null in case of a invalid connection.

getErrorType

public Optional<org.mule.runtime.api.message.ErrorType> getErrorType()

Returns:

A ErrorType indicating the type of the occurred problem.

getException

public Exception getException()

Returns:

The Exception that causes the connection invalidity. The exception should not be null in case of a invalid connection.