org.openlowcode.client.runtime

Class ClientSession

java.lang.Object

org.openlowcode.client.runtime.ClientSession

public class ClientSession
extends java.lang.Object

Client managing a session to a given server.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ClientSession(ClientMainFrame mainframe, PageActionManager.ActionSourceTransformer transformer, java.lang.String urltoconnecto, java.lang.String questionmarkicon) creates a client session and sets up a display that will show the specified URL

Method Summary

Modifier and Type	Method and Description
void	addNewDisplay() adds a new empty display
DisplayPageFeedback	displayPage(ClientDisplay activedisplay, long starttime, boolean showtechdetails, java.lang.String module, java.lang.String action, boolean openinnewtab)
DisplayPageFeedback	enrichPageWithInlineData(CPage page, ClientDisplay activedisplay, long starttime, boolean showtechdetails, java.lang.String module, java.lang.String action)
ClientDisplay	getActiveClientDisplay()
ClientData	getClientData()
javafx.scene.control.TabPane	getClientSessionNode()
ConnectionToServer	getConnectionToServer()
java.lang.String	getLocale()
ClientMainFrame	getMainFrame()
static void	printException(java.lang.Exception e)
void	sendaction(java.lang.String actionname, java.lang.String modulename, CActionData actionattributes, boolean openinnewtab) sends an action that will result in the display of a new page
void	sendInlineAction(java.lang.String actionname, java.lang.String modulename, CActionData actionattributes, CPage page)
void	sendLink(java.lang.String address, boolean back) displays in the current tab the page with the address specified
void	setBusinessScreenFrozen(boolean frozen)
void	setShowTechDetails(boolean techdetails) sets the show tech details parameter (memory usage, speed of page display, network capacity used
void	setTitle(java.lang.String newtitle) sets the title on the active tab (corresponding to the active client display)
void	stopconnection() Stops the current connection
void	treatException(java.lang.Exception e) Logs and displays on status bar an error

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSession

public ClientSession(ClientMainFrame mainframe,
                     PageActionManager.ActionSourceTransformer transformer,
                     java.lang.String urltoconnecto,
                     java.lang.String questionmarkicon)

creates a client session and sets up a display that will show the specified URL

Parameters:

mainframe - parent main frame of the application

transformer - action source transformer for event handler

urltoconnecto - first URL to connect to, null if not used

questionmarkicon - question mark icon URL

Method Detail

getLocale

public java.lang.String getLocale()

Returns:

gets the locale on the machine

getClientSessionNode

public javafx.scene.control.TabPane getClientSessionNode()

Returns:

the tab pane of this client session. There is one child tab with client sessions

getConnectionToServer

public ConnectionToServer getConnectionToServer()

Returns:

theconnection to server (holding the socket connection to the server)

setTitle

public void setTitle(java.lang.String newtitle)

sets the title on the active tab (corresponding to the active client display)

Parameters:

newtitle - the text title to show

setShowTechDetails

public void setShowTechDetails(boolean techdetails)

sets the show tech details parameter (memory usage, speed of page display, network capacity used

Parameters:

techdetails - true to show tech details, false else

addNewDisplay

public void addNewDisplay()

adds a new empty display

getMainFrame

public ClientMainFrame getMainFrame()

Returns:

parent mainframe

getClientData

public ClientData getClientData()

Returns:

the list of previous pages visited

sendInlineAction

public void sendInlineAction(java.lang.String actionname,
                             java.lang.String modulename,
                             CActionData actionattributes,
                             CPage page)

Parameters:

actionname - name of the action to launch

modulename - nae of the module to launch

local - true if the inline action is local

actionattributes - list of attributes for the inline action

page - page to show the data coming back from the inline action

sendaction

public void sendaction(java.lang.String actionname,
                       java.lang.String modulename,
                       CActionData actionattributes,
                       boolean openinnewtab)

sends an action that will result in the display of a new page

Parameters:

actionname - name of the action

modulename - name of the module

actionattributes - attributes that will be sent to the server for the action

openinnewtab - true if the new page should be opened in a new tab, keeping the current page in the current tab

sendLink

public void sendLink(java.lang.String address,
                     boolean back)

displays in the current tab the page with the address specified

Parameters:

address - the address to show

back - true if back is possible

enrichPageWithInlineData

public DisplayPageFeedback enrichPageWithInlineData(CPage page,
                                                    ClientDisplay activedisplay,
                                                    long starttime,
                                                    boolean showtechdetails,
                                                    java.lang.String module,
                                                    java.lang.String action)
                                             throws java.io.IOException,
                                                    OLcRemoteException

Parameters:

page - current page

activedisplay - client display for the action

starttime - start time of the interaction with the server (for performance audit purposes)

showtechdetails - true if all technical details (memory, speed of request, network bandwidth used)

module - name of the module

action - name of the line action

Returns:

a feedback if processing happened well or not

Throws:

java.io.IOException - if any network breadkown

OLcRemoteException - if anythink bad happened on the server during the request

displayPage

public DisplayPageFeedback displayPage(ClientDisplay activedisplay,
                                       long starttime,
                                       boolean showtechdetails,
                                       java.lang.String module,
                                       java.lang.String action,
                                       boolean openinnewtab)
                                throws java.io.IOException,
                                       OLcRemoteException

Parameters:

activedisplay - current display

starttime - start time of the exchange with the server

showtechdetails - true to show tech details

module - name of the module

action - name of the action

openinnewtab - true to open in new tabs

Returns:

a feedback

Throws:

java.io.IOException - if any network breadkown

OLcRemoteException - if anythink bad happened on the server during the request

getActiveClientDisplay

public ClientDisplay getActiveClientDisplay()

Returns:

the active display

treatException

public void treatException(java.lang.Exception e)

Logs and displays on status bar an error

Parameters:

e - exceptin to tread

printException

public static void printException(java.lang.Exception e)

setBusinessScreenFrozen

public void setBusinessScreenFrozen(boolean frozen)

Parameters:

frozen - true if widgets should be frozen as one communication is already happening in the server

stopconnection

public void stopconnection()

Stops the current connection