public class ClientDavParameters
extends java.lang.Object
implements java.lang.Cloneable
Parameter für die Datenverteiler-Applikationsfunktionen. Diese Klasse implementiert die Schnittstelle DatenverteilerApplikationsfunktionen-Starter. Beim Erzeugen eines Objekts dieser Klasse werden die Parameter auf die in den Aufrufargumenten der Applikation angegebenen Werte bzw. auf die festgelegten Default-Werte gesetzt. Einzelne Parameter können mit den entsprechenden Zugriffsmethoden gesetzt und abgefragt werden.
Constructor and Description |
---|
ClientDavParameters()
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter.
|
ClientDavParameters(ArgumentList argumentList)
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter und setzt die in den übergebenen Aufrufargumenten angegebenen Parameter mit den jeweils angegebenen Werten.
|
ClientDavParameters(java.lang.String[] startArguments)
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter und setzt die in den übergebenen Aufrufargumenten angegebenen Parameter mit den jeweils angegebenen Werten.
|
ClientDavParameters(java.lang.String configurationPid,
java.lang.String address,
int subAddress,
java.lang.String userName,
java.lang.String applicationName,
java.lang.String authentificationProcessName,
int maxTelegramSize,
long receiveKeepAliveTimeout,
long sendKeepAliveTimeout,
int outputBufferSize,
int inputBufferSize,
java.lang.String communicationProtocolName,
boolean allowHmacAuthentication,
EncryptionConfiguration encryptionPreference)
Erzeugt einen neuen Parametersatz mit den angegebenen Werten.
|
ClientDavParameters(java.lang.String configurationPid,
java.lang.String address,
int subAddress,
java.lang.String userName,
java.lang.String userPassword,
java.lang.String applicationName,
java.lang.String authentificationProcessName,
int maxTelegramSize,
long receiveKeepAliveTimeout,
long sendKeepAliveTimeout,
int outputBufferSize,
int inputBufferSize,
java.lang.String communicationProtocolName)
Deprecated.
Benutzername und Passwort sollte direkt bei
ClientDavInterface.login(String, ClientCredentials) übergeben werden |
Modifier and Type | Method and Description |
---|---|
void |
addAspectRedirection(java.lang.String attributeGroupPid,
java.lang.String aspectPid,
java.lang.String substituteAspectPid)
Setzt eine Aspektumleitung für eine Kombination von Attributgruppe und Aspekt.
|
java.lang.String |
aspectToSubstitute(java.lang.String attributeGroupPid,
java.lang.String aspectPid)
Gibt die Aspektumleitung für eine Kombination von Attributgruppe und Aspekt zurück.
|
ClientDavParameters |
clone() |
ClientDavParameters |
clone(boolean readonly)
Erstellt eine Kopie dieses Objekts
|
int |
getAdjustedInputBufferSize()
Gibt die Größe der anteiligen Empfangs-Puffergröße zurück, den diese Verbindung benutzt.
|
int |
getAdjustedOutputBufferSize()
Gibt die Größe der anteiligen Empfangs-Puffergröße zurück, den diese Verbindung benutzt.
|
java.lang.String |
getApplicationName()
Bestimmt den Namen der Applikation.
|
java.lang.String |
getApplicationNameForLocalConfigurationCache()
Bestimmt den Namen der Applikation, der im Namen der lokalen Cache-Datei für Konfigurationsdaten verwendet werden soll.
|
java.lang.String |
getApplicationTypePid()
Bestimmt den Typ der Applikation.
|
java.lang.String |
getAuthentificationProcessName()
Bestimmt das bei der Authentifizierung zu verwendende Verfahren.
|
float |
getCacheThresholdPercentage()
Deprecated.
Wird durch
getThroughputControlSendBufferFactor() ersetzt. |
ClientCredentials |
getClientCredentials()
Gibt das Passwort oder den Login-Token zur Anmeldung am Datenverteiler zurück
|
int |
getCommunicationInputBufferSize()
Bestimmt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
|
int |
getCommunicationOutputBufferSize()
Bestimmt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
|
CommunicationParameters |
getCommunicationParameters()
Gibt die Parameter für die Kommunikation zwischen Applikation und Datenverteiler zurück.
|
long |
getCommunicationSendFlushDelay()
Bestimmt die Verzögerungszeit zur Übertragung von gepufferten und zu versendenden Telegrammen.
|
java.lang.String |
getConfigurationPath()
Bestimmt den Ort zum Zwischenspeichern der Konfiguration.
|
java.lang.String |
getConfigurationPid()
Bestimmt die PID der zu verwendenden Konfiguration.
|
java.lang.String |
getDavCommunicationAddress()
Bestimmt die Kommunikationsaddresse des Datenverteilers, die für den
Verbindungsaufbau benutzt werden soll. |
int |
getDavCommunicationSubAddress()
Bestimmt die Kommunikationssubaddresse des Datenverteilers, die für den
Verbindungsaufbau benutzt werden soll. |
int |
getDeliveryBufferSize()
Liefert die Größe des Auslieferungspuffers, der zur Zwischenspeicherung von Datensätzen genutzt wird, die an einen Empfänger der Applikation versendet werden sollen.
|
EncryptionConfiguration |
getEncryptionPreference()
Gibt die bevorzugte Verschlüsselungskonfiguration zurück.
|
long |
getFlowControlThresholdTime()
Deprecated.
Wird durch
getThroughputControlInterval() ersetzt. |
java.lang.String |
getIncarnationName()
Liefert den via Aufrufparameter von Start/Stopp vorgegebenen Inkarnationsnamen.
|
java.lang.String |
getLowLevelCommunicationName()
Bestimmt das auf unterster Ebene einzusetzende Kommunikationsprotokoll für die Kommunikation mit dem Datenverteiler.
|
int |
getMaxDataTelegramSize()
Bestimmt die maximale Größe von Datentelegrammen.
|
int |
getMinConnectionSpeed()
Deprecated.
Wird durch
getMinimumThroughput() ersetzt. |
int |
getMinimumThroughput()
Deprecated.
Wert kann aus den
CommunicationParameters gelesen werden. |
int |
getPasswordIndex()
Gibt den Einmalpasswortindex zurück
|
long |
getReceiveKeepAliveTimeout()
Deprecated.
Wert kann aus den
CommunicationParameters gelesen werden. |
double |
getSecondaryConnectionBufferRatio()
Gibt den Anteil von den Puffergrößen der zweiten für Konfigurationsanfragen (falls verwendet) zurück
|
ClientDavParameters |
getSecondConnectionParameters() |
long |
getSendKeepAliveTimeout()
Deprecated.
Wert kann aus den
CommunicationParameters gelesen werden. |
short |
getSimulationVariant()
Bestimmt die Standardmäßig zu verwendende Simulationsvariante.
|
long |
getThroughputControlInterval()
Deprecated.
Wert kann aus den
CommunicationParameters gelesen werden. |
float |
getThroughputControlSendBufferFactor()
Deprecated.
Wert kann aus den
CommunicationParameters gelesen werden. |
java.lang.String |
getUserName()
Bestimmt den bei der
Authentifizierung zu verwendenden Benutzernamen. |
java.lang.String |
getUserPassword()
Deprecated.
getClientCredentials() erlaubt auch das Abfragen von Login-Token |
UserProperties |
getUserProperties()
Gibt die Authentifizierungsdatei bzw.
|
boolean |
getUseSecondConnection()
Gibt true zurück, wenn eine zweite ClientDavConnection für Konfigurationsanfragen benutzt werden soll
|
boolean |
isConnectionForTests()
Gibt an, ob die Verbindung für Testzwecken aufgebaut werden soll.
|
boolean |
isHmacAuthenticationAllowed()
Gibt true zurück, wenn die alte Hmac-basierte Authentifizierung erlaubt ist
|
boolean |
isSecondConnection() |
boolean |
isSelfClientDavConnection()
Gibt true zurück, wenn es sich um die eigene Verbindung des Datenverteilers handelt
|
static void |
printArgumentsList()
Gibt die eingestellten Parameter auf die Standardausgabe aus.
|
void |
setAllowHmacAuthentication(boolean allowHmacAuthentication)
Setzt, ob die alte Hmac-Authentifizierugn erlaubt sein soll
|
void |
setApplicationName(java.lang.String applicationName)
Setzt den Namen der Applikation.
|
void |
setApplicationTypePid(java.lang.String applicationTypePid)
Setzt den Typ der Applikation.
|
void |
setAuthentificationProcessName(java.lang.String authentificationProcessName)
Setzt das bei der Authentifizierung zu verwendende Verfahren.
|
void |
setCacheThresholdPercentage(float cacheThresholdPercentage)
Deprecated.
Wird durch
setThroughputControlSendBufferFactor(float) ersetzt. |
void |
setCommunicationInputBufferSize(int bufferSize)
Setzt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
|
void |
setCommunicationOutputBufferSize(int bufferSize)
Setzt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
|
void |
setCommunicationSendFlushDelay(long delay)
Setzt die Verzögerungszeit zur Übertragung von gepufferten und zu versendenden Telegrammen.
|
void |
setConfigurationPath(java.lang.String configurationPath)
Setzt den Ort zum Zwischenspeichern der Konfiguration.
|
void |
setConfigurationPid(java.lang.String configurationPid)
Setzt die PID der zu verwendenden Konfiguration.
|
void |
setConnectionForTests(boolean connectionForTests)
Legt fest, ob eine Verbindung für Testzwecke aufgebaut werden soll.
|
void |
setDavCommunicationAddress(java.lang.String address)
Setzt die Kommunikationsaddresse des Datenverteilers, die für den
Verbindungsaufbau benutzt werden soll. |
void |
setDavCommunicationSubAddress(int subAddress)
Setzt die Kommunikationssubaddresse des Datenverteilers, die für den
Verbindungsaufbau benutzt werden soll. |
void |
setDeliveryBufferSize(int deliveryBufferSize)
Setzt die Größe des Auslieferungspuffers, der zur Zwischenspeicherung von Datensätzen genutzt wird, die an einen Empfänger der Applikation versendet werden sollen.
|
void |
setEncryptionPreference(EncryptionConfiguration encryptionPreference)
Setzt ob die Verbindung verschlüsselt werden soll
|
void |
setFlowControlThresholdTime(long flowControlThresholdTime)
Deprecated.
Wird durch
setThroughputControlInterval(long) ersetzt. |
void |
setLowLevelCommunicationName(java.lang.String lowLevelCommunicationName)
Setzt das auf unterster Ebene einzusetzende Kommunikationsprotokoll.
|
void |
setMaxDataTelegramSize(int maxTelegramSize)
Setzt die maximale Größe von Datentelegrammen.
|
void |
setMinConnectionSpeed(int minConnectionSpeed)
Deprecated.
Wird durch
setMinimumThroughput(int) ersetzt. |
void |
setMinimumThroughput(int throughput)
Deprecated.
Wert kann in den
CommunicationParameters gesetzt werden. |
void |
setPasswordIndex(int passwordIndex)
Setzt den Einmalpasswortindex
|
void |
setReceiveKeepAliveTimeout(long timeout)
Deprecated.
Wert kann in den
CommunicationParameters gesetzt werden. |
void |
setSecondaryConnectionBufferRatio(double secondaryConnectionBufferRatio)
Setzt den Anteil an den Puffergrößen, den die zweite Verbindung für Konfigurationsanfragen verwendet (falls vorhanden)
|
void |
setSendKeepAliveTimeout(long timeout)
Deprecated.
Wert kann in den
CommunicationParameters gesetzt werden. |
void |
setSimulationVariant(short variant)
Setzt die Standardmäßig zu verwendende Simulationsvariante.
|
void |
setThroughputControlInterval(long interval)
Deprecated.
Wert kann in den
CommunicationParameters gesetzt werden. |
void |
setThroughputControlSendBufferFactor(float sendBufferFactor)
Deprecated.
Wert kann in den
CommunicationParameters gesetzt werden. |
void |
setUserName(java.lang.String userName)
Setzt den bei der
Authentifizierung zu verwendenden Benutzernamen (und ggf. den Passwortindex). |
void |
setUserPassword(java.lang.String userPassword)
Deprecated.
Das Passwort bitte direkt bei
ClientDavInterface.login(String, ClientCredentials) übergeben. |
void |
setUserProperties(UserProperties userProperties)
Setzt die Authentifizierungsdatei/Passwortdatenbank
|
void |
setUseSecondConnection(boolean useSecondConnection)
Setzt, ob eine zweite ClientDavConnection für Konfigurationsanfragen benutzt werden soll, sonst false
|
java.lang.String |
substituteToAspect(java.lang.String attributeGroupPid,
java.lang.String aspectPid)
Gibt den Original-Aspekt eines ersetzten Aspekts einer Attributgruppe zurück.
|
public ClientDavParameters() throws MissingParameterException
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter.
MissingParameterException
- Bei formalen Fehlern beim Lesen der Defaultwerte.public ClientDavParameters(ArgumentList argumentList) throws MissingParameterException
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter und setzt die in den übergebenen Aufrufargumenten angegebenen Parameter mit den jeweils angegebenen Werten. Der Konstruktor implementiert die Starterschnittstelle der Datenverteilerapplikationsfunktionen. Bekannte Aufrufargumente werden nach der Umsetzung auf null
gesetzt, um der Applikation zu signalisieren, daß diese Argumente bereits interpretiert wurden. Unbekannte Aufrufargumente werden ignoriert. Es ist Aufgabe der Applikation die verbleibenden Argumente zu interpretieren, bzw. eine ensprechende Fehlermeldung zu erzeugen, wenn die Argumente nicht interpretiert werden können.
argumentList
- Argumentliste mit den beim Programmstart übergebenen Aufrufargumenten.MissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.public ClientDavParameters(java.lang.String[] startArguments) throws MissingParameterException
Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter und setzt die in den übergebenen Aufrufargumenten angegebenen Parameter mit den jeweils angegebenen Werten. Der Konstruktor implementiert die Starterschnittstelle der Datenverteilerapplikationsfunktionen. Bekannte Aufrufargumente werden nach der Umsetzung auf null
gesetzt, um der Applikation zu signalisieren, daß diese Argumente bereits interpretiert wurden. Unbekannte Aufrufargumente werden ignoriert. Es ist Aufgabe der Applikation die verbleibenden Argumente zu interpretieren, bzw. eine ensprechende Fehlermeldung zu erzeugen, wenn die Argumente nicht interpretiert werden können.
startArguments
- Die beim Programmstart übergebenen AufrufargumenteMissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.@Deprecated public ClientDavParameters(java.lang.String configurationPid, java.lang.String address, int subAddress, java.lang.String userName, java.lang.String userPassword, java.lang.String applicationName, java.lang.String authentificationProcessName, int maxTelegramSize, long receiveKeepAliveTimeout, long sendKeepAliveTimeout, int outputBufferSize, int inputBufferSize, java.lang.String communicationProtocolName) throws MissingParameterException
ClientDavInterface.login(String, ClientCredentials)
übergeben werdenErzeugt einen neuen Parametersatz mit den angegebenen Werten.
configurationPid
- Pid der Konfigurationaddress
- Kommunikationsadresse des Datenverteilers (IP-Adresse oder Rechnername)subAddress
- Kommunikationssubadresse des Datenverteilers (TCP-Portnummer)userName
- BenutzernameuserPassword
- BenutzerpasswortapplicationName
- ApplikationsnameauthentificationProcessName
- Klasse, die zur Authentifizierung genutzt werden sollmaxTelegramSize
- Maximale TelegrammgrößereceiveKeepAliveTimeout
- KeepAlive-Timeout beim Empfang von Telegrammen in Millisekunden.sendKeepAliveTimeout
- KeepAlive-Timeout beim Versand von Telegrammen in Millisekunden.outputBufferSize
- Größe des Sendepuffers in Bytes, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.inputBufferSize
- Größe des Empfangspuffers in Bytes, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.communicationProtocolName
- Klassenname des zu verwendenden KommunikationsprotokollsMissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.public ClientDavParameters(java.lang.String configurationPid, java.lang.String address, int subAddress, java.lang.String userName, java.lang.String applicationName, java.lang.String authentificationProcessName, int maxTelegramSize, long receiveKeepAliveTimeout, long sendKeepAliveTimeout, int outputBufferSize, int inputBufferSize, java.lang.String communicationProtocolName, boolean allowHmacAuthentication, EncryptionConfiguration encryptionPreference) throws MissingParameterException
Erzeugt einen neuen Parametersatz mit den angegebenen Werten.
configurationPid
- Pid der Konfigurationaddress
- Kommunikationsadresse des Datenverteilers (IP-Adresse oder Rechnername)subAddress
- Kommunikationssubadresse des Datenverteilers (TCP-Portnummer)userName
- BenutzernameapplicationName
- ApplikationsnameauthentificationProcessName
- Klasse, die zur Authentifizierung genutzt werden sollmaxTelegramSize
- Maximale TelegrammgrößereceiveKeepAliveTimeout
- KeepAlive-Timeout beim Empfang von Telegrammen in Millisekunden.sendKeepAliveTimeout
- KeepAlive-Timeout beim Versand von Telegrammen in Millisekunden.outputBufferSize
- Größe des Sendepuffers in Bytes, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.inputBufferSize
- Größe des Empfangspuffers in Bytes, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.communicationProtocolName
- Klassenname des zu verwendenden KommunikationsprotokollsallowHmacAuthentication
- Ob die alte Authentifizierung erlaubt istencryptionPreference
- Art der VerschlüsselungMissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.public boolean isConnectionForTests()
Gibt an, ob die Verbindung für Testzwecken aufgebaut werden soll.
Wird die Verbindung für Testzwecken aufgebaut, so können zum Beispiel Anmeldungen stattfinden, die mit einer normalen Verbindung nicht möglich sind.
Wurde dieser Wert nicht gesetzt (im Konstruktor oder über den Setter) so wird immer false
zurückgegeben.
public void setConnectionForTests(boolean connectionForTests)
Legt fest, ob eine Verbindung für Testzwecke aufgebaut werden soll.
connectionForTests
- true = Ja, es handelt sich um eine Verbindung, die nur für Testzwecke benutzt wird; false = Es handelt sich um eine normale Verbindung, die zum Datenverteiler aufgebaut werden soll.isConnectionForTests()
@Deprecated public final float getThroughputControlSendBufferFactor()
CommunicationParameters
gelesen werden.Bestimmt den Füllgrad des Sendepuffers bei dem die Durchsatzprüfung gestartet wird.
getCommunicationParameters()
@Deprecated public final float getCacheThresholdPercentage()
getThroughputControlSendBufferFactor()
ersetzt.Bestimmt den Füllgrad des Sendepuffers bei dem die Durchsatzprüfung gestartet wird.
@Deprecated public final void setThroughputControlSendBufferFactor(float sendBufferFactor)
CommunicationParameters
gesetzt werden.Definiert den Füllgrad des Sendepuffers bei dem die Durchsatzprüfung gestartet wird.
sendBufferFactor
- Füllgrad des Sendepuffers als Wert zwischen 0 und 1.getCommunicationParameters()
@Deprecated public final void setCacheThresholdPercentage(float cacheThresholdPercentage)
setThroughputControlSendBufferFactor(float)
ersetzt.Definiert den Füllgrad des Sendepuffers bei dem die Durchsatzprüfung gestartet wird.
cacheThresholdPercentage
- Füllgrad des Sendepuffers als Wert zwischen 0 und 1.@Deprecated public final long getThroughputControlInterval()
CommunicationParameters
gelesen werden.Bestimmt die Intervalldauer für die Durchsatzmessung bei aktivierter Durchsatzprüfung.
getCommunicationParameters()
@Deprecated public final long getFlowControlThresholdTime()
getThroughputControlInterval()
ersetzt.Bestimmt die Intervalldauer für die Durchsatzmessung bei aktivierter Durchsatzprüfung.
@Deprecated public final void setThroughputControlInterval(long interval)
CommunicationParameters
gesetzt werden.Setzt die Intervalldauer für die Durchsatzmessung bei aktivierter Durchsatzprüfung.
interval
- Intervalldauer in Millisekunden.getCommunicationParameters()
@Deprecated public final void setFlowControlThresholdTime(long flowControlThresholdTime)
setThroughputControlInterval(long)
ersetzt.Setzt die Intervalldauer für die Durchsatzmessung bei aktivierter Durchsatzprüfung.
flowControlThresholdTime
- Intervalldauer in Millisekunden.@Deprecated public final int getMinimumThroughput()
CommunicationParameters
gelesen werden.Bestimmt den minimal erlaubten Verbindungsdurchsatz bei aktivierter Durchsatzprüfung.
getCommunicationParameters()
@Deprecated public final int getMinConnectionSpeed()
getMinimumThroughput()
ersetzt.Bestimmt der minimum Verbindungsdurchsatz
@Deprecated public final void setMinimumThroughput(int throughput)
CommunicationParameters
gesetzt werden.Setzt den minimal erlaubten Verbindungsdurchsatz bei aktivierter Durchsatzprüfung.
throughput
- Mindestdurchsatz in Byte pro Sekunde.getCommunicationParameters()
@Deprecated public final void setMinConnectionSpeed(int minConnectionSpeed)
setMinimumThroughput(int)
ersetzt.Setzt den minimal erlaubten Verbindungsdurchsatz bei aktivierter Durchsatzprüfung.
minConnectionSpeed
- Mindestdurchsatz in Byte pro Sekunde.public final java.lang.String getApplicationName()
Bestimmt den Namen der Applikation.
setApplicationName(java.lang.String)
public final java.lang.String getApplicationNameForLocalConfigurationCache()
Bestimmt den Namen der Applikation, der im Namen der lokalen Cache-Datei für Konfigurationsdaten verwendet werden soll. Der Applikationsname kann mit dem Aufrufparameter -lokaleSpeicherungKonfiguration=pfadname:applikationsname von außen vorgegeben werden. Wenn das Aufrufargument -lokaleSpeicherungKonfiguration nicht benutzt wurde oder im angegebenen Argument kein mit Doppelpunkt getrennter Name angegeben wurde, dann gibt diese Methode den gleichen Wert zurück, wie die Methode getApplicationName()
.
public final void setApplicationName(java.lang.String applicationName)
Setzt den Namen der Applikation. Nach erfolgreicher Authentifizierung der Applikation wird vom Datenverteiler ein Applikations-Objekt mit dem angegebenem Namen erzeugt. Wenn diese Methode nicht aufgerufen wird, dann wird als Default der Name “TestApplikation” benutzt.
applicationName
- Name des zu erzeugenden Applikations-ObjektssetApplicationTypePid(java.lang.String)
public final java.lang.String getApplicationTypePid()
Bestimmt den Typ der Applikation.
setApplicationTypePid(java.lang.String)
public final void setApplicationTypePid(java.lang.String applicationTypePid)
Setzt den Typ der Applikation. Nach erfolgreicher Authentifizierung der Applikation wird vom Datenverteiler ein Applikations-Objekt erzeugt. Der Typ dieses Objekts entspricht dem hier übergebenen Typ. Wenn diese Methode nicht aufgerufen wird, dann wird als Default der Typ “typ.applikation” benutzt.
applicationTypePid
- PID, die den Typ des zu erzeugenden Applikations-Objekts spezifiziert.setApplicationName(java.lang.String)
public final java.lang.String getAuthentificationProcessName()
Bestimmt das bei der Authentifizierung zu verwendende Verfahren.
public final void setAuthentificationProcessName(java.lang.String authentificationProcessName)
Setzt das bei der Authentifizierung zu verwendende Verfahren. Wird die Methode nicht aufgerufen, dann wird das Verfahren HMAC-MD5 benutzt.
authentificationProcessName
- Klassenname des Verfahrenspublic final java.lang.String getLowLevelCommunicationName()
Bestimmt das auf unterster Ebene einzusetzende Kommunikationsprotokoll für die Kommunikation mit dem Datenverteiler.
public final void setLowLevelCommunicationName(java.lang.String lowLevelCommunicationName)
Setzt das auf unterster Ebene einzusetzende Kommunikationsprotokoll. Wird diese Methode nicht aufgerufen, dann wird das TCP-Protokoll benutzt.
lowLevelCommunicationName
- Klassenname des Kommunikationsverfahrens.public final java.lang.String getDavCommunicationAddress()
Bestimmt die Kommunikationsaddresse des Datenverteilers, die für den Verbindungsaufbau
benutzt werden soll.
setDavCommunicationAddress(java.lang.String)
public final void setDavCommunicationAddress(java.lang.String address)
Setzt die Kommunikationsaddresse des Datenverteilers, die für den Verbindungsaufbau
benutzt werden soll. Wenn als Kommunikationsprotokoll TCP eingesetzt wird, dann kann hier der Rechnername oder die IP-Addresse des Rechners auf dem der Datenverteiler läuft angegeben werden.
address
- Kommunikationsadresse des Datenverteilers (IP-Addresse oder Rechnername bei TCP).public final int getDavCommunicationSubAddress()
Bestimmt die Kommunikationssubaddresse des Datenverteilers, die für den Verbindungsaufbau
benutzt werden soll.
setDavCommunicationSubAddress(int)
public final void setDavCommunicationSubAddress(int subAddress)
Setzt die Kommunikationssubaddresse des Datenverteilers, die für den Verbindungsaufbau
benutzt werden soll. Wenn als Kommunikationsprotokoll TCP eingesetzt wird, dann kann hier die TCP-Portnummer, auf der der Datenverteiler Verbindungen entgegennimmt, angegeben werden.
subAddress
- Kommunikationssubadresse des Datenverteilers.public final java.lang.String getConfigurationPid()
Bestimmt die PID der zu verwendenden Konfiguration.
public final void setConfigurationPid(java.lang.String configurationPid)
Setzt die PID der zu verwendenden Konfiguration. Wenn die Methode nicht aufgerufen wird, dann wird die Standard-Konfiguration des Datenverteilers benutzt.
configurationPid
- PID der zu verwendenden Konfiguration.public final java.lang.String getConfigurationPath()
Bestimmt den Ort zum Zwischenspeichern der Konfiguration.
null
, wenn die Konfigurationsdaten nicht lokal zwischengespeichert werden.public final void setConfigurationPath(java.lang.String configurationPath)
Setzt den Ort zum Zwischenspeichern der Konfiguration. Wenn kein Ort spezifiziert wurde, dann wird die Konfiguration nicht zwischengespeichert.
configurationPath
- Pfad im lokalen Dateisystem in dem die Konfigurationsdaten zwischengespeichert werden sollen oder null
, falls die Konfigurationsdaten nicht lokal zwischengespeichert werden sollen.public final java.lang.String getUserName()
Bestimmt den bei der Authentifizierung
zu verwendenden Benutzernamen.
public final void setUserName(java.lang.String userName)
Setzt den bei der Authentifizierung
zu verwendenden Benutzernamen (und ggf. den Passwortindex).
userName
- Name des Benutzers.@Deprecated public final java.lang.String getUserPassword()
getClientCredentials()
erlaubt auch das Abfragen von Login-TokenBestimmt das bei der Authentifizierung
zu verwendende Passwort.
@Deprecated public final void setUserPassword(java.lang.String userPassword)
ClientDavInterface.login(String, ClientCredentials)
übergeben.Setzt das bei der Authentifizierung
zu verwendende Passwort.
userPassword
- Passwort des Benutzers.public ClientCredentials getClientCredentials()
Gibt das Passwort oder den Login-Token zur Anmeldung am Datenverteiler zurück
public void setUserProperties(UserProperties userProperties)
Setzt die Authentifizierungsdatei/Passwortdatenbank
userProperties
- Authentifizierungsdatei/Passwortdatenbankpublic UserProperties getUserProperties()
Gibt die Authentifizierungsdatei bzw. Passwortdatenbank zurück
@Deprecated public final long getSendKeepAliveTimeout()
CommunicationParameters
gelesen werden.Bestimmt das Timeout zum Senden von KeepAlive-Telegrammen. Der Wert dient als Vorschlag für die Verhandlung mit dem Datenverteiler, der den zu verwendenden Wert festlegt.
getCommunicationParameters()
@Deprecated public final void setSendKeepAliveTimeout(long timeout)
CommunicationParameters
gesetzt werden.Setzt das Timeout zum Senden von KeepAlive-Telegrammen. Der Wert dient als Vorschlag für die Verhandlung mit dem Datenverteiler, der den zu verwendenden Wert festlegt.
timeout
- Vorschlag für das Timeout zum Senden von KeepAlive-Telegrammen in Millisekunden.getCommunicationParameters()
@Deprecated public final long getReceiveKeepAliveTimeout()
CommunicationParameters
gelesen werden.Bestimmt das KeepAlive-Timeout beim Empfang von Telegrammen. Der Wert dient als Vorschlag für die Verhandlung mit dem Datenverteiler, der den zu verwendenden Wert festlegt.
getCommunicationParameters()
@Deprecated public final void setReceiveKeepAliveTimeout(long timeout)
CommunicationParameters
gesetzt werden.Setzt das KeepAlive-Timeout beim Empfang von Telegrammen. Der Wert dient als Vorschlag für die Verhandlung mit dem Datenverteiler, der den zu verwendenden Wert festlegt.
timeout
- Vorschlag für das KeepAlive-Timeout beim Empfang von Telegrammen in Millisekunden.getCommunicationParameters()
public final short getSimulationVariant()
Bestimmt die Standardmäßig zu verwendende Simulationsvariante.
setSimulationVariant(short)
public final void setSimulationVariant(short variant)
Setzt die Standardmäßig zu verwendende Simulationsvariante. Wenn die Methode nicht aufgerufen wird, wird die Variante 0
benutzt, wenn sie nicht explizit angegeben wurde.
variant
- Zu verwendende Simulationsvariante.DataDescription
public final long getCommunicationSendFlushDelay()
Bestimmt die Verzögerungszeit zur Übertragung von gepufferten und zu versendenden Telegrammen.
setCommunicationSendFlushDelay(long)
public final void setCommunicationSendFlushDelay(long delay)
Setzt die Verzögerungszeit zur Übertragung von gepufferten und zu versendenden Telegrammen. Die Übertragung der gesammelten Daten im Sendepuffer findet erst statt, wenn die hier angegebene Zeit lang keine Daten mehr in der Puffer geschrieben wurden oder der Sendepuffer voll ist.
delay
- Sende-Verzögerungszeit in Millisekunden.public final int getCommunicationOutputBufferSize()
Bestimmt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
public final void setCommunicationOutputBufferSize(int bufferSize)
Setzt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
bufferSize
- Größe des Sendepuffers in Bytes.public final int getCommunicationInputBufferSize()
Bestimmt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
public final void setCommunicationInputBufferSize(int bufferSize)
Setzt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.
bufferSize
- Größe des Empfangspuffers in Bytes.public final int getAdjustedInputBufferSize()
Gibt die Größe der anteiligen Empfangs-Puffergröße zurück, den diese Verbindung benutzt.
public final int getAdjustedOutputBufferSize()
Gibt die Größe der anteiligen Empfangs-Puffergröße zurück, den diese Verbindung benutzt.
public double getSecondaryConnectionBufferRatio()
Gibt den Anteil von den Puffergrößen der zweiten für Konfigurationsanfragen (falls verwendet) zurück
public void setSecondaryConnectionBufferRatio(double secondaryConnectionBufferRatio)
Setzt den Anteil an den Puffergrößen, den die zweite Verbindung für Konfigurationsanfragen verwendet (falls vorhanden)
secondaryConnectionBufferRatio
- Anteil zwischen 0.0 und 1.0, der angibt wie groß der Puffer der zweiten Verbidnung im Verhältnis zur Gesamtpuffergröße sein soll.public final int getMaxDataTelegramSize()
Bestimmt die maximale Größe von Datentelegrammen. Größere Telegramme werden in mehrere Telegramme zerlegt.
public final void setMaxDataTelegramSize(int maxTelegramSize)
Setzt die maximale Größe von Datentelegrammen. Größere Telegramme werden in mehrere Telegramme zerlegt.
maxTelegramSize
- Maximale Größe von versendeten Datentelegrammen als Anzahl von Bytes.public CommunicationParameters getCommunicationParameters()
Gibt die Parameter für die Kommunikation zwischen Applikation und Datenverteiler zurück.
public boolean isHmacAuthenticationAllowed()
Gibt true zurück, wenn die alte Hmac-basierte Authentifizierung erlaubt ist
public EncryptionConfiguration getEncryptionPreference()
Gibt die bevorzugte Verschlüsselungskonfiguration zurück.
public void setAllowHmacAuthentication(boolean allowHmacAuthentication)
Setzt, ob die alte Hmac-Authentifizierugn erlaubt sein soll
allowHmacAuthentication
- public void setEncryptionPreference(EncryptionConfiguration encryptionPreference)
Setzt ob die Verbindung verschlüsselt werden soll
encryptionPreference
- public final void addAspectRedirection(java.lang.String attributeGroupPid, java.lang.String aspectPid, java.lang.String substituteAspectPid)
Setzt eine Aspektumleitung für eine Kombination von Attributgruppe und Aspekt. Ein von der Applikation angegebener Aspekt beim Anmelden, Lesen, Schreiben und Abmelden einer Attributgruppe, wird durch einen anderen Aspekt ersetzt. Damit besteht die Möglichkeit den Datenfluß einer Applikation zu modifizieren und damit beispielsweise einen anderen Prozess in eine Bearbeitungskette einzufügen.
attributeGroupPid
- PID der Attributgruppe für die eine Umleitung eingefügt werden soll.aspectPid
- PID des Aspekts für den eine Umleitung eingefügt werden soll.substituteAspectPid
- PID des statt aspectPid
zu verwendenden Aspekts.public final java.lang.String aspectToSubstitute(java.lang.String attributeGroupPid, java.lang.String aspectPid)
Gibt die Aspektumleitung für eine Kombination von Attributgruppe und Aspekt zurück. Wenn keine entsprechende Aspektumleitung besteht, wird der übergebene Original-Aspekt zurückgegeben.
attributeGroupPid
- PID der Attributgruppe.aspectPid
- PID des Original-Aspekts.addAspectRedirection(java.lang.String, java.lang.String, java.lang.String)
public final java.lang.String substituteToAspect(java.lang.String attributeGroupPid, java.lang.String aspectPid)
Gibt den Original-Aspekt eines ersetzten Aspekts einer Attributgruppe zurück. Wenn keine entsprechende Aspektumleitung besteht, wird der übergebene Aspekt unverändert zurückgegeben.
attributeGroupPid
- PID der Attributgruppe.aspectPid
- PID des ersetzten Aspekts.addAspectRedirection(java.lang.String, java.lang.String, java.lang.String)
public int getDeliveryBufferSize()
Liefert die Größe des Auslieferungspuffers, der zur Zwischenspeicherung von Datensätzen genutzt wird, die an einen Empfänger der Applikation versendet werden sollen.
public void setDeliveryBufferSize(int deliveryBufferSize)
Setzt die Größe des Auslieferungspuffers, der zur Zwischenspeicherung von Datensätzen genutzt wird, die an einen Empfänger der Applikation versendet werden sollen.
deliveryBufferSize
- Größe des Auslieferungspuffers in Bytes.public java.lang.String getIncarnationName()
Liefert den via Aufrufparameter von Start/Stopp vorgegebenen Inkarnationsnamen.
""
, falls das entsprechende Aufrufargument nicht angegeben wurde.public boolean getUseSecondConnection()
Gibt true zurück, wenn eine zweite ClientDavConnection für Konfigurationsanfragen benutzt werden soll
public void setUseSecondConnection(boolean useSecondConnection)
Setzt, ob eine zweite ClientDavConnection für Konfigurationsanfragen benutzt werden soll, sonst false
useSecondConnection
- ob eine zweite ClientDavConnection für Konfigurationsanfragen benutzt werdenpublic boolean isSecondConnection()
public ClientDavParameters getSecondConnectionParameters()
public boolean isSelfClientDavConnection()
Gibt true zurück, wenn es sich um die eigene Verbindung des Datenverteilers handelt
public int getPasswordIndex()
Gibt den Einmalpasswortindex zurück
public void setPasswordIndex(int passwordIndex)
Setzt den Einmalpasswortindex
passwordIndex
- Einmalpasswortindex oder -1 für einen normalen Loginpublic final ClientDavParameters clone()
clone
in class java.lang.Object
public final ClientDavParameters clone(boolean readonly)
Erstellt eine Kopie dieses Objekts
readonly
- Soll die Kopie schreibgeschützt sein? Erlaubt sowohl das Entfernen als auch das Hinzufügen eines Schreibschutzes.public static void printArgumentsList()
Gibt die eingestellten Parameter auf die Standardausgabe aus.