ballerina/privacy module

Objects Summary

Object Description
H2PiiStore

Represents personally identifiable information (PII) storage mechanisum based on H2 database

MySqlPiiStore

Represents personally identifiable information (PII) storage mechanisum based on MySQL database

PiiStore

Represents a storage mechanisum usable to store personally identifiable information (PII)

Functions Summary

Return Type Function and Description
error?<> delete(privacy:PiiStore store, string id)

Delete personally identifiable information (PII) from the PII store

string | error<> depseudonymize(privacy:PiiStore store, string id)

Depseudonymize the identifier by retrieving the personally identifiable information (PII) from the PII store

string | error<> pseudonymize(privacy:PiiStore store, string pii)

Pseudonymize personally identifiable information (PII) and store PII and the pseudonymized identifier in the PII store

public function delete(privacy:PiiStore store, string id) returns (error?<>)

Delete personally identifiable information (PII) from the PII store

Parameter Name Data Type Default Value Description
store privacy:PiiStore

storage used to persist the PII and the identifier

id string

pseudonymized identifier to be deleted

Return Type Description
error?<>

nil if retrieval was successful, error if retrieval failed

public function depseudonymize(privacy:PiiStore store, string id) returns (string | error<>)

Depseudonymize the identifier by retrieving the personally identifiable information (PII) from the PII store

Parameter Name Data Type Default Value Description
store privacy:PiiStore

storage used to persist the PII and the identifier

id string

pseudonymized identifier to be depseudonymize

Return Type Description
string | error<>

PII if retrieval was successful, error if retrieval failed

public function pseudonymize(privacy:PiiStore store, string pii) returns (string | error<>)

Pseudonymize personally identifiable information (PII) and store PII and the pseudonymized identifier in the PII store

Parameter Name Data Type Default Value Description
store privacy:PiiStore

storage used to persist the PII and the identifier

pii string

PII to be pseudonymized

Return Type Description
string | error<>

36 characters long UUID if storage operation was successful, error if storage operation failed

public type H2PiiStore object

Represents personally identifiable information (PII) storage mechanisum based on H2 database

Field Name Data Type Default Value Description
clientEndpoint h2:Client

reference to H2 database client endpoint

tableName string

table name used to store PII

idColumn string

column name used to store pseudonymized identifier

piiColumn string

column name used to store PII

  • <H2PiiStore> __init(h2:Client clientEndpoint, string tableName, string idColumn, string piiColumn)

    Create personally identifiable information (PII) storage mechanisum based on H2 database

    Parameter Name Data Type Default Value Description
    clientEndpoint h2:Client

    reference to H2 database client endpoint

    tableName string

    table name used to store PII

    idColumn string

    column name used to store pseudonymized identifier

    piiColumn string

    column name used to store PII

  • <H2PiiStore> pseudonymize(string pii) returns (string | error<>)

    Pseudonymize personally identifiable information (PII) and store PII and the pseudonymized identifier

    Parameter Name Data Type Default Value Description
    pii string

    PII to be pseudonymized

    Return Type Description
    string | error<>

    36 characters long UUID if storage operation was successful, error if storage operation failed

  • <H2PiiStore> depseudonymize(string id) returns (string | error<>)

    Depseudonymize the identifier by retrieving the personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be depseudonymize

    Return Type Description
    string | error<>

    PII if retrieval was successful, error if retrieval failed

  • <H2PiiStore> delete(string id) returns (error?<>)

    Delete personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be deleted

    Return Type Description
    error?<>

    nil if retrieval was successful, error if retrieval failed

public type MySqlPiiStore object

Represents personally identifiable information (PII) storage mechanisum based on MySQL database

Field Name Data Type Default Value Description
clientEndpoint mysql:Client

reference to H2 database client endpoint

tableName string

table name used to store PII

idColumn string

column name used to store pseudonymized identifier

piiColumn string

column name used to store PII

  • <MySqlPiiStore> __init(mysql:Client clientEndpoint, string tableName, string idColumn, string piiColumn)

    Create personally identifiable information (PII) storage mechanisum based on MySQL database

    Parameter Name Data Type Default Value Description
    clientEndpoint mysql:Client

    reference to H2 database client endpoint

    tableName string

    table name used to store PII

    idColumn string

    column name used to store pseudonymized identifier

    piiColumn string

    column name used to store PII

  • <MySqlPiiStore> pseudonymize(string pii) returns (string | error<>)

    Pseudonymize personally identifiable information (PII) and store PII and the pseudonymized identifier

    Parameter Name Data Type Default Value Description
    pii string

    PII to be pseudonymized

    Return Type Description
    string | error<>

    36 characters long UUID if storage operation was successful, error if storage operation failed

  • <MySqlPiiStore> depseudonymize(string id) returns (string | error<>)

    Depseudonymize the identifier by retrieving the personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be depseudonymize

    Return Type Description
    string | error<>

    PII if retrieval was successful, error if retrieval failed

  • <MySqlPiiStore> delete(string id) returns (error?<>)

    Delete personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be deleted

    Return Type Description
    error?<>

    nil if retrieval was successful, error if retrieval failed

public type PiiStore object

Represents a storage mechanisum usable to store personally identifiable information (PII)

  • <PiiStore> pseudonymize(string pii) returns (string | error<>)

    Pseudonymize personally identifiable information (PII) and store PII and the pseudonymized identifier

    Parameter Name Data Type Default Value Description
    pii string

    PII to be pseudonymized

    Return Type Description
    string | error<>

    36 characters long UUID if storage operation was successful, error if storage operation failed

  • <PiiStore> depseudonymize(string id) returns (string | error<>)

    Depseudonymize the identifier by retrieving the personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be depseudonymize

    Return Type Description
    string | error<>

    PII if retrieval was successful, error if retrieval failed

  • <PiiStore> delete(string id) returns (error?<>)

    Delete personally identifiable information (PII)

    Parameter Name Data Type Default Value Description
    id string

    pseudonymized identifier to be deleted

    Return Type Description
    error?<>

    nil if retrieval was successful, error if retrieval failed