Interface TestOp

  • All Superinterfaces:
    SPIOperation

    public interface TestOp
    extends SPIOperation
    Tests the connector Configuration.

    Unlike validation, testing a configuration checks 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.

    This operation may be invoked before the configuration has been validated. An implementation is free to validate the configuration before testing it.

    • Method Detail

      • test

        void test()
        Tests the Configuration with the connector.
        Throws:
        RuntimeException - if the configuration is not valid or the test failed. Implementations are encouraged to throw the most specific exception available. When no specific exception is available, implementations can throw ConnectorException.