de.ipcon.gui

Class ClientSessionStateHelper

java.lang.Object

de.ipcon.gui.AbstractClientHelper

de.ipcon.gui.ClientSessionStateHelper

All Implemented Interfaces:

DBManEventListenerI, L10nLocaleChangeListenerI

public class ClientSessionStateHelper
extends AbstractClientHelper
implements DBManEventListenerI, L10nLocaleChangeListenerI

Constructor Summary

Constructors

Constructor and Description
ClientSessionStateHelper(Client _client, java.lang.String _server, java.lang.String _projectName, java.lang.String _pathClientLogTxt)

Method Summary

Modifier and Type	Method and Description
void	addClientStatusListener(ClientStatusListener l)
void	authenticate(java.lang.String username, java.lang.String pass, boolean inhibitInitFeatureManager, java.lang.String originHash)
void	clearLogonDialog()
void	close() Closes the client session, unsubscribes from all server and connection events, and forcibly stops the event notifier thread.
void	close(boolean processLogoffScript) Closes this client.
boolean	connectionAvailableNow()
java.util.Date	getDateLoggedOn()
java.lang.String	getPathToClientLogFile()
SchemaI	getSchema()
java.lang.String	getServerDescription()
java.lang.String	getServerName()
ClientSessionStateI	getState()
Benutzer	getUser()
void	handleError(java.lang.String msg, java.lang.String serverName, java.lang.Throwable t, boolean doClose) Helper method to avoid code redundancy.
void	initLogonSubscriptions() Subscribes to essential backend server events upon user logon.
void	initSchema()
void	initSubsystemsOnLogon()
boolean	isClosed()
boolean	isLoggedIn()
boolean	isLoggingOn()
boolean	isShowBOProperties()
boolean	isShowHiddenProperties()
boolean	isShowHistory()
void	loadGlobals() Loads global session variables and user preferences from the local machine configuration file and applies them to the current session.
void	logon()
void	onConnected() Initializes necessary state immediately after a successful connection to the server is established.
void	passwordChangeInLogonDialogInitiated() Handles the event when a password change is initiated in the logon dialog.
void	processDBManEvent(DBManEvent e) Invoked when a subscribed DBManEvent occurs.
void	processLocaleChanged(java.util.Locale oldLocale, java.util.Locale newLocale) Updates server session locale, persists the preferred locale on the current user BO, recalculates L10n paths, and refreshes client actions.
boolean	provideLogonGUI(java.lang.String _server, java.lang.String _user, java.lang.String _passwd, java.lang.String _pathClientLogTxt, PasswordChangeRequiredException pcre) Constructs a @see de.ipcon.form.ClientLoginDialog so users may log in to the Swing-Solstice-GUI of the project.
void	removeClientStatusListener(ClientStatusListener l)
void	requestClose() Initiates an orderly shutdown of the client, checking for blocking conditions and prompting the user if active plugins register close vetoes.
void	resetPassword(java.lang.String username)
void	saveGlobals() Saves global session variables and user preferences to the local machine configuration file.
void	savePersistentSession(ClientStateSaveReason reason) Persists the current session state and window geometry within a new transaction.
void	scheduleInactivityDisconnectTimerTask() Schedules a new ClientInactivityDisconnectTimerTask and cancels the previous one, if any.
void	setShowBOProperties(boolean show)
void	setShowHiddenProperties(boolean show)
void	setShowHistory(boolean show)
void	startBOClassesInitializer()
void	startL10nPackPrefetcher() Initiates the prefetching of localization packs.

Methods inherited from class de.ipcon.gui.AbstractClientHelper

client

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientSessionStateHelper

public ClientSessionStateHelper(Client _client,
                                java.lang.String _server,
                                java.lang.String _projectName,
                                java.lang.String _pathClientLogTxt)

Method Detail

getState

public ClientSessionStateI getState()

getUser

public Benutzer getUser()

getServerName

public java.lang.String getServerName()

getServerDescription

public java.lang.String getServerDescription()

getPathToClientLogFile

public java.lang.String getPathToClientLogFile()

getDateLoggedOn

public java.util.Date getDateLoggedOn()

getSchema

public SchemaI getSchema()

initSchema

public void initSchema()

processLocaleChanged

public void processLocaleChanged(java.util.Locale oldLocale,
                                 java.util.Locale newLocale)

Updates server session locale, persists the preferred locale on the current user BO, recalculates L10n paths, and refreshes client actions.

Specified by:

processLocaleChanged in interface L10nLocaleChangeListenerI

Parameters:

oldLocale - previous client locale

newLocale - newly activated client locale

authenticate

public void authenticate(java.lang.String username,
                         java.lang.String pass,
                         boolean inhibitInitFeatureManager,
                         java.lang.String originHash)
                  throws AuthenticationException,
                         PasswordChangeRequiredException

Throws:

AuthenticationException

PasswordChangeRequiredException

provideLogonGUI

public boolean provideLogonGUI(java.lang.String _server,
                               java.lang.String _user,
                               java.lang.String _passwd,
                               java.lang.String _pathClientLogTxt,
                               PasswordChangeRequiredException pcre)

Constructs a @see de.ipcon.form.ClientLoginDialog so users may log in to the Swing-Solstice-GUI of the project.

startL10nPackPrefetcher

public void startL10nPackPrefetcher()

Initiates the prefetching of localization packs.

This method schedules the prefetching process to run on the Event Dispatch Thread (EDT) via SPU.onEDTv(java.lang.Object, java.lang.Runnable). It is a high-level entry point that kicks off the asynchronous loading of localization resources.

startBOClassesInitializer

public void startBOClassesInitializer()

scheduleInactivityDisconnectTimerTask

public void scheduleInactivityDisconnectTimerTask()

Schedules a new ClientInactivityDisconnectTimerTask and cancels the previous one, if any.

logon

public void logon()

initLogonSubscriptions

public void initLogonSubscriptions()

Subscribes to essential backend server events upon user logon.

Registers direct event listeners for user-specific events rather than delegating through Client. This keeps session-scoped cache invalidation encapsulated within the session lifecycle:

• Delegates server infrastructure monitoring (health, maintenance locks, shutdowns) to ClientServerEventHandler.
• Subscribes directly to DBManBOChangeEvent for the currently authenticated Benutzer to update local session attributes when modified externally.

processDBManEvent

public void processDBManEvent(DBManEvent e)

Description copied from interface: DBManEventListenerI

Invoked when a subscribed DBManEvent occurs. See DBManBOChangeEvent for events triggered after modification on BOs.

Specified by:

processDBManEvent in interface DBManEventListenerI

initSubsystemsOnLogon

public void initSubsystemsOnLogon()
                           throws electric.xml.ParseException

Throws:

electric.xml.ParseException

clearLogonDialog

public void clearLogonDialog()

isLoggingOn

public boolean isLoggingOn()

isLoggedIn

public boolean isLoggedIn()

resetPassword

public void resetPassword(java.lang.String username)

passwordChangeInLogonDialogInitiated

public void passwordChangeInLogonDialogInitiated()

Handles the event when a password change is initiated in the logon dialog.

When a password change is required, the user is active, so any inactivity timer needs to be stopped to prevent an accidental disconnect or timeout during the password update process. This method cancels the "inactivityDisconnectTimerTask", if it exists, to ensure the user is not disconnected prematurely.

connectionAvailableNow

public boolean connectionAvailableNow()

onConnected

public void onConnected()

Initializes necessary state immediately after a successful connection to the server is established.

Subscribes to connection events, updates the waiting flag, and clears stale caches.

isClosed

public boolean isClosed()

requestClose

public void requestClose()

Initiates an orderly shutdown of the client, checking for blocking conditions and prompting the user if active plugins register close vetoes.

The shutdown sequence executes as follows:

1. If the backend server is already marked down or unreachable, bypasses veto checks and terminates immediately.
2. Queries registered plugins for pending operations, unsaved work, or objections. If objections exist, displays a confirmation dialog asking the user whether to abort or override the vetoes.
3. Flushes pending telemetry and window session history.
4. Invokes close(1) to dispose UI resources and terminate the process.

close

public void close()

Closes the client session, unsubscribes from all server and connection events, and forcibly stops the event notifier thread.

close

public void close(boolean processLogoffScript)

Closes this client. Tries to clean up running threads and this client. Might process logoff scripts. Calls System.exit

Parameters:

processLogoffScript - if true and not serverDown, then gui.logoff scripts are processed before shutting down the client and saving globals. Defaults to false.

saveGlobals

public void saveGlobals()

Saves global session variables and user preferences to the local machine configuration file.

Note: Currently saves to a per-machine file, not strictly per-user, due to legacy constraints. Exceptions are caught and logged without disrupting execution flow.

loadGlobals

public void loadGlobals()

Loads global session variables and user preferences from the local machine configuration file and applies them to the current session. Automatically migrates older configuration file formats.

handleError

public void handleError(java.lang.String msg,
                        java.lang.String serverName,
                        java.lang.Throwable t,
                        boolean doClose)

Helper method to avoid code redundancy.

savePersistentSession

public void savePersistentSession(ClientStateSaveReason reason)

Persists the current session state and window geometry within a new transaction.

If a window manager switch is pending, null is passed for the window state so that SessionStateXml.updateWindow(WindowState, ClientStateSaveReason) preserves the target mode defaults instead of overwriting them with the outdated active frame dimensions.

Parameters:

reason - the trigger context defining the cause of this save operation

addClientStatusListener

public void addClientStatusListener(ClientStatusListener l)

removeClientStatusListener

public void removeClientStatusListener(ClientStatusListener l)

isShowHiddenProperties

public boolean isShowHiddenProperties()

setShowHiddenProperties

public void setShowHiddenProperties(boolean show)

isShowBOProperties

public boolean isShowBOProperties()

setShowBOProperties

public void setShowBOProperties(boolean show)

isShowHistory

public boolean isShowHistory()

setShowHistory

public void setShowHistory(boolean show)