Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework  E57662-01
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
Org.IdentityConnectors.Framework.Api.Operations.TestApiOp Interface Reference

Tests the Org.IdentityConnectors.Framework.Api.APIConfiguration with the connector. More...

Inherits Org.IdentityConnectors.Framework.Api.Operations.APIOperation.

Inherited by Org.IdentityConnectors.Framework.Api.ConnectorFacade.

Public Member Functions

void Test ()
 Tests the current Org.IdentityConnectors.Framework.Api.APIConfiguration with the connector. More...
 

Detailed Description

Tests the Org.IdentityConnectors.Framework.Api.APIConfiguration with the connector.

Unlike validation performed by M:Org.IdentityConnectors.Framework.Api.Operations.ValidateApiOp.Validate, 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., its physical connection to the resource has not timed out).

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

Member Function Documentation

void Org.IdentityConnectors.Framework.Api.Operations.TestApiOp.Test ( )

Tests the current Org.IdentityConnectors.Framework.Api.APIConfiguration with the connector.

Exceptions
System.Exceptioniff the configuration is not valid or the test failed.
The documentation for this interface was generated from the following file: