com.appian.connectedsystems.simplified.sdk.oauth

Class SimpleOAuthConnectedSystemTemplate

Object

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

com.appian.connectedsystems.simplified.sdk.SimpleConnectedSystemTemplate

com.appian.connectedsystems.simplified.sdk.oauth.SimpleOAuthConnectedSystemTemplate

All Implemented Interfaces:

ConnectedSystemTemplate, OAuthConnectedSystemTemplate

public abstract class SimpleOAuthConnectedSystemTemplate
extends SimpleConnectedSystemTemplate
implements OAuthConnectedSystemTemplate

SimpleConnectedSystemTemplate that uses the Authorization Code Grant type

Connected System Templates that extend SimpleOAuthConnectedSystemTemplate can be authorized from the UI by a designer. getOAuthConfiguration(SimpleConfiguration) is called when a designer attempts to authorize.

Field Summary

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

typePropertyFactory

Constructor Summary

Constructors

Constructor and Description
SimpleOAuthConnectedSystemTemplate()

Method Summary

Modifier and Type	Method and Description
OAuthConfigurationData	getOAuthConfiguration(ConfigurationDescriptor configurationDescriptor)
protected abstract OAuthConfigurationData	getOAuthConfiguration(SimpleConfiguration configuration) Given designer entered data, returns information needed to authorize using OAuth 2.0 authorization code grant Given the designer entered information contained in the SimpleConfiguration, returns OAuthConfigurationData that contains the information needed to prompt the designer to authorize

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

SimpleOAuthConnectedSystemTemplate

public SimpleOAuthConnectedSystemTemplate()

Method Detail

getOAuthConfiguration

protected abstract OAuthConfigurationData getOAuthConfiguration(SimpleConfiguration configuration)

Given designer entered data, returns information needed to authorize using OAuth 2.0 authorization code grant

Given the designer entered information contained in the SimpleConfiguration, returns OAuthConfigurationData that contains the information needed to prompt the designer to authorize

Parameters:

configuration - The current configuration of the Appian Connected System object. This will never be null.

Returns:

OAuthConfigurationData Contains authorization url, token url, client id, client secret and scope.

getOAuthConfiguration

public OAuthConfigurationData getOAuthConfiguration(ConfigurationDescriptor configurationDescriptor)

Specified by:

getOAuthConfiguration in interface OAuthConnectedSystemTemplate