Package com.pingidentity.sdk.oauth20

Class ClientData

java.lang.Object

com.pingidentity.sdk.oauth20.ClientData

public class ClientData
extends Object

A wrapper class for client data used by custom OAuth client storage implementations.

Custom storage implementations should be focused on how to manage the data wrapped by ClientData objects. The methods getData() and setData() can be used for this purpose; other setter methods should not be called.

getName() and getLastModified() functions are available to facilitate the development of optimized search functionality in custom storage implementations. The data itself should be treated opaquely. Its format is subject to change in future releases, however the data and this class will be forwards compatible.

Constructor Summary

Constructors

Constructor	Description
ClientData()

Method Summary

Modifier and Type	Method	Description
Date	getCreationTime()	Get the creation time of the client data.
String	getData()	Get the client data to be persisted by custom storage.
String	getId()	Get the client ID of the wrapped client data.
Date	getLastModified()	Get the last modified time of the client data.
String	getName()	Get the client name of the wrapped client data.
void	setCreationTime(Date creationTime)	Set the creation time.
void	setData(String data)	Set the client data as it is read from custom storage.
void	setId(String id)	Set the client ID.
void	setLastModified(Date lastModified)	Set the last modified time.
void	setName(String name)	Set the client name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientData

public ClientData()

Method Detail

getData

public String getData()

Get the client data to be persisted by custom storage. The data appears in the following format: Sample: “data = 1.asdfasdfawer234234234234234234sdfssgzdfgasg" The preceding number represents a format id.

Returns:

String representation of the client object.

setData

public void setData(String data)

Set the client data as it is read from custom storage. The data appears in the following format: Sample: “data = 1.asdfasdfawer234234234234234234sdfssgzdfgasg" The preceding number represents a format id.

Parameters:

data - String representation of the client object.

getId

public String getId()

Get the client ID of the wrapped client data.

Returns:

the client id.

setId

public void setId(String id)

Set the client ID. This method should not be called by custom storage implementations.

Parameters:

id - (client id)

getLastModified

public Date getLastModified()

Get the last modified time of the client data.

Returns:

the last modified date

setLastModified

public void setLastModified(Date lastModified)

Set the last modified time. This method should not be called by custom storage implementations.

Parameters:

lastModified -

getCreationTime

public Date getCreationTime()

Get the creation time of the client data.

Returns:

the creation time

setCreationTime

public void setCreationTime(Date creationTime)

Set the creation time. This method should not be called by custom storage implementations.

Parameters:

creationTime -

getName

public String getName()

Get the client name of the wrapped client data.

Returns:

the client name

setName

public void setName(String name)

Set the client name. This method should not be called by custom storage implementations.

Parameters:

name -