com.boomi.connector.api

Interface ConnectionTester

All Superinterfaces:

Browser

public interface ConnectionTester
extends Browser

A Connection Tester is used to perform test connection for a given connector. This interface is to be used when connector browsing methods i.e. Browser.getObjectTypes() and Browser.getObjectDefinitions(String, Collection) implementations cannot be used to perform test connection. Implement this method in Browser implementation of connector. This interface is to be used when test connection method in connector descriptor is set to "CUSTOM"

Method Summary

Modifier and Type	Method and Description
void	testConnection() This function is executed to perform test connection when method attribute for element in connector descriptor is set to "CUSTOM".

Methods inherited from interface com.boomi.connector.api.Browser

getObjectDefinitions, getObjectTypes

Method Detail

testConnection

void testConnection()

This function is executed to perform test connection when method attribute for element in connector descriptor is set to "CUSTOM". This function will not be called if method is set to "GET_OBJECT_TYPES" or "GET_OBJECT_DEFINITIONS". It is necessary for this function to throw an exception when connection fails. The exception will be displayed on the test connection wizard.