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

Schnittstelle PSNManagerWithNotification

public interface PSNManagerWithNotification

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	anonymiseAllEntriesForValue(String notificationClientID, String value, String domainName)	Anonymises all pseudonyms for the given value in the specified domain (replacing each "value" with "###_anonym_###_randString_###_anonym_###").
Map<String,AnonymisationResult>	anonymiseAllEntriesForValues(String notificationClientID, Set<String> values, String domainName)	Gibt SUCCESS, NOT_FOUND, ALREADY_ANONYMISED for the values depending on the result of anonymising all pseudonyms for each value zurück.
Map<String,AnonymisationResult>	anonymiseEntries(String notificationClientID, Set<String> values, String domainName)	Gibt SUCCESS, NOT_FOUND, ALREADY_ANONYMISED, or ERROR for the values depending on the result of anonymising them (replacing each "value" with "###_anonym_###_randString_###_anonym_###") zurück.
void	anonymiseEntry(String notificationClientID, String value, String domainName)	Anonymises a single pseudonym for the given value in the specified domain, replacing "value" with "###_anonym_###_randString_###_anonym_###".
void	anonymisePseudonym(String notificationClientID, String psn, String domainName)	Anonymises the given pseudonym in the specified domain.
Map<String,AnonymisationResult>	anonymisePseudonyms(String notificationClientID, Set<String> psns, String domainName)	Gibt SUCCESS, NOT_FOUND, or ALREADY_ANONYMISED for the pseudonyms depending on the result of anonymising them zurück.
String	createPseudonymFor(String notificationClientID, String value, String domainName)	Gibt a new pseudonym for the given value in the specified domain zurück.
Map<String,String>	createPseudonymForList(String notificationClientID, Set<String> values, String domainName)	Gibt a new pseudonym for each of the given values in the specified domain zurück.
List<String>	createPseudonymsFor(String notificationClientID, String value, String domainName, int number)	Gibt the specified number of new pseudonyms for the given value in the specified multi-PSN domain zurück.
Map<String,List<String>>	createPseudonymsForList(String notificationClientID, Set<String> values, String domainName, int number)	Gibt the specified number of new pseudonyms for each of the given values in the specified multi-PSN domain zurück.
void	deleteAllEntriesForValue(String notificationClientID, String value, String domainName)	Deletes all pseudonyms for the given value in the specified domain.
Map<String,DeletionResult>	deleteAllEntriesForValues(String notificationClientID, Set<String> values, String domainName)	Gibt SUCCESS, NOT_FOUND for the values depending on the result of deleting all pseudonyms for each value zurück.
Map<String,DeletionResult>	deleteEntries(String notificationClientID, Set<String> values, String domainName)	Gibt SUCCESS, NOT_FOUND, or ERROR for the given values depending on the result of deleting all their pseudonyms zurück.
void	deleteEntry(String notificationClientID, String value, String domainName)	Deletes a single pseudonym for the given value in the specified domain.
void	deletePseudonym(String notificationClientID, String psn, String domainName)	Deletes the pseudonym in the specified domain.
Map<String,DeletionResult>	deletePseudonyms(String notificationClientID, Set<String> psns, String domainName)	Gibt SUCCESS or NOT_FOUND for the given pseudonyms depending on the result of deleting pseudonyms zurück.
String	getOrCreatePseudonymFor(String notificationClientID, String value, String domainName)	Gibt the pseudonym for the given value in the specified domain, or create a new one if there is no such pseudonym, yet zurück.
Map<String,String>	getOrCreatePseudonymForList(String notificationClientID, Set<String> values, String domainName)	Gibt pseudonyms for the given values in the specified domain, or create a new ones if there are no such pseudonyms, yet zurück.
List<String>	getOrCreatePseudonymsFor(String notificationClientID, String value, String domainName, int minNumber)	Gibt all pseudonyms for the given value in the specified domain, and ensures that at least minNumber pseudonyms for the value, creating new ones as needed zurück.
Map<String,List<String>>	getOrCreatePseudonymsForList(String notificationClientID, Set<String> values, String domainName, int minNumber)	Gibt all pseudonyms for each of the given values in the specified domain, and ensures that at least minNumber pseudonyms exist per value, creating new ones as needed zurück.
void	insertValuePseudonymPair(String notificationClientID, String value, String pseudonym, String domainName)	insert a value - pseudonym pair value is expected to be a valid pseudonym
List<InsertPairExceptionDTO>	insertValuePseudonymPairs(String notificationClientID, Map<String,String> pairs, String domainName)	insert value - pseudonym pairs values within the map are expected to be valid pseudonyms

Methodendetails

createPseudonymFor

String createPseudonymFor(String notificationClientID,
 String value,
 String domainName)
                   throws DomainIsFullException,
InvalidParameterException,
UnknownDomainException

Gibt a new pseudonym for the given value in the specified domain zurück.

Note that an exception will be thrown if there are already pseudonyms for the value in a single-PSN domain (inconsistent data).

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value to create a pseudonym for

domainName - the name of the domain

Gibt zurück:

a new pseudonym for the given value in the specified domain

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if there exist more than one pseudonym for the value in a multi-PSN domain

UnknownDomainException - if the domain is unknown

createPseudonymsFor

List<String> createPseudonymsFor(String notificationClientID,
 String value,
 String domainName,
 int number)
                          throws DomainIsFullException,
InvalidParameterException,
UnknownDomainException

Gibt the specified number of new pseudonyms for the given value in the specified multi-PSN domain zurück.

Note that an exception will be thrown if the number is greater than 1 or if there are already pseudonyms for the value in a single-PSN domain (inconsistent data).

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value to create a pseudonym for

domainName - the name of the domain

number - the number of new pseudonyms to create

Gibt zurück:

the specified number of new pseudonyms for the given value in the specified multi-PSN domain

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if there exist more than one pseudonym for the value in a multi-PSN domain

UnknownDomainException - if the domain is unknown

createPseudonymForList

Map<String,String> createPseudonymForList(String notificationClientID,
 Set<String> values,
 String domainName)
                                   throws DomainIsFullException,
InvalidParameterException,
UnknownDomainException

Gibt a new pseudonym for each of the given values in the specified domain zurück.

Note that an exception will be thrown if there are already pseudonyms for the value in a single-PSN domain.

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values to create a pseudonym for

domainName - the name of the domain

Gibt zurück:

a new pseudonym for each of the given values in the specified domain

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if there are already pseudonyms for the value in a single-PSN domain

UnknownDomainException - if the given domain is not found

createPseudonymsForList

Map<String,List<String>> createPseudonymsForList(String notificationClientID,
 Set<String> values,
 String domainName,
 int number)
                                          throws DomainIsFullException,
InvalidParameterException,
UnknownDomainException

Gibt the specified number of new pseudonyms for each of the given values in the specified multi-PSN domain zurück.

Note that an exception will be thrown if the number is greater than 1 or if there are already pseudonyms for the value in a single-PSN domain.

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values to create a pseudonym for

domainName - the name of the domain

number - the number of new pseudonyms to create

Gibt zurück:

the specified number of new pseudonyms for each of the given values in the specified multi-PSN domain

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if the number is greater than 1 or if there are already pseudonyms for the value in a single-PSN domain

UnknownDomainException - if the given domain is not found

getOrCreatePseudonymFor

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

Gibt the pseudonym for the given value in the specified domain, or create a new one if there is no such pseudonym, yet zurück.

Note that an exception will be thrown if there are multiple pseudonyms for a value in a single-PSN domain (inconsistent data), but also for a multi-PSN domain, as multiple pseudonyms cannot be returned as a single string (invalid parameter).

Preferably to be used for single-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value to get or create a pseudonym for

domainName - the name of the domain

Gibt zurück:

the pseudonym for the given value in the specified domain, or create a new one if there is no such pseudonym, yet

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if there exist more than one pseudonym for the value in a multi-PSN domain

UnknownDomainException - if the domain is unknown

getOrCreatePseudonymsFor

List<String> getOrCreatePseudonymsFor(String notificationClientID,
 String value,
 String domainName,
 int minNumber)
                               throws InvalidParameterException,
DomainIsFullException,
UnknownDomainException

Gibt all pseudonyms for the given value in the specified domain, and ensures that at least minNumber pseudonyms for the value, creating new ones as needed zurück.

Note that an exception will be thrown if there are multiple pseudonyms for a value in a single-PSN domain (inconsistent data).

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value to get or create a pseudonym for

domainName - the name of the domain

minNumber - the minimum number of pseudonyms for the given value

Gibt zurück:

all pseudonyms for the given value in the specified domain, and ensures that at least minNumber pseudonyms for the value, creating new ones as needed

Löst aus:

InvalidParameterException - if one of the required parameters is not set

DomainIsFullException - if the domain is full

UnknownDomainException - if the domain is unknown

getOrCreatePseudonymForList

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

Gibt pseudonyms for the given values in the specified domain, or create a new ones if there are no such pseudonyms, yet zurück.

Note that an exception will be thrown if there are multiple pseudonyms for a value in a single-PSN domain (inconsistent data), but also for a multi-PSN domain, as multiple pseudonyms cannot be returned as a single string (invalid parameter).

Preferably to be used for single-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values to get or create a pseudonym for

domainName - the name of the domain

Gibt zurück:

pseudonyms for the given values in the specified domain, or create a new ones if there are no such pseudonyms, yet

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if there exist more than one pseudonym for value in a multi-PSN domain

UnknownDomainException - if the domain is unknown

getOrCreatePseudonymsForList

Map<String,List<String>> getOrCreatePseudonymsForList(String notificationClientID,
 Set<String> values,
 String domainName,
 int minNumber)
                                               throws DomainIsFullException,
InvalidParameterException,
UnknownDomainException

Gibt all pseudonyms for each of the given values in the specified domain, and ensures that at least minNumber pseudonyms exist per value, creating new ones as needed zurück.

Note that an exception will be thrown if there are multiple pseudonyms for a value in a single-PSN domain (inconsistent data).

Preferably to be used for multi-PSN domains.

Parameter:

notificationClientID - the client ID for notifications or null

values - the value to get or create a pseudonym for

domainName - the name of the domain

minNumber - the minimum number of pseudonyms for the given values

Gibt zurück:

all pseudonyms for each of the given values in the specified domain, and ensures that at least minNumber pseudonyms exist per value, creating new ones as needed

Löst aus:

DomainIsFullException - if the domain is full

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the domain is unknown

anonymiseEntry

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

Anonymises a single pseudonym for the given value in the specified domain, replacing "value" with "###_anonym_###_randString_###_anonym_###". Throws an exception if there is not exactly one pseudonym for the value.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value which should be anonymised

domainName - the name of the domain

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - e.g. if there exist more than one pseudonym for a value in a multi-PSN domain

UnknownDomainException - if the domain is unknown

UnknownValueException - if there are no pseudonyms for the given value in the specified domain

ValueIsAnonymisedException - if the value cannot be anonymised

anonymiseEntries

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

Gibt SUCCESS, NOT_FOUND, ALREADY_ANONYMISED, or ERROR for the values depending on the result of anonymising them (replacing each "value" with "###_anonym_###_randString_###_anonym_###") zurück. In particular, an AnonymisationResult.ERROR is returned for values with multiple pseudonyms associated.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values which should be anonymised

domainName - the name of the domain

Gibt zurück:

SUCCESS, NOT_FOUND, ALREADY_ANONYMISED, or ERROR for the values depending on the result of anonymising them (replacing each "value" with "###_anonym_###_randString_###_anonym_###")

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

anonymiseAllEntriesForValue

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

Anonymises all pseudonyms for the given value in the specified domain (replacing each "value" with "###_anonym_###_randString_###_anonym_###"). Throws an exception if there is no pseudonym for the value.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value for which all entries should be anonymised

domainName - the name of the domain

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - e.g. if there exist more than one pseudonym for a value in a multi-PSN domain

UnknownDomainException - if the given domain is not found

UnknownValueException - if there are no pseudonyms for the given value in the specified domain

ValueIsAnonymisedException - if the value cannot be anonymised

anonymiseAllEntriesForValues

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

Gibt SUCCESS, NOT_FOUND, ALREADY_ANONYMISED for the values depending on the result of anonymising all pseudonyms for each value zurück.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values for which all entries should be anonymised

domainName - the name of the domain

Gibt zurück:

SUCCESS, NOT_FOUND, ALREADY_ANONYMISED for the values depending on the result of anonymising all pseudonyms for each value

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

anonymisePseudonym

void anonymisePseudonym(String notificationClientID,
 String psn,
 String domainName)
                 throws DBException,
InvalidParameterException,
UnknownDomainException,
InvalidPSNException,
PSNNotFoundException

Anonymises the given pseudonym in the specified domain.

Parameter:

notificationClientID - the client ID for notifications or null

psn - the pseudonym to anonymise

domainName - the name of the domain

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

InvalidPSNException

PSNNotFoundException

anonymisePseudonyms

Map<String,AnonymisationResult> anonymisePseudonyms(String notificationClientID,
 Set<String> psns,
 String domainName)
                                             throws DBException,
InvalidParameterException,
UnknownDomainException

Gibt SUCCESS, NOT_FOUND, or ALREADY_ANONYMISED for the pseudonyms depending on the result of anonymising them zurück.

Parameter:

notificationClientID - the client ID for notifications or null

psns - the pseudonyms to anonymise

domainName - the name of the domain

Gibt zurück:

SUCCESS, NOT_FOUND, or ALREADY_ANONYMISED for the pseudonyms depending on the result of anonymising them

Löst aus:

DBException - e.g. if there exist more than one pseudonym for a value in a single-PSN domain

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

deleteEntry

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

Deletes a single pseudonym for the given value in the specified domain. Throws an exception if there is not exactly one pseudonym for the value.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value which should be deleted

domainName - the name of the domain

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

UnknownValueException - if there are no pseudonyms for the given value in the specified domain

DeletionForbiddenException

deleteEntries

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

Gibt SUCCESS, NOT_FOUND, or ERROR for the given values depending on the result of deleting all their pseudonyms zurück. In particular, an DeletionResult.ERROR is returned for values with multiple pseudonyms associated.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values which should be deleted

domainName - the name of the domain

Gibt zurück:

SUCCESS, NOT_FOUND, or ERROR for the given values depending on the result of deleting all their pseudonyms

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

DeletionForbiddenException

deleteAllEntriesForValue

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

Deletes all pseudonyms for the given value in the specified domain. Throws an exception if there is no pseudonym for the value.

Parameter:

notificationClientID - the client ID for notifications or null

value - the value for which all entries should be deleted

domainName - the name of the domain

Löst aus:

InvalidParameterException - e.g. if there exist more than one pseudonym for a value in a multi-PSN domain

UnknownDomainException - if the given domain is not found

UnknownValueException - if there are no pseudonyms for the given value in the specified domain

DeletionForbiddenException

deleteAllEntriesForValues

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

Gibt SUCCESS, NOT_FOUND for the values depending on the result of deleting all pseudonyms for each value zurück.

Parameter:

notificationClientID - the client ID for notifications or null

values - the values for which all entries should be deleted

domainName - the name of the domain

Gibt zurück:

SUCCESS, NOT_FOUND for the values depending on the result of deleting all pseudonyms for each value

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

DeletionForbiddenException

deletePseudonym

void deletePseudonym(String notificationClientID,
 String psn,
 String domainName)
              throws DeletionForbiddenException,
InvalidParameterException,
UnknownDomainException,
UnknownValueException,
InvalidPSNException,
PSNNotFoundException

Deletes the pseudonym in the specified domain.

Parameter:

notificationClientID - the client ID for notifications or null

psn - the pseudonym to delete

domainName - the name of the domain

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

UnknownValueException - if there are no pseudonyms for the given value in the specified domain

DeletionForbiddenException

InvalidPSNException

PSNNotFoundException

deletePseudonyms

Map<String,DeletionResult> deletePseudonyms(String notificationClientID,
 Set<String> psns,
 String domainName)
                                     throws DeletionForbiddenException,
InvalidParameterException,
UnknownDomainException

Gibt SUCCESS or NOT_FOUND for the given pseudonyms depending on the result of deleting pseudonyms zurück.

Parameter:

notificationClientID - the client ID for notifications or null

psns - the pseudonyms to delete

domainName - the name of the domain

Gibt zurück:

SUCCESS or NOT_FOUND for the given pseudonyms depending on the result of deleting pseudonyms

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found

DeletionForbiddenException

insertValuePseudonymPair

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

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

Parameter:

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

Löst aus:

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(String notificationClientID,
 Map<String,String> pairs,
 String domainName)
                                                throws InvalidParameterException,
UnknownDomainException

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

Parameter:

pairs - map of pairs which should be stored

domainName - for which domain should the given pairs be stored

Gibt zurück:

a list with all occurred exceptions, see InsertPairExceptionDTO

Löst aus:

InvalidParameterException - if one of the required parameters is not set

UnknownDomainException - if the given domain is not found