Force.com Apex Code Developer's Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
Approval Namespace
Auth Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
DataSourceUtil Class
DataType Enum
Filter Class
FilterType Enum
IdentityType Enum
Order Class
OrderDirection Enum
Provider Class
Provider Methods
QueryAggregation Enum
QueryContext Class
QueryUtils Class
ReadContext Class
SearchContext Class
SearchUtils Class
Table Class
TableResult Class
TableSelection Class
DataSource Exceptions
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Provider Class

Extend this base class to create a custom adapter for Lightning Connect. The class informs Salesforce of the functional and authentication capabilities that are supported by or required to connect to the external system.

Namespace

DataSource

Usage

Create an Apex class that extends DataSource.Provider to specify the following.
  • The types of authentication that can be used to access the external system
  • The features that are supported for the connection to the external system
  • The Apex class that extends DataSource.Connection to sync the external system’s schema and to handle the queries and searches of the external data

The values that are returned by the DataSource.Provider class determine which settings are available in the external data source definition in Salesforce. To access the external data source definition from Setup, click Develop | External Data Sources.

Provider Methods

The following are methods for Provider.

getAuthenticationCapabilities()

Returns the types of authentication that can be used to access the external system.

Signature

public List<DataSource.AuthenticationCapability> getAuthenticationCapabilities()

Return Value

Type: List<DataSource.AuthenticationCapability>

getCapabilities()

Returns the functional operations that the external system supports and the required endpoint settings for the external data source definition in Salesforce.

Signature

public List<DataSource.Capability> getCapabilities()

Return Value

Type: List<DataSource.Capability>

getConnection(connectionParams)

Returns a connection that points to an instance of the external data source.

Signature

public DataSource.Connection getConnection(DataSource.ConnectionParams connectionParams)

Parameters

connectionParams
Type: DataSource.ConnectionParams
Credentials for authenticating to the external system.

Return Value

Type: DataSource.Connection