|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.bsvrz.dav.daf.main.ClientDavParameters
public class ClientDavParameters
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 Summary | |
---|---|
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(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(String configurationPid,
String address,
int subAddress,
String userName,
String userPassword,
String applicationName,
String authentificationProcessName,
int maxTelegramSize,
long receiveKeepAliveTimeout,
long sendKeepAliveTimeout,
int outputBufferSize,
int inputBufferSize,
String communicationProtocolName)
Erzeugt einen neuen Parametersatz mit den angegebenen Werten. |
Method Summary | |
---|---|
void |
addAspectRedirection(String attributeGroupPid,
String aspectPid,
String substituteAspectPid)
Setzt eine Aspektumleitung für eine Kombination von Attributgruppe und Aspekt. |
String |
aspectToSubstitute(String attributeGroupPid,
String aspectPid)
Gibt die Aspektumleitung für eine Kombination von Attributgruppe und Aspekt zurück. |
String |
getApplicationName()
Bestimmt den Namen der Applikation. |
String |
getApplicationTypePid()
Bestimmt den Typ der Applikation. |
String |
getAuthentificationProcessName()
Bestimmt das bei der Authentifizierung zu verwendende Verfahren. |
float |
getCacheThresholdPercentage()
Deprecated. Wird durch getThroughputControlSendBufferFactor() ersetzt. |
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. |
String |
getConfigurationPath()
Bestimmt den Ort zum Zwischenspeichern der Konfiguration. |
String |
getConfigurationPid()
Bestimmt die PID der zu verwendenden Konfiguration. |
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. |
long |
getFlowControlThresholdTime()
Deprecated. Wird durch getThroughputControlInterval() ersetzt. |
String |
getIncarnationName()
Liefert den via Aufrufparameter von Start/Stopp vorgegebenen Inkarnationsnamen. |
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. |
long |
getReceiveKeepAliveTimeout()
Deprecated. Wert kann aus den CommunicationParameters gelesen werden. |
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. |
String |
getUserName()
Bestimmt den bei der Authentifizierung zu verwendenden Benutzernamen. |
String |
getUserPassword()
Bestimmt das bei der Authentifizierung zu verwendende Passwort. |
boolean |
isConnectionForTests()
Gibt an, ob die Verbindung für Testzwecken aufgebaut werden soll. |
static void |
printArgumentsList()
Gibt die eingestellten Parameter auf die Standardausgabe aus. |
void |
setApplicationName(String applicationName)
Setzt den Namen der Applikation. |
void |
setApplicationTypePid(String applicationTypePid)
Setzt den Typ der Applikation. |
void |
setAuthentificationProcessName(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(String configurationPath)
Setzt den Ort zum Zwischenspeichern der Konfiguration. |
void |
setConfigurationPid(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(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 |
setFlowControlThresholdTime(long flowControlThresholdTime)
Deprecated. Wird durch setThroughputControlInterval(long) ersetzt. |
void |
setLowLevelCommunicationName(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 |
setReceiveKeepAliveTimeout(long timeout)
Deprecated. Wert kann in den CommunicationParameters gesetzt werden. |
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(String userName)
Setzt den bei der Authentifizierung zu verwendenden Benutzernamen. |
void |
setUserPassword(String userPassword)
Setzt das bei der Authentifizierung zu verwendende Passwort. |
String |
substituteToAspect(String attributeGroupPid,
String aspectPid)
Gibt den Original-Aspekt eines ersetzten Aspekts einer Attributgruppe zurück. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClientDavParameters() throws MissingParameterException
MissingParameterException
- Bei formalen Fehlern beim Lesen der Defaultwerte.public ClientDavParameters(ArgumentList argumentList) throws MissingParameterException
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(String[] startArguments) throws MissingParameterException
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 Aufrufargumente
MissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.public ClientDavParameters(String configurationPid, String address, int subAddress, String userName, String userPassword, String applicationName, String authentificationProcessName, int maxTelegramSize, long receiveKeepAliveTimeout, long sendKeepAliveTimeout, int outputBufferSize, int inputBufferSize, String communicationProtocolName) throws MissingParameterException
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 Kommunikationsprotokolls
MissingParameterException
- Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.Method Detail |
---|
public boolean isConnectionForTests()
false
zurückgegeben.
public void setConnectionForTests(boolean connectionForTests)
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.
getCommunicationParameters()
@Deprecated public final float getCacheThresholdPercentage()
getThroughputControlSendBufferFactor()
ersetzt.
@Deprecated public final void setThroughputControlSendBufferFactor(float sendBufferFactor)
CommunicationParameters
gesetzt werden.
sendBufferFactor
- Füllgrad des Sendepuffers als Wert zwischen 0 und 1.getCommunicationParameters()
@Deprecated public final void setCacheThresholdPercentage(float cacheThresholdPercentage)
setThroughputControlSendBufferFactor(float)
ersetzt.
cacheThresholdPercentage
- Füllgrad des Sendepuffers als Wert zwischen 0 und 1.@Deprecated public final long getThroughputControlInterval()
CommunicationParameters
gelesen werden.
getCommunicationParameters()
@Deprecated public final long getFlowControlThresholdTime()
getThroughputControlInterval()
ersetzt.
@Deprecated public final void setThroughputControlInterval(long interval)
CommunicationParameters
gesetzt werden.
interval
- Intervalldauer in Millisekunden.getCommunicationParameters()
@Deprecated public final void setFlowControlThresholdTime(long flowControlThresholdTime)
setThroughputControlInterval(long)
ersetzt.
flowControlThresholdTime
- Intervalldauer in Millisekunden.@Deprecated public final int getMinimumThroughput()
CommunicationParameters
gelesen werden.
getCommunicationParameters()
@Deprecated public final int getMinConnectionSpeed()
getMinimumThroughput()
ersetzt.
@Deprecated public final void setMinimumThroughput(int throughput)
CommunicationParameters
gesetzt werden.
throughput
- Mindestdurchsatz in Byte pro Sekunde.getCommunicationParameters()
@Deprecated public final void setMinConnectionSpeed(int minConnectionSpeed)
setMinimumThroughput(int)
ersetzt.
minConnectionSpeed
- Mindestdurchsatz in Byte pro Sekunde.public final String getApplicationName()
setApplicationName(java.lang.String)
public final void setApplicationName(String applicationName)
applicationName
- Name des zu erzeugenden Applikations-ObjektssetApplicationTypePid(java.lang.String)
public final String getApplicationTypePid()
setApplicationTypePid(java.lang.String)
public final void setApplicationTypePid(String applicationTypePid)
applicationTypePid
- PID, die den Typ des zu erzeugenden Applikations-Objekts spezifiziert.setApplicationName(java.lang.String)
public final String getAuthentificationProcessName()
public final void setAuthentificationProcessName(String authentificationProcessName)
authentificationProcessName
- Klassenname des Verfahrenspublic final String getLowLevelCommunicationName()
public final void setLowLevelCommunicationName(String lowLevelCommunicationName)
lowLevelCommunicationName
- Klassenname des Kommunikationsverfahrens.public final String getDavCommunicationAddress()
Verbindungsaufbau
benutzt werden soll.
setDavCommunicationAddress(java.lang.String)
public final void setDavCommunicationAddress(String address)
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()
Verbindungsaufbau
benutzt werden soll.
setDavCommunicationSubAddress(int)
public final void setDavCommunicationSubAddress(int subAddress)
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 String getConfigurationPid()
public final void setConfigurationPid(String configurationPid)
configurationPid
- PID der zu verwendenden Konfiguration.public final String getConfigurationPath()
null
, wenn die Konfigurationsdaten nicht
lokal zwischengespeichert werden.public final void setConfigurationPath(String configurationPath)
configurationPath
- Pfad im lokalen Dateisystem in dem die Konfigurationsdaten zwischengespeichert werden sollen oder null
, falls die
Konfigurationsdaten nicht lokal zwischengespeichert werden sollen.public final String getUserName()
Authentifizierung
zu verwendenden Benutzernamen.
public final void setUserName(String userName)
Authentifizierung
zu verwendenden Benutzernamen.
userName
- Name des Benutzers.public final String getUserPassword()
Authentifizierung
zu verwendende Passwort.
public final void setUserPassword(String userPassword)
Authentifizierung
zu verwendende Passwort.
userPassword
- Passwort des Benutzers.@Deprecated public final long getSendKeepAliveTimeout()
CommunicationParameters
gelesen werden.
getCommunicationParameters()
@Deprecated public final void setSendKeepAliveTimeout(long timeout)
CommunicationParameters
gesetzt werden.
timeout
- Vorschlag für das Timeout zum Senden von KeepAlive-Telegrammen in Millisekunden.getCommunicationParameters()
@Deprecated public final long getReceiveKeepAliveTimeout()
CommunicationParameters
gelesen werden.
getCommunicationParameters()
@Deprecated public final void setReceiveKeepAliveTimeout(long timeout)
CommunicationParameters
gesetzt werden.
timeout
- Vorschlag für das KeepAlive-Timeout beim Empfang von Telegrammen in Millisekunden.getCommunicationParameters()
public final short getSimulationVariant()
setSimulationVariant(short)
public final void setSimulationVariant(short variant)
0
benutzt, wenn sie nicht
explizit angegeben wurde.
variant
- Zu verwendende Simulationsvariante.DataDescription
public final long getCommunicationSendFlushDelay()
setCommunicationSendFlushDelay(long)
public final void setCommunicationSendFlushDelay(long delay)
delay
- Sende-Verzögerungszeit in Millisekunden.public final int getCommunicationOutputBufferSize()
public final void setCommunicationOutputBufferSize(int bufferSize)
bufferSize
- Größe des Sendepuffers in Bytes.public final int getCommunicationInputBufferSize()
public final void setCommunicationInputBufferSize(int bufferSize)
bufferSize
- Größe des Empfangspuffers in Bytes.public final int getMaxDataTelegramSize()
public final void setMaxDataTelegramSize(int maxTelegramSize)
maxTelegramSize
- Maximale Größe von versendeten Datentelegrammen als Anzahl von Bytes.public CommunicationParameters getCommunicationParameters()
public final void addAspectRedirection(String attributeGroupPid, String aspectPid, String substituteAspectPid)
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 String aspectToSubstitute(String attributeGroupPid, String aspectPid)
attributeGroupPid
- PID der Attributgruppe.aspectPid
- PID des Original-Aspekts.
addAspectRedirection(java.lang.String, java.lang.String, java.lang.String)
public final String substituteToAspect(String attributeGroupPid, String aspectPid)
attributeGroupPid
- PID der Attributgruppe.aspectPid
- PID des ersetzten Aspekts.
addAspectRedirection(java.lang.String, java.lang.String, java.lang.String)
public int getDeliveryBufferSize()
public void setDeliveryBufferSize(int deliveryBufferSize)
deliveryBufferSize
- Größe des Auslieferungspuffers in Bytes.public String getIncarnationName()
""
, falls das entsprechende Aufrufargument nicht angegeben wurde.public static void printArgumentsList()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |