org.mule.runtime.api.connection

Class ConnectionValidationResult

java.lang.Object

org.mule.runtime.api.connection.ConnectionValidationResult

public class ConnectionValidationResult
extends Object

Represents the result of a Connection Validation.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static ConnectionValidationResult	failure(String message, ConnectionExceptionCode code, Exception exception)
ConnectionExceptionCode	getCode()
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 Detail

success

public static ConnectionValidationResult success()

Returns:

a ConnectionValidationResult with a valid status.

failure

public static ConnectionValidationResult failure(String message,
                                                 ConnectionExceptionCode code,
                                                 Exception exception)

Parameters:

message - Message in case of a invalid connection

code - A ConnectionExceptionCode 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.

getCode

public ConnectionExceptionCode getCode()

Returns:

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

getException

public Exception getException()

Returns:

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