public abstract class ClientStorageManagerBase extends Object implements ClientStorageManagerV2
Implementations should be extended from this base class rather than directly implementing the interfaces it implements. By doing so, default implementations for some methods (such as search()) can be leveraged to minimize development effort. Future releases of PingFederate may add additional methods and similarly provide default implementations to ensure backwards compatibility with existing implementations.
CLIENT_ID, CLIENT_NAME, LAST_MODIFIED_DATE
Constructor and Description |
---|
ClientStorageManagerBase() |
Modifier and Type | Method and Description |
---|---|
Collection<ClientData> |
search(SearchCriteria searchCriteria)
Search for a client based on the provided SearchCriteria.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClient, deleteClient, getClient, getClients, updateClient
public Collection<ClientData> search(SearchCriteria searchCriteria) throws ClientStorageManagementException
This method only needs to be overridden for optimal search performance and is only invoked by the administrative console. The default implementation retrieves all entries to provide basic functionality. For optimal performance, custom storage implementations should keep track of the name and lastModified fields (and preferably index them).
search
in interface ClientStorageManagerV2
searchCriteria
- the search criteriaClientData
ClientStorageManagementException
- if client storage communication fails.Copyright 2019 Ping Identity Corp. All rights reserved.