de.ipcon.db.protocol

Class BackendSession

java.lang.Object

de.ipcon.db.protocol.AbstractBackendSession

de.ipcon.db.protocol.BackendSession

All Implemented Interfaces:

TemporaryIdSupplierI, BackendSessionI, L10nCurrentLocaleProviderI, java.io.Serializable

public class BackendSession
extends AbstractBackendSession

This class encapsulates information about a connected client in the backend system. It provides a foundation for managing and interacting with client sessions.

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.ipcon.db.protocol.BackendSessionI

CURRENT, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
BackendSession(BackendProtocolServer _backend, Anmeldung _anmeldung, java.lang.String _claddr, java.lang.String _clport, TransportI _transport)

Method Summary

Modifier and Type	Method and Description
boolean	cancelRequest(int pid, int slot)
void	decCommandHandler(int pid, boolean sessionBroken) Decrements the number of command handlers by unsubscribing the specified pid.
long	getAlteredBOCount()
long	getBackEndTime()
long	getClientKey() Retrieves the client key ID associated with this session, or returns 0 if no key is set for this session yet.
long	getCommandCount()
BackendCommandHandlerI	getCommandHandler(int pid)
int	getConnections()
long	getCreatedBOCount()
java.lang.String	getGateway()
java.lang.Long	getId() Retrieves the ID associated with this session, or returns null if none is set for this session yet.
long	getKernelTime()
java.lang.String	getLastActivity()
java.lang.String	getLastActivity(java.lang.String format)
java.util.Locale	getLocale()
java.lang.String	getLoggedInSince()
java.lang.String	getLoggedInSince(java.lang.String format)
long	getObjectCount()
java.lang.String	getParms()
long	getProcsCount()
java.lang.String	getProtocolParameters()
java.lang.String	getProtocolVersion()
long	getRoundtripCount()
java.lang.String	getServerEndPoint()
long	getTotalTime()
long	getTransactionCount()
long	getTransportTime()
java.lang.String	getUser()
java.lang.String	getWorkstation() Returns the IP-address and port of the workstation associated with this BackendSessionI.
java.lang.String	getWorkstationAddress() Returns the IP-address of the workstation associated with this BackendSessionI.
boolean	hasBackStreamToClient() Returns true if there is a backend command handler in this session, acting as back stream to the client, false otherwise.
int	incCommandHandler(java.lang.Object commandHandler)
void	incCommands()
void	incObjects()
void	incRoundtrips()
void	incSaveBO(int procCnt, int newBOCnt, int includedBOCnt)
boolean	isLocalConnection() Returns true if the server endpoint and the workstation are on the same interface
java.lang.Long	nextTempId() Returns the next temporary Id to be used by the calling Transaction and updates the internal counter.
void	setId(java.lang.Long id) Sets the ID associated with this session.
void	setLocale(java.util.Locale $14)
void	setParms(java.lang.String $13)
java.lang.String	toString()
void	touch()
void	touch(PerformanceMeter pm)
void	waitUntilEventSendingFinished() Used by DBMan.ShutdownThread to ensure that the JVM is not halted until all shutdown notifications have been sent to clients.

Methods inherited from class de.ipcon.db.protocol.AbstractBackendSession

getAnmeldung, getCountsAgainstLimit, getCurrentUserName, getCurrentUserRemark, getUtx, isAdministratorUserSession, setAnmeldung, setUtx

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.protocol.BackendSessionI

isConnected

Constructor Detail

BackendSession

public BackendSession(BackendProtocolServer _backend,
                      Anmeldung _anmeldung,
                      java.lang.String _claddr,
                      java.lang.String _clport,
                      TransportI _transport)

Method Detail

nextTempId

public java.lang.Long nextTempId()

Description copied from interface: TemporaryIdSupplierI

Returns the next temporary Id to be used by the calling Transaction and updates the internal counter.

toString

public java.lang.String toString()

Specified by:

toString in interface BackendSessionI

Overrides:

toString in class AbstractBackendSession

getId

public java.lang.Long getId()

Retrieves the ID associated with this session, or returns null if none is set for this session yet.

Returns:

A Long object representing the ID, or null if not set.

setId

public void setId(java.lang.Long id)

Sets the ID associated with this session. If an ID (clientKey) is already present, this method throws an IllegalStateException.

Parameters:

id - The Long object representing the new ID to be associated with this session.

Throws:

java.lang.IllegalStateException - If an ID conflict is detected.

getClientKey

public long getClientKey()

Retrieves the client key ID associated with this session, or returns 0 if no key is set for this session yet.

Specified by:

getClientKey in interface BackendSessionI

Overrides:

getClientKey in class AbstractBackendSession

Returns:

A long value representing the client key ID, or 0 if not set.

getUser

public java.lang.String getUser()

incCommandHandler

public int incCommandHandler(java.lang.Object commandHandler)

decCommandHandler

public void decCommandHandler(int pid,
                              boolean sessionBroken)

Description copied from interface: BackendSessionI

Decrements the number of command handlers by unsubscribing the specified pid. If the number of active handlers reaches zero, the user is logged out. If 'forceLogout' is true, the user is forcefully logged out regardless of the number of active handlers.

Parameters:

pid - The pid to unsubscribe from command handling.

sessionBroken - A boolean flag indicating whether to force a user logout due to broken session (true) or not (false).

getCommandHandler

public BackendCommandHandlerI getCommandHandler(int pid)

hasBackStreamToClient

public boolean hasBackStreamToClient()

Description copied from interface: BackendSessionI

Returns true if there is a backend command handler in this session, acting as back stream to the client, false otherwise.

cancelRequest

public boolean cancelRequest(int pid,
                             int slot)

getProtocolVersion

public java.lang.String getProtocolVersion()

Specified by:

getProtocolVersion in interface BackendSessionI

Overrides:

getProtocolVersion in class AbstractBackendSession

getProtocolParameters

public java.lang.String getProtocolParameters()

Specified by:

getProtocolParameters in interface BackendSessionI

Overrides:

getProtocolParameters in class AbstractBackendSession

getServerEndPoint

public java.lang.String getServerEndPoint()

Specified by:

getServerEndPoint in interface BackendSessionI

Overrides:

getServerEndPoint in class AbstractBackendSession

getWorkstationAddress

public java.lang.String getWorkstationAddress()

Description copied from interface: BackendSessionI

Returns the IP-address of the workstation associated with this BackendSessionI.

Specified by:

getWorkstationAddress in interface BackendSessionI

Overrides:

getWorkstationAddress in class AbstractBackendSession

getWorkstation

public java.lang.String getWorkstation()

Description copied from interface: BackendSessionI

Returns the IP-address and port of the workstation associated with this BackendSessionI.

Specified by:

getWorkstation in interface BackendSessionI

Overrides:

getWorkstation in class AbstractBackendSession

isLocalConnection

public boolean isLocalConnection()

Description copied from interface: BackendSessionI

Returns true if the server endpoint and the workstation are on the same interface

Specified by:

isLocalConnection in interface BackendSessionI

Specified by:

isLocalConnection in class AbstractBackendSession

getGateway

public java.lang.String getGateway()

Specified by:

getGateway in interface BackendSessionI

Overrides:

getGateway in class AbstractBackendSession

getLoggedInSince

public java.lang.String getLoggedInSince()

Specified by:

getLoggedInSince in interface BackendSessionI

Overrides:

getLoggedInSince in class AbstractBackendSession

getLoggedInSince

public java.lang.String getLoggedInSince(java.lang.String format)

Specified by:

getLoggedInSince in interface BackendSessionI

Overrides:

getLoggedInSince in class AbstractBackendSession

getConnections

public int getConnections()

Specified by:

getConnections in interface BackendSessionI

Overrides:

getConnections in class AbstractBackendSession

getLastActivity

public java.lang.String getLastActivity()

Specified by:

getLastActivity in interface BackendSessionI

Overrides:

getLastActivity in class AbstractBackendSession

getLastActivity

public java.lang.String getLastActivity(java.lang.String format)

Specified by:

getLastActivity in interface BackendSessionI

Overrides:

getLastActivity in class AbstractBackendSession

getCommandCount

public long getCommandCount()

Specified by:

getCommandCount in interface BackendSessionI

Overrides:

getCommandCount in class AbstractBackendSession

getRoundtripCount

public long getRoundtripCount()

Specified by:

getRoundtripCount in interface BackendSessionI

Overrides:

getRoundtripCount in class AbstractBackendSession

getObjectCount

public long getObjectCount()

Specified by:

getObjectCount in interface BackendSessionI

Overrides:

getObjectCount in class AbstractBackendSession

getTransactionCount

public long getTransactionCount()

Specified by:

getTransactionCount in interface BackendSessionI

Overrides:

getTransactionCount in class AbstractBackendSession

getProcsCount

public long getProcsCount()

Specified by:

getProcsCount in interface BackendSessionI

Overrides:

getProcsCount in class AbstractBackendSession

getAlteredBOCount

public long getAlteredBOCount()

Specified by:

getAlteredBOCount in interface BackendSessionI

Overrides:

getAlteredBOCount in class AbstractBackendSession

getCreatedBOCount

public long getCreatedBOCount()

Specified by:

getCreatedBOCount in interface BackendSessionI

Overrides:

getCreatedBOCount in class AbstractBackendSession

getKernelTime

public long getKernelTime()

Specified by:

getKernelTime in interface BackendSessionI

Overrides:

getKernelTime in class AbstractBackendSession

getBackEndTime

public long getBackEndTime()

Specified by:

getBackEndTime in interface BackendSessionI

Overrides:

getBackEndTime in class AbstractBackendSession

getTransportTime

public long getTransportTime()

Specified by:

getTransportTime in interface BackendSessionI

Overrides:

getTransportTime in class AbstractBackendSession

getTotalTime

public long getTotalTime()

Specified by:

getTotalTime in interface BackendSessionI

Overrides:

getTotalTime in class AbstractBackendSession

touch

public void touch()

touch

public void touch(PerformanceMeter pm)

incRoundtrips

public void incRoundtrips()

incCommands

public void incCommands()

incObjects

public void incObjects()

incSaveBO

public void incSaveBO(int procCnt,
                      int newBOCnt,
                      int includedBOCnt)

waitUntilEventSendingFinished

public void waitUntilEventSendingFinished()

Used by DBMan.ShutdownThread to ensure that the JVM is not halted until all shutdown notifications have been sent to clients. It is essential that this method is only called from within the DBMan.ShutdownThread and not from any other part of the codebase.

getParms

public java.lang.String getParms()

setParms

public void setParms(java.lang.String $13)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale $14)