Package org.identityconnectors.framework.api.operations

Interface TestApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface TestApiOp
extends APIOperation

Tests the configuration with the connector.

Unlike validation, testing a configuration should check that any pieces of environment referred by the configuration are available. For example the connector could make a physical connection to a host specified in the configuration to check that it exists and that the credentials specified in the configuration are usable.

Since this operation may connect to the resource, it may be slow. Clients are advised not to invoke this operation often, such as before every provisioning operation. This operation is not intended to check that the connector is alive (i.e., that its physical connection to the resource has not timed out).

This operation may be invoked before the configuration has been validated.

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Method Summary

Modifier and Type	Method	Description
void	test()	Tests the Configuration with the connector.

Method Detail

test

void test()

Tests the Configuration with the connector.

Throws:

java.lang.RuntimeException - if the configuration is not valid or the test failed.