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

Schnittstelle DomainManager

public interface DomainManager

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addDomain(DomainInDTO domainDTO)	adds a new domain
boolean	arePSNDeletable(String domainName)	Gibt true if the property DomainProperties.PSNS_DELETABLE is set zurück.
long	countPSNs(String domainName, PaginationConfig config)	counts matching for the given domain w.r.t. the filter in the pagination config
long	countPSNsForDomains(List<String> domainNames, PaginationConfig config)	counts matching for the given domain w.r.t. the filter in the pagination config
void	deleteDomain(String domainName)	deletes the given domain
void	deleteDomainWithPSNs(String domainName)	deletes the given domain with all pseudonyms - be sure you know, what you're doing
Alphabet	getAlphabet(String alphabetName)	Gibt the alphabet for the given name zurück.
DomainOutDTO	getDomain(String domainName)	returns all information for the given domain
List<DomainOutDTO>	getDomainsForPrefix(String prefix)
List<DomainOutDTO>	getDomainsForSuffix(String suffix)
GeneratorAlphabetRestriction	getRestrictionForCheckDigitClass(String checkDigitClass)	gives the restriction for the number of chars within the alphabet for the given check digit class
List<DomainOutDTO>	listDomains()
List<PSNDTO>	listPSNs(String domainName)
List<PSNDTO>	listPSNsForDomainsPaginated(List<String> domainNames, PaginationConfig config)	lists all matching psns for the given domains paginated w.r.t. the filter in the pagination config
List<PSNDTO>	listPSNsPaginated(String domainName, PaginationConfig config)	lists all matching psns for the given domain paginated w.r.t. the filter in the pagination config
void	updateDomain(DomainInDTO domainDTO)	updates a existing domain
void	updateDomainInUse(String domainName, String label, String comment, List<String> parentDomainNames, boolean sendNotificationsWeb, boolean psnsDeletable)	updates a existing domain which is in use (contains psns)

Methodendetails

addDomain

void addDomain(DomainInDTO domainDTO)
        throws DomainInUseException,
InvalidAlphabetException,
InvalidCheckDigitClassException,
InvalidGeneratorException,
InvalidParameterException,
InvalidParentDomainException,
UnknownDomainException

adds a new domain

Parameter:

domainDTO - see DomainInDTO

Löst aus:

DomainInUseException - if the given domain already exists

InvalidAlphabetException - if the given alphabet name (attribute of the given domain) is not a valid alphabet or the length of the alphabet is not valid for the given check digit class

InvalidCheckDigitClassException - if the given check digit class name (attribute of the given domain) is not a valid check digit class

InvalidGeneratorException - if the generator can't be instantiated

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given parentDomain can't be found

InvalidParentDomainException

updateDomain

void updateDomain(DomainInDTO domainDTO)
           throws DomainInUseException,
InvalidAlphabetException,
InvalidCheckDigitClassException,
InvalidGeneratorException,
InvalidParameterException,
UnknownDomainException,
InvalidParentDomainException,
InvalidUpdateInUseOperationException

updates a existing domain

Parameter:

domainDTO - see DomainInDTO

Löst aus:

DomainInUseException - if there's at least one pseudonym within that domain

InvalidAlphabetException - if the given alphabet name (attribute of the given domain) is not a valid alphabet or the length of the alphabet is not valid for the given check digit class

InvalidCheckDigitClassException - if the given check digit class name (attribute of the given domain) is not a valid check digit class

InvalidGeneratorException - if the generator can't be instantiated

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain or parentDomain doesn't exists

InvalidParentDomainException

InvalidUpdateInUseOperationException

updateDomainInUse

void updateDomainInUse(String domainName,
 String label,
 String comment,
 List<String> parentDomainNames,
 boolean sendNotificationsWeb,
 boolean psnsDeletable)
                throws InvalidParameterException,
UnknownDomainException,
InvalidGeneratorException,
InvalidAlphabetException,
InvalidParentDomainException,
InvalidCheckDigitClassException,
InvalidUpdateInUseOperationException

updates a existing domain which is in use (contains psns)

Parameter:

domainName - the name of the domain

label - the new label

comment - the new comment

parentDomainNames - list of parent domain names

sendNotificationsWeb - whether the web should send notifications to external systems

psnsDeletable - whether psns should be deleteable

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain or parentDomain doesn't exists

InvalidGeneratorException

InvalidAlphabetException

InvalidParentDomainException

InvalidCheckDigitClassException

InvalidUpdateInUseOperationException

deleteDomain

void deleteDomain(String domainName)
           throws DomainInUseException,
InvalidParameterException,
UnknownDomainException

deletes the given domain

Parameter:

domainName - identifier

Löst aus:

DomainInUseException - if there's at least one pseudonym within that domain or that domain is a parent domain

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

deleteDomainWithPSNs

void deleteDomainWithPSNs(String domainName)
                   throws DomainInUseException,
InvalidParameterException,
UnknownDomainException

deletes the given domain with all pseudonyms - be sure you know, what you're doing

Parameter:

domainName - identifier

Löst aus:

DomainInUseException - if that domain is a parent domain

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

getDomain

DomainOutDTO getDomain(String domainName)
                throws InvalidParameterException,
UnknownDomainException

returns all information for the given domain

Parameter:

domainName - the name of the domain

Gibt zurück:

see DomainOutDTO

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

listDomains

List<DomainOutDTO> listDomains()

Gibt zurück:

list of all domains within the database; see DomainOutDTO

getDomainsForPrefix

List<DomainOutDTO> getDomainsForPrefix(String prefix)
                                throws InvalidParameterException

Parameter:

prefix - the domain prefix

Gibt zurück:

list of all domains with the given prefix; see DomainOutDTO

Löst aus:

InvalidParameterException - if prefix is null or empty

getDomainsForSuffix

List<DomainOutDTO> getDomainsForSuffix(String suffix)
                                throws InvalidParameterException

Parameter:

suffix - the domain suffix

Gibt zurück:

list of all domains with the given suffix; see DomainOutDTO

Löst aus:

InvalidParameterException - if suffix is null or empty

listPSNs

List<PSNDTO> listPSNs(String domainName)
               throws InvalidParameterException,
UnknownDomainException

Parameter:

domainName - domain for which all pseudonyms should be retrieved

Gibt zurück:

all pseudonyms for that domain

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

listPSNsPaginated

List<PSNDTO> listPSNsPaginated(String domainName,
 PaginationConfig config)
                        throws InvalidParameterException,
UnknownDomainException

lists all matching psns for the given domain paginated w.r.t. the filter in the pagination config

Parameter:

domainName - domain for which all pseudonyms should be retrieved

config - see PaginationConfig

Gibt zurück:

all pseudonyms for that domain

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

countPSNs

long countPSNs(String domainName,
 PaginationConfig config)
        throws InvalidParameterException,
UnknownDomainException

counts matching for the given domain w.r.t. the filter in the pagination config

Parameter:

domainName - domain for which all pseudonyms should be retrieved

config - see PaginationConfig (page size and first entry will be ignored)

Gibt zurück:

the number of all matching pseudonyms for that domain

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

listPSNsForDomainsPaginated

List<PSNDTO> listPSNsForDomainsPaginated(List<String> domainNames,
 PaginationConfig config)
                                  throws InvalidParameterException,
UnknownDomainException

lists all matching psns for the given domains paginated w.r.t. the filter in the pagination config

Parameter:

domainNames - domains for which all pseudonyms should be retrieved

config - see PaginationConfig

Gibt zurück:

all pseudonyms for that domain

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

countPSNsForDomains

long countPSNsForDomains(List<String> domainNames,
 PaginationConfig config)
                  throws InvalidParameterException,
UnknownDomainException

counts matching for the given domain w.r.t. the filter in the pagination config

Parameter:

domainNames - domain for which all pseudonyms should be retrieved

config - see PaginationConfig (page size and first entry will be ignored)

Gibt zurück:

the number of all matching pseudonyms for that domain

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

getRestrictionForCheckDigitClass

GeneratorAlphabetRestriction getRestrictionForCheckDigitClass(String checkDigitClass)
                                                       throws InvalidCheckDigitClassException,
InvalidParameterException

gives the restriction for the number of chars within the alphabet for the given check digit class

Löst aus:

InvalidCheckDigitClassException - if the given check digit class name (attribute of the given domain) is not a valid check digit class

InvalidParameterException - if domainName is null or empty

arePSNDeletable

boolean arePSNDeletable(String domainName)
                 throws InvalidParameterException,
UnknownDomainException

Gibt true if the property DomainProperties.PSNS_DELETABLE is set zurück.

Parameter:

domainName - the name of the domain

Gibt zurück:

true if the property DomainProperties.PSNS_DELETABLE is set

Löst aus:

InvalidParameterException - if domainName is null or empty

UnknownDomainException - if the given domain is not found

getAlphabet

Alphabet getAlphabet(String alphabetName)
              throws InvalidParameterException,
InvalidAlphabetException

Gibt the alphabet for the given name zurück. If you have access to the common API of gPAS in particular to Alphabets you should prefer using Alphabets.createAlphabet(String) instead of calling the service.

Parameter:

alphabetName - the alphabet string, either a class name, a comma-separated list of characters, or a single character

Gibt zurück:

the alphabet for the given name

Löst aus:

InvalidParameterException - for an invalid alphabet name (e.g. null or empty)

InvalidAlphabetException - for an invalid alphabet