com.appian.connectedsystems.simplified.sdk.connectiontesting

Class SimpleTestableConnectedSystemTemplate

Object

com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

com.appian.connectedsystems.simplified.sdk.SimpleConnectedSystemTemplate

com.appian.connectedsystems.simplified.sdk.connectiontesting.SimpleTestableConnectedSystemTemplate

All Implemented Interfaces:

ConnectedSystemTemplate, TestableConnectedSystemTemplate

public abstract class SimpleTestableConnectedSystemTemplate
extends SimpleConnectedSystemTemplate
implements TestableConnectedSystemTemplate

SimpleConnectedSystemTemplate that contains credentials that can be validated against an external system.

Connected System Templates that extend this class are able to be tested by the designer in the UI. Tests will trigger a call to testConnection(SimpleConfiguration, ExecutionContext). This method returns a response that is displayed to the designer.

Field Summary

Fields inherited from class com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

typePropertyFactory

Constructor Summary

Constructors

Constructor and Description
SimpleTestableConnectedSystemTemplate()

Method Summary

Modifier and Type	Method and Description
TestConnectionResult	testConnection(ConfigurationDescriptor configDescriptor, ExecutionContext executionContext)
protected abstract TestConnectionResult	testConnection(SimpleConfiguration configuration, ExecutionContext executionContext) Validates credentials in the connected system Called when designer tests the credentials of a Testable Connected System

Methods inherited from class com.appian.connectedsystems.simplified.sdk.SimpleConnectedSystemTemplate

getConfiguration, getConfigurationDescriptor

Methods inherited from class com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

booleanProperty, deroot, documentProperty, doubleProperty, dropdownProperty, encryptedTextProperty, folderProperty, integerProperty, listTypeProperty, localType, localTypeProperty, localTypeProperty, textProperty

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.appian.connectedsystems.templateframework.sdk.ConnectedSystemTemplate

getConfigurationDescriptor

Constructor Detail

SimpleTestableConnectedSystemTemplate

public SimpleTestableConnectedSystemTemplate()

Method Detail

testConnection

protected abstract TestConnectionResult testConnection(SimpleConfiguration configuration,
                                                       ExecutionContext executionContext)

Validates credentials in the connected system

Called when designer tests the credentials of a Testable Connected System

Parameters:

configuration - The current configuration of the connected system. This will not be null.

executionContext - Designer specific data needed to initiate a connection with the external system.

Returns:

Test result, which will contain guidance if an error occurred.

testConnection

public TestConnectionResult testConnection(ConfigurationDescriptor configDescriptor,
                                           ExecutionContext executionContext)

Specified by:

testConnection in interface TestableConnectedSystemTemplate