com.appian.connectedsystems.simplified.sdk

Class SimpleClientApi

Object

com.appian.connectedsystems.simplified.sdk.SimpleClientApi

All Implemented Interfaces:

ClientApi

public abstract class SimpleClientApi
extends Object
implements ClientApi

A Client API enhances a Component Plugin (CP) with the capability to execute code on the server with access to secured values

Each Client API must be associated with exactly one SimpleConnectedSystemTemplate. A SimpleConnectedSystemTemplate may have zero or more associated Client APIs.

The TemplateId annotation defines the friendly name of the SimpleClientAPI when called from the Component Plugin.

Client APIs are re-instantiated per request. Therefore, each call to execute(SimpleClientApiRequest, ExecutionContext) is on a new instance of the class.

Client APIs are immediately available once deployed. They do not require any additional configuration in Appian.

Constructor Summary

Constructors

Constructor and Description
SimpleClientApi()

Method Summary

Modifier and Type	Method and Description
ClientApiResponse	execute(ClientApiRequest request, ExecutionContext executionContext)
protected abstract ClientApiResponse	execute(SimpleClientApiRequest request, ExecutionContext executionContext) Defines the behavior of the Client API.

Methods inherited from class Object

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

Constructor Detail

SimpleClientApi

public SimpleClientApi()

Method Detail

execute

protected abstract ClientApiResponse execute(SimpleClientApiRequest request,
                                             ExecutionContext executionContext)

Defines the behavior of the Client API.

Parameters:

request - A non-null SimpleClientApiRequest.

executionContext - Contains all of the contextual information needed to execute the Client API including Designer information, Designer locale, and proxy configuration. ExecutionContext

Returns:

Value that will be returned to the Component Plugin.

execute

public ClientApiResponse execute(ClientApiRequest request,
                                 ExecutionContext executionContext)

Specified by:

execute in interface ClientApi