com.mulesoft.connectivity.rest.commons.api.connection.validation

Class ConnectionValidationSettings.Builder

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.connection.validation.ConnectionValidationSettings.Builder

Enclosing class:

ConnectionValidationSettings

public static class ConnectionValidationSettings.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String testConnectionPath, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage) Allows creating a new instance of ConnectionValidationSettings.

Method Summary

Modifier and Type	Method and Description
ConnectionValidationSettings.Builder	addValidation(String validationExpression)
ConnectionValidationSettings.Builder	addValidation(String validationExpression, String errorTemplateExpression)
ConnectionValidationSettings	build()
ConnectionValidationSettings.Builder	httpMethod(org.mule.runtime.http.api.HttpConstants.Method httpMethod)
ConnectionValidationSettings.Builder	responseMediaType(org.mule.runtime.api.metadata.MediaType responseMediaType)
ConnectionValidationSettings.Builder	validStatusCodes(Integer... statusCode)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String testConnectionPath,
               org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Allows creating a new instance of ConnectionValidationSettings.

Parameters:

testConnectionPath - a path relative to the connection base uri where the validation request will be made.

expressionLanguage - the expression language to be used when executing the validation expressions.

Method Detail

httpMethod

public ConnectionValidationSettings.Builder httpMethod(org.mule.runtime.http.api.HttpConstants.Method httpMethod)

Parameters:

httpMethod - the HTTP Method to use when executing this request against the server.

Returns:

this builder

validStatusCodes

public ConnectionValidationSettings.Builder validStatusCodes(Integer... statusCode)

Parameters:

statusCode - all the HTTP status codes for which this request is considered a success.

Returns:

this builder

addValidation

public ConnectionValidationSettings.Builder addValidation(String validationExpression)

Parameters:

validationExpression - an expression to be executed on the request's response. Must return true if the connection is valid or false if it is not.

Returns:

this builder

addValidation

public ConnectionValidationSettings.Builder addValidation(String validationExpression,
                                                          String errorTemplateExpression)

Parameters:

validationExpression - an expression to be executed on the request's response. Must return true if the connection is valid or false if it is not.

errorTemplateExpression - an expression to be executed when the validation is unsuccessful (When validationExpression returns false) This expression must return an string and will be shown to the user as an error message.

Returns:

this builder

responseMediaType

public ConnectionValidationSettings.Builder responseMediaType(org.mule.runtime.api.metadata.MediaType responseMediaType)

Parameters:

responseMediaType - The expected response media type. Will be used when evaluating the validation expressions. If set this will override the media type returned in the content-type header by the server. This media type should be set if the server does not provide a content-type header.

Returns:

this builder

build

public ConnectionValidationSettings build()

Returns:

A ConnectionValidationSettings instance as defined using this builder.