Package org.emau.icmvc.ganimed.ttp.psn

Interface PSNManager

public interface PSNManager

Method Summary

Modifier and Type	Method	Description
Map<String,AnonymisationResult>	anonymiseEntries(Set<String> values, String domainName)	deletes the assignments value - pseudonym from the db (replaces "value" with "###_anonym_###_randString_###_anonym_###")
void	anonymiseEntry(String value, String domainName)	deletes the assignment value - pseudonym from the db (replaces "value" with "###_anonym_###_randString_###_anonym_###")
Map<String,DeletionResult>	deleteEntries(Set<String> values, String domainName)	deletes the given values and corresponding pseudonyms from the db
void	deleteEntry(String value, String domainName)	deletes the given value and corresponding pseudonym from the db
String	getOrCreatePseudonymFor(String value, String domainName)	returns a pseudonym for the given value
Map<String,String>	getOrCreatePseudonymForList(Set<String> values, String domainName)	list version of getOrCreatePseudonymFor(String, String) returns a map<value, psn> for all values
String	getPseudonymFor(String value, String domainName)	returns the pseudonym to the given value
Map<String,String>	getPseudonymForList(Set<String> values, String domainName)	list version of getPseudonymFor(String, String) returns a map<value, psn> (with psn="*** VALUE NOT FOUND ***" for each given value which is unknown for the given domain)
Map<String,String>	getPseudonymForValuePrefix(String valuePrefix, String domainName)	list version of getPseudonymFor(String, String) returns a map<value, psn> for all values which starts with the given string
PSNNetDTO	getPSNNetFor(String valueOrPSN)	create psn net with all values that are somehow linked to the given psn
PSNTreeDTO	getPSNTreeForPSN(String psn, String domainName)	create psn tree with all values that are somehow linked to the given psn
String	getValueFor(String psn, String domainName)	searches the value for the given psn and domain; calls checkPSN(psn, domainName) before searching the value
Map<String,String>	getValueForList(Set<String> psnList, String domainName)	list version of getValueFor(String, String) returns a map<psn, value> (with value="*** PSN NOT FOUND ***" for each given psn which is unknown for the given domain)
void	insertValuePseudonymPair(String value, String pseudonym, String domainName)	insert a value - pseudonym pair value is expected to be a valid pseudonym
List<InsertPairExceptionDTO>	insertValuePseudonymPairs(Map<String,String> pairs, String domainName)	insert value - pseudonym pairs values within the map are expected to be valid pseudonyms
boolean	isAnonym(String value)	is the given value an anonym?
boolean	isAnonymised(String psn, String domainName)	is the given psn anonymised?
void	validatePSN(String psn, String domainName)	checks if the given string is a valid pseudonym

Method Details

getOrCreatePseudonymFor

String getOrCreatePseudonymFor(String value,
 String domainName)
                        throws DBException,
DomainIsFullException,
InvalidParameterException,
UnknownDomainException

returns a pseudonym for the given value

Parameters:

value - string for which the pseudonym should be retrieved / generated

domainName - for / in which domain should the pair value-pseudonym be retrieved / stored

Returns:

a map with pairs original value -> pseudonym

Throws:

DBException - if an error occurred while persisting a new entry

DomainIsFullException - if a pseudonym for the given value couldn't be found, has therefor to be created but no more pseudonyms could be created for the given domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

getOrCreatePseudonymForList

Map<String,String> getOrCreatePseudonymForList(Set<String> values,
 String domainName)
                                        throws DBException,
DomainIsFullException,
InvalidParameterException,
UnknownDomainException

list version of getOrCreatePseudonymFor(String, String) returns a map<value, psn> for all values

Parameters:

values - list of strings for which pseudonyms should be retrieved / generated

domainName - for / in which domain should the pair value-pseudonym be retrieved / stored

Returns:

a map with pairs original value -> pseudonym

Throws:

DBException - if an error occurred while persisting a new entry

DomainIsFullException - if a pseudonym for the given value couldn't be found, has therefor to be created but no more pseudonyms could be created for the given domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

getPseudonymFor

String getPseudonymFor(String value,
 String domainName)
                throws InvalidParameterException,
UnknownDomainException,
UnknownValueException

returns the pseudonym to the given value

Parameters:

value - the string for which a pseudonym should be retrieved

domainName - for which domain should the pseudonym be retrieved

Returns:

the pseudonym

Throws:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

UnknownValueException - if the given value is not found for the given domain

getPseudonymForList

Map<String,String> getPseudonymForList(Set<String> values,
 String domainName)
                                throws InvalidParameterException,
UnknownDomainException

list version of getPseudonymFor(String, String)
returns a map<value, psn> (with psn="*** VALUE NOT FOUND ***" for each given value which is unknown for the given domain)

Parameters:

values - a list of values for which the pseudonyms should be retrieved

domainName - for which domain should the pseudonyms be retrieved

Returns:

map of value-pseudonym pairs

Throws:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

getPseudonymForValuePrefix

Map<String,String> getPseudonymForValuePrefix(String valuePrefix,
 String domainName)
                                       throws InvalidParameterException,
UnknownDomainException

list version of getPseudonymFor(String, String)
returns a map<value, psn> for all values which starts with the given string

Parameters:

valuePrefix - the prefix of all values for which the pseudonyms should be retrieved

domainName - for which domain should the pseudonyms be retrieved

Returns:

map of value-pseudonym pairs

Throws:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

anonymiseEntry

void anonymiseEntry(String value,
 String domainName)
             throws DBException,
InvalidParameterException,
UnknownDomainException,
UnknownValueException,
ValueIsAnonymisedException

deletes the assignment value - pseudonym from the db (replaces "value" with "###_anonym_###_randString_###_anonym_###")

Parameters:

value - the value which should be anonymised

domainName - for which domain should the given value be anonymised

Throws:

DBException - if an error occurred while anonymising the entry

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

UnknownValueException - if the value is not found within the given domain

ValueIsAnonymisedException - if the value is already anonymised

anonymiseEntries

Map<String,AnonymisationResult> anonymiseEntries(Set<String> values,
 String domainName)
                                          throws DBException,
InvalidParameterException,
UnknownDomainException

deletes the assignments value - pseudonym from the db (replaces "value" with "###_anonym_###_randString_###_anonym_###")

Parameters:

values - the values which should be anonymised

domainName - for which domain should the given value be anonymised

Returns:

the success status

Throws:

DBException - if an error occurred while anonymising the entry

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

isAnonym

boolean isAnonym(String value)
          throws InvalidParameterException

is the given value an anonym?

Parameters:

value - the value which should be tested

Returns:

true if the given value is an anonym, false else

Throws:

InvalidParameterException - if one of the required parameters is not set

isAnonymised

boolean isAnonymised(String psn,
 String domainName)
              throws InvalidParameterException,
InvalidPSNException,
UnknownDomainException,
PSNNotFoundException

is the given psn anonymised?

Parameters:

psn - the psn which should be tested

domainName - for which domain the given psn should be tested

Returns:

true if the given psn is anonymised, false else

Throws:

InvalidParameterException - if one of the required parameters is not set

InvalidPSNException - if the given PSN is not valid

UnknownDomainException - if the given domain is not found

PSNNotFoundException - if the psn is not found within the given domain

deleteEntry

void deleteEntry(String value,
 String domainName)
          throws DeletionForbiddenException,
InvalidParameterException,
UnknownDomainException,
UnknownValueException

deletes the given value and corresponding pseudonym from the db

Parameters:

value - the value which should be delete

domainName - within which domain should the assignment be deleted

Throws:

DeletionForbiddenException - when it's not allowed to delete value-pseudonym-assignments within a domain
see DomainProperties.PSNS_DELETABLE

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

UnknownValueException - if the given value is not found within the db for that domain

deleteEntries

Map<String,DeletionResult> deleteEntries(Set<String> values,
 String domainName)
                                  throws DeletionForbiddenException,
InvalidParameterException,
UnknownDomainException

deletes the given values and corresponding pseudonyms from the db

Parameters:

values - the values which should be delete

domainName - within which domain should the assignments be deleted

Returns:

a map with all values and the corresponding success status

Throws:

DeletionForbiddenException - when it's not allowed to delete value-pseudonym-assignments within a domain
see DomainProperties.PSNS_DELETABLE

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

validatePSN

void validatePSN(String psn,
 String domainName)
          throws InvalidParameterException,
InvalidPSNException,
UnknownDomainException

checks if the given string is a valid pseudonym

Parameters:

psn - the pseudonym which should be checked

domainName - for which domain should the given pseudonym be checked

Throws:

InvalidParameterException - if one of the required parameters is not set

InvalidPSNException - if the given PSN is not valid

UnknownDomainException - if the given domain is not found

getValueFor

String getValueFor(String psn,
 String domainName)
            throws InvalidParameterException,
InvalidPSNException,
PSNNotFoundException,
UnknownDomainException,
ValueIsAnonymisedException

searches the value for the given psn and domain; calls checkPSN(psn, domainName) before searching the value

Parameters:

psn - for which pseudonym should the original value be retrieved

domainName - for which domain should the original value to the given pseudonym be retrieved

Returns:

the original value

Throws:

InvalidParameterException - if one of the required parameters is not set

InvalidPSNException - if the given PSN is not valid

PSNNotFoundException - if the given PSN is not found within the db for that domain

UnknownDomainException - if the given domain is not found

ValueIsAnonymisedException - if pseudonym is anonymised

getValueForList

Map<String,String> getValueForList(Set<String> psnList,
 String domainName)
                            throws InvalidParameterException,
UnknownDomainException

list version of getValueFor(String, String)
returns a map<psn, value> (with value="*** PSN NOT FOUND ***" for each given psn which is unknown for the given domain)

Parameters:

psnList - list of pseudonyms for which the original values should be retrieved

domainName - for which domain should the original value to the given pseudonym be retrieved

Returns:

a map with pairs pseudonym -> original value

Throws:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

insertValuePseudonymPair

void insertValuePseudonymPair(String value,
 String pseudonym,
 String domainName)
                       throws InsertPairException,
InvalidParameterException,
UnknownDomainException

insert a value - pseudonym pair
value is expected to be a valid pseudonym

Parameters:

value - the value for which the pseudonym should be inserted

pseudonym - the pseudonym which should be inserted for the given value

domainName - for which domain should the given pairs be stored

Throws:

InsertPairException - if an error occurred while persisting the given pair (see InsertPairError)

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

insertValuePseudonymPairs

List<InsertPairExceptionDTO> insertValuePseudonymPairs(Map<String,String> pairs,
 String domainName)
                                                throws InvalidParameterException,
UnknownDomainException

insert value - pseudonym pairs
values within the map are expected to be valid pseudonyms

Parameters:

pairs - map of pairs which should be stored

domainName - for which domain should the given pairs be stored

Returns:

a list with all occurred exceptions, see InsertPairExceptionDTO

Throws:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

getPSNTreeForPSN

PSNTreeDTO getPSNTreeForPSN(String psn,
 String domainName)
                     throws InvalidParameterException,
InvalidPSNException,
PSNNotFoundException,
UnknownDomainException,
ValueIsAnonymisedException

create psn tree
with all values that are somehow linked to the given psn

Parameters:

psn - pseudonym that should be used to create the psn tree

domainName - name of the domain for the given pseudonym

Returns:

a psn tree object with all psn connected to the given psn

Throws:

InvalidParameterException - if one of the required parameters is not set

InvalidPSNException - if the given PSN is not valid

PSNNotFoundException - if the given PSN is not found within the db for that domain

UnknownDomainException - if the given domain is not found

ValueIsAnonymisedException - if the value is already anonymised

getPSNNetFor

PSNNetDTO getPSNNetFor(String valueOrPSN)
                throws InvalidParameterException

create psn net
with all values that are somehow linked to the given psn

Parameters:

valueOrPSN - value or pseudonym that should be used to create the psn net

Returns:

a psn net object with all psn connected to the given psn / value

Throws:

InvalidParameterException - if one of the required parameters is not set