|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CustomDataSourceDriver
This interface provides the methods necessary to successfully create a CustomDataSourceDriver. Classes derived from this interface can be used to access non-standard or unique data stores. Default implementation of JDBC and LDAP data stores exist. This interface provides access to all other types of data stores.
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
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getAvailableFields()
PingFederate will take the list returned from this method, and display the field names as individual checkbox items. |
java.util.Map<java.lang.String,java.lang.Object> |
retrieveValues(java.util.Collection<java.lang.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. |
Methods inherited from interface com.pingidentity.sources.ConfigurableDriver |
---|
configure, getSourceDescriptor |
Method Detail |
---|
boolean testConnection()
java.util.Map<java.lang.String,java.lang.Object> retrieveValues(java.util.Collection<java.lang.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.
java.util.List<java.lang.String> getAvailableFields()
retrieveValues(Collection, SimpleFieldList)
method.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |