/*
* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com
* The software in this package is published under the terms of the CPAL v1.0
* license, a copy of which has been included with this distribution in the
* LICENSE.txt file.
*/
package org.mule.runtime.core.api.connectivity;
import org.mule.runtime.api.component.location.Location;
import org.mule.runtime.api.connection.ConnectionValidationResult;
/**
* Service for doing connectivity testing.
*
* A {@code ConnectivityTestingService}
*
* @since 4.0
*/
public interface ConnectivityTestingService {
/**
* Does connection testing over the component registered under the provider identifier
*
* @param location component identifier over the one connectivity testing is done.
* @return connectivity testing result.
* @throws UnsupportedConnectivityTestingObjectException when it's not possible to do connectivity testing over the mule
* component.
* @throws {@link org.mule.runtime.core.api.exception.ObjectNotFoundException} when the object to use to do connectivity does
* not exists
*/
ConnectionValidationResult testConnection(Location location);
}