ClientStorageManagerV2 (PingFederate Server SDK)

All Superinterfaces:

ClientStorageManager

All Known Implementing Classes:

ClientStorageManagerBase
```
public interface ClientStorageManagerV2
extends ClientStorageManager
```
An interface that defines a search method for OAuth client data in custom storage implementations.
Custom storage implementations should be extended from ClientStorageManagerBase rather than directly implementing this interface to benefit from the default methods it provides.

Since:

8.4

Field Summary

Fields
Modifier and Type Field Description

static String CLIENT_ID

static String CLIENT_NAME

static String CREATION_DATE

static String LAST_MODIFIED_DATE

Method Summary

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

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

- Field Detail
  - CLIENT_ID
```
static final String CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - CLIENT_NAME
```
static final String CLIENT_NAME
```
    See Also:
    
    Constant Field Values
  - LAST_MODIFIED_DATE
```
static final String LAST_MODIFIED_DATE
```
    See Also:
    
    Constant Field Values
  - CREATION_DATE
```
static final String CREATION_DATE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - search
```
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 to optimize 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).
    
    Parameters:
    
    searchCriteria - the search criteria
    
    Returns:
    
    sorted list of clients based on the search criteria
    
    Throws:
    
    ClientStorageManagementException - if client storage communication fails.