de.bsvrz.dav.dav.main
Class ServerDavParameters

java.lang.Object
  extended by de.bsvrz.dav.dav.main.ServerDavParameters

public class ServerDavParameters
extends Object

Diese Klasse stellt die Parameter des Datenverteilers auf Server-Seite zur Verfügung. Diese Parameter werden durch den Konstruktor oder durch entsprechende Setter-Methoden gesetzt und können durch entsprechende Getter-Methoden gelesen werden.

Author:
Kappich Systemberatung

Constructor Summary
ServerDavParameters(ArgumentList argumentList)
          Erzeugt einen neuen Parametersatz mit Defaultwerten für die einzelnen Parameter und setzt die in den übergebenen Aufrufargumenten angegebenen Parameter mit den angegebenen Werten.
 
Method Summary
 int getApplicationConnectionsSubAddress()
          Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.
 int getApplicationConnectionsSubAdress()
          Deprecated. Statt dieser Methode sollte die Methode getApplicationConnectionsSubAddress() verwendet werden.
 String getAuthentificationProcessName()
          Bestimmt das bei der Authentifizierung zu verwendende Verfahren.
 ClientDavParameters getClientDavParameters()
          Erzeugt einen neuen Parametersatz für eine Applikationsverbindung.
 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.
 long getCommunicationSendFlushDelay()
          Bestimmt die Verzögerungszeit zur Übertragung von gepufferten und zu versendenden Telegrammen.
 long getConfigurationId()
          Gibt die Konfigurationsid zurück
 String getConfigurationUserName()
          Gibt der Konfigurationsbenutzername zurück
 String getConfigurationUserPassword()
          Gibt der Konfigurationsbenutzerpasswort zurück
 long getDataTransmitterId()
          Gibt die Id des Datenverteilers zurück
 String getDataTransmitterName()
          Bestimmt den Namen des Datenverteilers.
 String getDataTransmitterTypePid()
          Bestimmt den Typ des Datenverteilers.
 long getInitialInterDavServerDelay()
           
 Object[] getLocalModeParameter()
          Gibt die Konfigurationsparameter des Lokalen Modus zurück.
 String getLowLevelCommunicationName()
          Bestimmt das auf unterster Ebene einzusetzende Kommunikationsprotokoll.
 int getMaxDataTelegramSize()
          Bestimmt die maximale Größe von Datentelegrammen.
 String getParameterUserName()
          Gibt der Parametrierungsbenutzername zurück
 String getParameterUserPassword()
          Gibt der Parametrierungsbenutzerpasswort zurück
 long getReceiveKeepAliveTimeout()
          Bestimmt das KeepAlive-Timeout beim Empfang von Telegrammen.
 Object[] getRemoteModeParameter()
          Gibt die Konfigurationsparameter des Remote-Modus zurück.
 long getSendKeepAliveTimeout()
          Bestimmt das Timeout zum Senden von KeepAlive-Telegrammen.
 String getStoredPassword(String userName)
          Bestimmt das in der Passwort-Datei gespeicherte Passwort eines bestimmten Benutzers.
 int getTransmitterConnectionsSubAddress()
          Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.
 int getTransmitterConnectionsSubAddressOffset()
          Liefert einen Offset für die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.
 int getTransmitterConnectionsSubAdress()
          Deprecated. Statt dieser Methode sollte die Methode getTransmitterConnectionsSubAddress() verwendet werden.
 String getUserName()
          Bestimmt den bei der Authentifizierung zu verwendenden Benutzernamen.
 String getUserPassword()
          Bestimmt das bei der Authentifizierung zu verwendende Passwort.
 boolean isLocalMode()
          Gibt die Information zurück, ob der Datenverteiler auf eine lokale Anmeldung einer Konfigurationsapplikation warten muss.
 boolean isUserRightsCheckingEnabled()
           
static void printArgumentsList()
          Gibt auf der Standardausgabe die möglichen Startargumente einer Datenverteilerapplikation aus.
 void setApplicationConnectionsSubAddress(int port)
          Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.
 void setApplicationConnectionsSubAdress(int port)
          Deprecated. Statt dieser Methode sollte die Methode setApplicationConnectionsSubAddress(int) verwendet werden.
 void setAuthentificationProcessName(String authentificationProcessName)
          Setzt das bei der Authentifizierung zu verwendende Verfahren.
 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 setConfigurationId(long configurationId)
          Setzt der Konfigurationsid auf den neuen Wert.
 void setConfigurationUserName(String configUserName)
          Setzt den Konfigurationsbenutzername auf den neuen Wert.
 void setConfigurationUserPassword(String configUserPassword)
          Setzt der Konfigurationsbenutzerpasswort auf den neuen Wert.
 void setDataTransmitterId(long dvId)
          Setzt die Id der Datenverteiler auf den neuen Wert
 void setDataTransmitterName(String dataTransmitterName)
          Setzt den Namen des Datenverteilers.
 void setDataTransmitterTypePid(String dataTransmitterTypePid)
          Setzt den Typ des Datenverteilers.
 void setLocalModeParameter(String configPid, long configId)
          Setzt den Datenverteilersbetriebsmodus auf den Lokalen Modus.
 void setLowLevelCommunicationName(String lowLevelCommunicationName)
          Setzt das auf unterster Ebene einzusetzende Kommunikationsprotokoll.
 void setMaxDataTelegramSize(int maxTelegramSize)
          Setzt die maximale Größe von Datentelegrammen.
 void setParameterUserName(String paramUserName)
          Setzt der Parametrierungsbenutzername auf den neuen Wert.
 void setParameterUserPassword(String paramUserPassword)
          Setzt der Parametrierungsbenutzerpasswort auf den neuen Wert.
 void setReceiveKeepAliveTimeout(long timeout)
          Setzt das KeepAlive-Timeout beim Empfang von Telegrammen.
 void setRemoteModeParameter(String configDataTransmitterAddress, int configDataTransmitterSubAddress, String configurationPid)
          Setzt den Datenverteilersbetriebsmodus auf den Remote-Modus.
 void setSendKeepAliveTimeout(long timeout)
          Setzt das Timeout zum Senden von KeepAlive-Telegrammen.
 void setTransmitterConnectionsSubAddress(int port)
          Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.
 void setTransmitterConnectionsSubAdress(int port)
          Deprecated. Statt dieser Methode sollte die Methode setTransmitterConnectionsSubAddress(int) verwendet 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerDavParameters

public ServerDavParameters(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 angegebenen Werten. Unbekannte Aufrufargumente werden ignoriert. Bekannte Aufrufargumente werden nach der Umsetzung auf null gesetzt, um zu signalisieren, daß diese Argumente bereits interpretiert wurden.

Parameters:
argumentList - Die auszuwertenden Aufrufargumente.
Throws:
MissingParameterException - Falls ein Argument nicht oder nicht korrekt angegeben wurde.
Method Detail

getStoredPassword

public String getStoredPassword(String userName)
Bestimmt das in der Passwort-Datei gespeicherte Passwort eines bestimmten Benutzers.

Parameters:
userName - Name des Benutzers
Returns:
Passwort des Benutzers oder null, wenn kein Passwort für den Benutzer in der Passwort-Datei enthalten ist.

getMaxDataTelegramSize

public final int getMaxDataTelegramSize()
Bestimmt die maximale Größe von Datentelegrammen. Größere Telegramme werden in mehrere Telegramme zerlegt.

Returns:
maxTelegramSize Maximale Größe von versendeten Datentelegrammen.

setMaxDataTelegramSize

public final void setMaxDataTelegramSize(int maxTelegramSize)
Setzt die maximale Größe von Datentelegrammen. Größere Telegramme werden in mehrere Telegramme zerlegt.

Parameters:
maxTelegramSize - Maximale Größe von versendeten Datentelegrammen.

getTransmitterConnectionsSubAddress

public final int getTransmitterConnectionsSubAddress()
Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet. Dies entspricht bei TCP-Verbindungen der TCP-Portnummer des Server-Sockets.

Returns:
Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

setTransmitterConnectionsSubAddress

public final void setTransmitterConnectionsSubAddress(int port)
Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

Parameters:
port - Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

getTransmitterConnectionsSubAdress

@Deprecated
public final int getTransmitterConnectionsSubAdress()
Deprecated. Statt dieser Methode sollte die Methode getTransmitterConnectionsSubAddress() verwendet werden.

Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet. Dies entspricht bei TCP-Verbindungen der TCP-Portnummer des Server-Sockets.

Returns:
Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

setTransmitterConnectionsSubAdress

@Deprecated
public final void setTransmitterConnectionsSubAdress(int port)
Deprecated. Statt dieser Methode sollte die Methode setTransmitterConnectionsSubAddress(int) verwendet werden.

Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

Parameters:
port - Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

getTransmitterConnectionsSubAddressOffset

public final int getTransmitterConnectionsSubAddressOffset()
Liefert einen Offset für die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

Returns:
Offset für die Subadresse mit der dieser Datenverteiler auf Verbindungen von anderen Datenverteilern wartet.

getApplicationConnectionsSubAddress

public final int getApplicationConnectionsSubAddress()
Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet. Dies entspricht bei TCP-Verbindungen der TCP-Portnummer des Server-Sockets.

Returns:
Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

setApplicationConnectionsSubAddress

public final void setApplicationConnectionsSubAddress(int port)
Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

Parameters:
port - Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

getApplicationConnectionsSubAdress

@Deprecated
public final int getApplicationConnectionsSubAdress()
Deprecated. Statt dieser Methode sollte die Methode getApplicationConnectionsSubAddress() verwendet werden.

Liefert die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet. Dies entspricht bei TCP-Verbindungen der TCP-Portnummer des Server-Sockets.

Returns:
Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

setApplicationConnectionsSubAdress

@Deprecated
public final void setApplicationConnectionsSubAdress(int port)
Deprecated. Statt dieser Methode sollte die Methode setApplicationConnectionsSubAddress(int) verwendet werden.

Setzt die Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

Parameters:
port - Subadresse mit der dieser Datenverteiler auf Verbindungen von Applikationen wartet.

getDataTransmitterId

public final long getDataTransmitterId()
Gibt die Id des Datenverteilers zurück

Returns:
die Datenverteiler Id

setDataTransmitterId

public final void setDataTransmitterId(long dvId)
Setzt die Id der Datenverteiler auf den neuen Wert

Parameters:
dvId - neue Datenverteiler Id

getDataTransmitterName

public final String getDataTransmitterName()
Bestimmt den Namen des Datenverteilers.

Returns:
applicationName Name des zu erzeugenden Applikation-Objekts

setDataTransmitterName

public final void setDataTransmitterName(String dataTransmitterName)
Setzt den Namen des Datenverteilers.

Parameters:
dataTransmitterName - Name des Datenverteilers

getDataTransmitterTypePid

public final String getDataTransmitterTypePid()
Bestimmt den Typ des Datenverteilers.

Returns:
dataTransmitterTypePid PID, die den Typ des Datenverteilers.

setDataTransmitterTypePid

public final void setDataTransmitterTypePid(String dataTransmitterTypePid)
Setzt den Typ des Datenverteilers.

Parameters:
dataTransmitterTypePid - PID, die den Typ des zu erzeugenden Applikations-Objekts spezifiziert.

getAuthentificationProcessName

public final String getAuthentificationProcessName()
Bestimmt das bei der Authentifizierung zu verwendende Verfahren.

Returns:
authentificationProcessName Name des Verfahrens

setAuthentificationProcessName

public final void setAuthentificationProcessName(String authentificationProcessName)
Setzt das bei der Authentifizierung zu verwendende Verfahren.

Parameters:
authentificationProcessName - Name des Verfahrens

getLowLevelCommunicationName

public final String getLowLevelCommunicationName()
Bestimmt das auf unterster Ebene einzusetzende Kommunikationsprotokoll.

Returns:
lowLevelCommunicationName Name des Kommunikationsverfahrens.

setLowLevelCommunicationName

public final void setLowLevelCommunicationName(String lowLevelCommunicationName)
Setzt das auf unterster Ebene einzusetzende Kommunikationsprotokoll.

Parameters:
lowLevelCommunicationName - Name des Kommunikationsverfahrens.

getUserName

public final String getUserName()
Bestimmt den bei der Authentifizierung zu verwendenden Benutzernamen.

Returns:
userName Name des Benutzers.

setUserName

public final void setUserName(String userName)
Setzt den bei der Authentifizierung zu verwendenden Benutzernamen.

Parameters:
userName - Name des Benutzers.

getUserPassword

public final String getUserPassword()
Bestimmt das bei der Authentifizierung zu verwendende Passwort.

Returns:
userPassword Passwort des Benutzers.

setUserPassword

public final void setUserPassword(String userPassword)
Setzt das bei der Authentifizierung zu verwendende Passwort.

Parameters:
userPassword - Passwort des Benutzers.

getSendKeepAliveTimeout

public final long getSendKeepAliveTimeout()
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.

Returns:
timeout Vorschlag für das Timeout zum Senden von KeepAlive-Telegrammen.

setSendKeepAliveTimeout

public final void setSendKeepAliveTimeout(long timeout)
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.

Parameters:
timeout - Vorschlag für das Timeout zum Senden von KeepAlive-Telegrammen.

getReceiveKeepAliveTimeout

public final long getReceiveKeepAliveTimeout()
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.

Returns:
timeout Vorschlag für das KeepAlive-Timeout beim Empfang Telegrammen.

setReceiveKeepAliveTimeout

public final void setReceiveKeepAliveTimeout(long timeout)
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.

Parameters:
timeout - Vorschlag für das KeepAlive-Timeout beim Empfang Telegrammen.

getCommunicationSendFlushDelay

public final long getCommunicationSendFlushDelay()
Bestimmt 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.

Returns:
Verzögerungszeit

setCommunicationSendFlushDelay

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.

Parameters:
delay - Verzögerungszeit

getCommunicationOutputBufferSize

public final int getCommunicationOutputBufferSize()
Bestimmt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.

Returns:
bufferSize Größe des Sendepuffers.

setCommunicationOutputBufferSize

public final void setCommunicationOutputBufferSize(int bufferSize)
Setzt die Größe des Sendepuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.

Parameters:
bufferSize - Größe des Sendepuffers.

getCommunicationInputBufferSize

public final int getCommunicationInputBufferSize()
Bestimmt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.

Returns:
bufferSize Größe des Empfangspuffers.

setCommunicationInputBufferSize

public final void setCommunicationInputBufferSize(int bufferSize)
Setzt die Größe des Empfangspuffers, der bei der Kommunikation mit dem Datenverteiler eingesetzt wird.

Parameters:
bufferSize - Größe des Empfangspuffers.

isLocalMode

public final boolean isLocalMode()
Gibt die Information zurück, ob der Datenverteiler auf eine lokale Anmeldung einer Konfigurationsapplikation warten muss.

Returns:
true : im lokalen Konfigurationsbetrieb. false : implements remote Konfigurationsbetrieb.

getLocalModeParameter

public final Object[] getLocalModeParameter()
Gibt die Konfigurationsparameter des Lokalen Modus zurück.

Returns:
die Pid und die Id der Konfigurationsapplikation

setLocalModeParameter

public final void setLocalModeParameter(String configPid,
                                        long configId)
Setzt den Datenverteilersbetriebsmodus auf den Lokalen Modus.

Parameters:
configPid - die Pid der Konfigurationsapplikation
configId - die Id der Konfigurationsapplikation

getRemoteModeParameter

public final Object[] getRemoteModeParameter()
Gibt die Konfigurationsparameter des Remote-Modus zurück.

Returns:
die Konfigurationsparameter des Remote-Modus

setRemoteModeParameter

public final void setRemoteModeParameter(String configDataTransmitterAddress,
                                         int configDataTransmitterSubAddress,
                                         String configurationPid)
Setzt den Datenverteilersbetriebsmodus auf den Remote-Modus.

Parameters:
configDataTransmitterAddress - die Adresse des Datenverteilers wo die Konfiguration angemeldet ist.
configDataTransmitterSubAddress - Datenverteilersubadresse für die Konfigurationsanbindung
configurationPid - Pid der Konfiguration

getConfigurationId

public final long getConfigurationId()
Gibt die Konfigurationsid zurück

Returns:
die Konfigurationsid

setConfigurationId

public final void setConfigurationId(long configurationId)
Setzt der Konfigurationsid auf den neuen Wert.

Parameters:
configurationId - Konfigurationsid

getConfigurationUserName

public final String getConfigurationUserName()
Gibt der Konfigurationsbenutzername zurück

Returns:
der Konfigurationsbenutzername

setConfigurationUserName

public final void setConfigurationUserName(String configUserName)
Setzt den Konfigurationsbenutzername auf den neuen Wert.

Parameters:
configUserName - Konfigurationsbenutzername

getConfigurationUserPassword

public final String getConfigurationUserPassword()
Gibt der Konfigurationsbenutzerpasswort zurück

Returns:
der Konfigurationsbenutzerpasswort

setConfigurationUserPassword

public final void setConfigurationUserPassword(String configUserPassword)
Setzt der Konfigurationsbenutzerpasswort auf den neuen Wert.

Parameters:
configUserPassword - das Konfigurationsbenutzerpasswort

getParameterUserName

public final String getParameterUserName()
Gibt der Parametrierungsbenutzername zurück

Returns:
der Parametrierungsbenutzername

setParameterUserName

public final void setParameterUserName(String paramUserName)
Setzt der Parametrierungsbenutzername auf den neuen Wert.

Parameters:
paramUserName - der Parametrierungsbenutzername

getParameterUserPassword

public final String getParameterUserPassword()
Gibt der Parametrierungsbenutzerpasswort zurück

Returns:
der Parametrierungsbenutzerpasswort

setParameterUserPassword

public final void setParameterUserPassword(String paramUserPassword)
Setzt der Parametrierungsbenutzerpasswort auf den neuen Wert.

Parameters:
paramUserPassword - das Parametrierungsbenutzerpasswort

printArgumentsList

public static void printArgumentsList()
Gibt auf der Standardausgabe die möglichen Startargumente einer Datenverteilerapplikation aus.


isUserRightsCheckingEnabled

public boolean isUserRightsCheckingEnabled()

getInitialInterDavServerDelay

public long getInitialInterDavServerDelay()

getClientDavParameters

public ClientDavParameters getClientDavParameters()
                                           throws MissingParameterException
Erzeugt einen neuen Parametersatz für eine Applikationsverbindung.

Returns:
Parameterobjekt zum Aufbau einer Applikationsverbindung
Throws:
MissingParameterException - Bei formalen Fehlern beim Lesen der Aufrufargumente oder der Defaultwerte.