ClientStorageManagerBase (PingFederate Server SDK)

java.lang.Object
- com.pingidentity.sdk.oauth20.ClientStorageManagerBase

All Implemented Interfaces:

ClientStorageManager, ClientStorageManagerV2
```
public abstract class ClientStorageManagerBase
extends Object
implements ClientStorageManagerV2
```
Abstract base class for developing custom OAuth client storage implementations.
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.

Since:

8.4

Field Summary
- Fields inherited from interface com.pingidentity.sdk.oauth20.ClientStorageManagerV2
  CLIENT_ID, CLIENT_NAME, CREATION_DATE, LAST_MODIFIED_DATE

Constructor Summary

Constructors
Constructor Description

ClientStorageManagerBase()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<ClientData>`	`search(SearchCriteria searchCriteria)`	Search for a client based on the provided SearchCriteria.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pingidentity.sdk.oauth20.ClientStorageManager
addClient, deleteClient, getClient, getClients, updateClient

- Constructor Detail
  - ClientStorageManagerBase
```
public ClientStorageManagerBase()
```
- Method Detail
  - search
```
public Collection<ClientData> search(SearchCriteria searchCriteria)
                              throws ClientStorageManagementException
```
    Search for a client based on the provided SearchCriteria. This method is only used by the administrative console.
    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).
    
    Specified by:
    
    search in interface ClientStorageManagerV2
    
    Parameters:
    
    searchCriteria - the search criteria
    
    Returns:
    
    collection of ClientData
    
    Throws:
    
    ClientStorageManagementException - if client storage communication fails.