public interface CustomDataSourceDriver extends ConfigurableDriver
This interface defines methods to test the connection to the unique data store testConnection()
},
perform the actual retrieval of information retrieveValues(Collection, SimpleFieldList)
and provide a list of
availabled fields to the user getAvailableFields()
.
A companion descriptor class CustomDataSourceDriverDescriptor
has been created to allow the user to set
fields that can be used to filter data during the retrieveValues(Collection, SimpleFieldList)
method call.
To utilize the CustomDataSourceDriverDescriptor
class, send an instance of this class in the
ConfigurableDriver.getSourceDescriptor()
method call. If the default SourceDescriptor
class is used, the user
will not be provided the ability to filter result sets.
SimpleFieldList
Modifier and Type | Method and Description |
---|---|
default String |
encodeFilterFieldParam(String filterFieldName,
String paramToEncode)
This method is called by PingFederate prior to retrieving information from the specified driver.
|
List<String> |
getAvailableFields()
PingFederate will take the list returned from this method, and display the field names as individual
checkbox items.
|
Map<String,Object> |
retrieveValues(Collection<String> attributeNamesToFill,
SimpleFieldList filterConfiguration)
This method is called by PingFederate when a connection (either IdP or SP) needs to retrieve information
from the specified driver.
|
boolean |
testConnection()
This method is used to determine whether the connection managed by a specific driver instance
is available.
|
configure, getSourceDescriptor
boolean testConnection()
Map<String,Object> retrieveValues(Collection<String> attributeNamesToFill, SimpleFieldList filterConfiguration)
attributeNamesToFill
- An array of names to retrieve values for. In the JDBC paradigm, these
would be column names.filterConfiguration
- A SimpleFieldList
list of filter
criteria to use when retrieve values. May be null if no filter configuration is provided. These fields are described
by the CustomDataSourceDriverDescriptor
class.List<String> getAvailableFields()
retrieveValues(Collection, SimpleFieldList)
method.default String encodeFilterFieldParam(String filterFieldName, String paramToEncode)
Copyright 2019 Ping Identity Corp. All rights reserved.