com.pega.pegarules.pub.security

Interface ClientDataProvider

public interface ClientDataProvider

ClientDataProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientDataProvider.RequestType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	INVALIDINPUT
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessGroupFromApplication(PublicAPI tools, java.lang.String appName) API to return access group for the application
java.util.Map<java.lang.String,java.lang.String>	getAllClientIdentifierValues(PublicAPI tools, java.lang.String appName, java.lang.String clientIDLabel, java.lang.String clientID) API to return all client identifier values for the application
java.lang.String	getClientIdentifiersInJsonFormat(PublicAPI tools, java.lang.String applicationName) API to return client identifiers for the application in json format
ClipboardPage	getClientPreferences(PublicAPI tools, java.lang.String applicationName, java.lang.String clientID) API to fetch client function preferences
boolean	isFunctionRestricted(PublicAPI tools, java.lang.String appName, java.lang.String clientID, java.lang.String functionName, java.lang.String channelName) API to check whether the function for a channel is set as restricted through preferences by a client
java.lang.String	parseClientDataFromClipboardToJson(PublicAPI tools, ClipboardPage page, ClientDataProvider.RequestType requestType) API to parse client data from clipboardPage to json format
ClipboardPage	parseClientDataFromJsonToClipboard(PublicAPI tools, java.lang.String inputJson, ClientDataProvider.RequestType requestType) API to parse client data from json to clipboardPage format
ClipboardPage	parseFunctionPreferencesFromJsonToClipboardPage(PublicAPI tools, ClipboardPage inputJson) API to parse client function preferences to clipboardPage
void	processAllClientRequests(PublicAPI tools) Process all the client requests(access/rectify/erase)
java.lang.String	processSyncAccessRequestAsBatch(PublicAPI tools, java.lang.String clientAccessRequestCaseID) Processes client data access request synchronously
void	updateClientFunctionPreferences(PublicAPI tools, java.lang.String appName, java.lang.String clientIDLabel, java.lang.String clientID, ClipboardPage newClientPreferences) API to update client function preferences
boolean	validateClientRequest(PublicAPI tools, ClipboardPage RequestPage) validate a given client request JSON
boolean	validateExternalPropertyLabels(PublicAPI tools, ClipboardPage aPage)

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

INVALIDINPUT

static final java.lang.String INVALIDINPUT

See Also:

Constant Field Values

Method Detail

getClientIdentifiersInJsonFormat

java.lang.String getClientIdentifiersInJsonFormat(PublicAPI tools,
                                                  java.lang.String applicationName)

API to return client identifiers for the application in json format

Parameters:

tools - instance of Executable.

applicationName - name of the application in which personal data is stored.

Returns:

client data as json string

parseClientDataFromJsonToClipboard

ClipboardPage parseClientDataFromJsonToClipboard(PublicAPI tools,
                                                 java.lang.String inputJson,
                                                 ClientDataProvider.RequestType requestType)

API to parse client data from json to clipboardPage format

Parameters:

tools - instance of Executable.

inputJson - client data json as string.

requestType - whether access/rectify/erase

Returns:

client data as clipboardPage

parseClientDataFromClipboardToJson

java.lang.String parseClientDataFromClipboardToJson(PublicAPI tools,
                                                    ClipboardPage page,
                                                    ClientDataProvider.RequestType requestType)

API to parse client data from clipboardPage to json format

Parameters:

tools - instance of Executable.

page - client data as clipboardPage.

requestType - whether access/rectify/erase

Returns:

client data as clipboardPage

parseFunctionPreferencesFromJsonToClipboardPage

ClipboardPage parseFunctionPreferencesFromJsonToClipboardPage(PublicAPI tools,
                                                              ClipboardPage inputJson)

API to parse client function preferences to clipboardPage

Parameters:

tools - instance of Executable.

inputJson - client function preferences as clipboardPage.

Returns:

Page with Preference Names from application

updateClientFunctionPreferences

void updateClientFunctionPreferences(PublicAPI tools,
                                     java.lang.String appName,
                                     java.lang.String clientIDLabel,
                                     java.lang.String clientID,
                                     ClipboardPage newClientPreferences)
                              throws java.lang.Exception

API to update client function preferences

Parameters:

tools - instance of Executable.

appName - name of the application for which preferences are to be updated.

clientIDLabel - external label provided for the identifier

clientID - value of the identifier that identifies the client

newClientPreferences - preferences to be added/modified.

Throws:

java.lang.Exception

getClientPreferences

ClipboardPage getClientPreferences(PublicAPI tools,
                                   java.lang.String applicationName,
                                   java.lang.String clientID)

API to fetch client function preferences

Parameters:

tools - instance of Executable.

applicationName - name of the application for which preferences are to be fetched.

clientID - value of the identifier that identifies the client

Returns:

Page with Preference Names from application

isFunctionRestricted

boolean isFunctionRestricted(PublicAPI tools,
                             java.lang.String appName,
                             java.lang.String clientID,
                             java.lang.String functionName,
                             java.lang.String channelName)

API to check whether the function for a channel is set as restricted through preferences by a client

Parameters:

tools - instance of Executable.

appName - name of the application for which preferences are to be fetched.

clientID - value of the identifier that identifies the client

functionName - name of the function to be verified.

channelName - channel type to be verified.

Returns:

if user restricted the function

processAllClientRequests

void processAllClientRequests(PublicAPI tools)

Process all the client requests(access/rectify/erase)

Parameters:

tools - instance of Executable.

processSyncAccessRequestAsBatch

java.lang.String processSyncAccessRequestAsBatch(PublicAPI tools,
                                                 java.lang.String clientAccessRequestCaseID)

Processes client data access request synchronously

Parameters:

tools - instance of Executable.

clientAccessRequestCaseID - case ID of the client access request case

Returns:

JSON string, personal data in JSON format

validateClientRequest

boolean validateClientRequest(PublicAPI tools,
                              ClipboardPage RequestPage)

validate a given client request JSON

Parameters:

tools - instance of Executable.

RequestPage - instance of clientdata-work, that gets populated with required info.

Returns:

true if the clientRequest is valid, otherwise false.

validateExternalPropertyLabels

boolean validateExternalPropertyLabels(PublicAPI tools,
                                       ClipboardPage aPage)

Parameters:

tools - instance of Executable.

aPage - CBAC policy page, whose external labels are to be validated

Returns:

true if validation successful

getAccessGroupFromApplication

java.lang.String getAccessGroupFromApplication(PublicAPI tools,
                                               java.lang.String appName)

API to return access group for the application

Parameters:

tools - instance of Executable.

appName - name of the application for which access group is required

Returns:

accessGroup access group for the application

getAllClientIdentifierValues

java.util.Map<java.lang.String,java.lang.String> getAllClientIdentifierValues(PublicAPI tools,
                                                                              java.lang.String appName,
                                                                              java.lang.String clientIDLabel,
                                                                              java.lang.String clientID)
                                                                       throws DatabaseException

API to return all client identifier values for the application

Parameters:

tools - instance of Executable.

appName - name of the application for which access group is required

clientIDLabel - external label provided for the identifier

clientID - value of the identifier that identifies the client

Returns:

all Client Identifier values

Throws:

DatabaseException