com::cosylab::logging::LoggingClient Class Reference

Inheritance diagram for com::cosylab::logging::LoggingClient:

Collaboration diagram for com::cosylab::logging::LoggingClient:

Classes
class	CustomColumnListener
class	EventHandler
Public Member Functions
	LoggingClient ()
	LoggingClient (LogFrame frame, LogTypeHelper logLevel, LogTypeHelper discardLevel, boolean unlimited, AudienceInfo aInfo)
void	start () throws Exception
void	stop () throws Exception
void	pause () throws Exception
void	resume () throws Exception
void	connect (boolean connectEngine)
void	connect ()
JScrollPane	getLogTableScroolP ()
LogEntryTable	getLogEntryTable ()
void	showDetailedLogInfo ()
void	setLogDetailContent (ILogEntry log)
void	connLCEngDisconnect (WindowEvent arg1)
JScrollPane	getLogDetailScrollPane ()
LCEngine	getEngine ()
LogTableDataModel	getLCModel1 ()
void	loggingClient_ComponentResized (ComponentEvent e)
void	enableSearchNext (boolean enable)
void	animateProgressBar (final String text, final int min, final int max)
void	moveProgressBar (final int newPos)
void	animateProgressBar (final String text)
void	freezeProgressBar ()
boolean	isConnected ()
int	getDiscardLevel ()
void	logEntryReceived (ILogEntry logEntry)
void	reportStatus (String status)
void	acsLogConnEstablished ()
void	acsLogConnDisconnected ()
void	acsLogConnLost ()
void	acsLogConnConnecting ()
void	acsLogConnSuspended ()
void	acsLogsDelay ()
void	showDBStatus (ImageIcon icon, String msg)
UserPreferences	getPrefs ()
boolean	isPaused ()
void	hideExitMenu (boolean hide)
void	close (boolean sync)
void	enableFiltersWidgets (boolean enable)
void	errorReceived (String xml)
StatsDlg	getStatisticDialog ()
void	setEnabled (boolean enabled)
ErrorBrowserDlg	getErrorDialog ()
void	addErrorTab (final String stackID)
ZoomManager	getZoomManager ()
LogToolBar	getToolBar ()
ContainerServicesBase	getContainerServices ()
boolean	inDebugMode ()
void	showErrorMessage (String shortDescription, Throwable t)
void	errorAcknowledged ()
Static Public Attributes
static final LogTypeHelper	DEFAULT_LOGLEVEL = LogTypeHelper.INFO
static final LogTypeHelper	DEFAULT_DISCARDLEVEL = LogTypeHelper.DEBUG
Protected Attributes
ContainerServicesBase	containerServices = null
Private Member Functions
void	disconnect ()
void	connFields (java.awt.event.ActionEvent arg1)
void	showTableFiltersDialog (java.awt.event.ActionEvent arg1)
void	setTableFilterLbl ()
void	setNumberOfLogsLbl ()
void	setEngineFilterLbl ()
JPanel	getJFrameContentPane ()
void	handleException (java.lang.Throwable exception)
void	initConnections () throws java.lang.Exception
void	initialize (LogTypeHelper logLevel, LogTypeHelper discardLevel, boolean unlimited)
JPanel	getJPanel2 ()
JPanel	getDeatailedInfoPanel ()
JPanel	getStatusLinePnl ()
javax.swing.JScrollPane	getStatusAreaPanel ()
JSplitPane	getStatusAreaHrPane ()
JSplitPane	getTableDetailsVrPane ()
SmartTextArea	getStatusArea ()
void	setLCModel1 (LogTableDataModel newValue)
void	initAudience (AudienceInfo audienceInfo)
void	showEngineFiltersDialog ()
ErrorLogDialog	getJLogErroDialog ()
Private Attributes
JLabel	audienceLbl = new JLabel()
JLabel	engineFiltersLbl = new JLabel()
JLabel	tableFiltersLbl = new JLabel()
JLabel	maxNumOfLogsLbl = new JLabel()
ArchiveConnectionManager	archive
UserPreferences	userPreferences = new UserPreferences(0,100000,Integer.MAX_VALUE,Integer.MAX_VALUE)
JPanel	ivjJPanel2 = null
JPanel	detailedInfoPanel = null
DetailedLogTable	detailedLogTable = new DetailedLogTable()
JPanel	statusLinePnl = null
JScrollPane	statusAreaPanel = null
JScrollPane	detailedInfoScrollPane = null
JSplitPane	statusAreaHrSplitP = null
JSplitPane	tableDetailsVrSplitP = null
JScrollPane	scrollLogTable = null
LogEntryTable	logEntryTable = null
SmartTextArea	ivjStatusArea = null
JPanel	ivjJFrameContentPane = null
ErrorLogDialog	errorDialog
JProgressBar	progressBar = new JProgressBar(JProgressBar.HORIZONTAL,0,100)
ZoomManager	zoom = new ZoomManager()
ManualZoomDlg	manualZoomDlg
boolean	isConnected = false
volatile boolean	isStopped = true
SearchDialog	searchDialog
StatsDlg	statsDlg
QueryDlg	databaseDlg = null
EventHandler	eventHandler = new EventHandler()
LCEngine	engine = null
LogTableDataModel	tableModel = null
final int	CONNECTED_ICON = 0
final int	CONNECTING_ICON = 1
final int	DISCONNECTED_ICON = 2
final int	SUSPENDED_ICON = 3
final int	DELAY_ICON = 4
ImageIcon[]	connectionStatusIcons
JLabel	connectionStatusLbl
JLabel	connectionDBLbl
final JLabel	jlogErrorLbl = new JLabel(new ImageIcon(this.getClass().getResource("/errorLogIcon.png")))
LogToolBar	toolBar
LogNavigationBar	navigationToolbar
LogMenuBar	menuBar = new LogMenuBar()
FilterChooserDialog	engineFiltersDlg = null
ErrorBrowserDlg	errorBrowserDialog = null
FilterChooserDialog	filterChooserDialog = null
final LogFrame	logFrame
final boolean	debugMode = Boolean.getBoolean(DEBUG_MODE_PROPERTY)
MessageWidget	errorWidget = new MessageWidget()
TransparentGlassPane	glassPane
Static Private Attributes
static final String	AUDIENCE_PROPERTY = "jlog.mode.audience"
static final String	DEBUG_MODE_PROPERTY = "alma.acs.jlog.debugMode"

Detailed Description

Defines a JRootPane Application LoggingClient for displaying event logs received through the CORBA protocol for the purpose of monitoring and reviewing of the logs. It contains of a JScrollPane scrollLogTable for the logs and a LogEntryTable logEntryTable for displaying the status as well as a JPanel ivjJFrameContentPane. Multiple listeners handle user's input. Based on the current code and our understanding of it one could describe the information flow as follows. User's input triggers events which are caught by the listeners attached to each one of the available GUI object representations defined in the LoggingClient class. Independent of that there are messages available at the logging system generated by the other services running in the framework. These messages are parsed by the ACSStructuredPushConsumer class using the SAX parser and are then passed on using the LogTableDataModel's appendLog method for putting the logs to the log table. In particular, we are interested in the saving and loading of files to be implemented by the LoggingClient. While saveFile and loadFromFile are defined in LogTabledataModel, the LogImportTask file makes use of the the LogTabledataModel's appendLog method as well. The use of the DocumentBuilderFactory in the LogImportTask defines a way for transforming a DOM tree into XML.

An important issue is the format of the Log Entry Message produced by the Logging Service. Certain characters ('<', '>', '&', ''', '"') need to be escaped because they delineate markup data from character data and cause the following exception in ACSLogParserDOM class: org.xml.sax.SAXParseException: The content beginning with '<' is not legal markup. One solution is replacing the character with the appropriate html substitute <. Another solution is keeping it in a CDATA section: <[!CDATA[the log entry message]]>.

The panel can be instantiated:

by LogFrame
as an EXEC plugin

Constructor & Destructor Documentation

com::cosylab::logging::LoggingClient::LoggingClient ( ) [inline]

Constructor

The empty constructor is called by the OMC GUI.

References DEFAULT_DISCARDLEVEL, DEFAULT_LOGLEVEL, initAudience(), initialize(), and logFrame.

com::cosylab::logging::LoggingClient::LoggingClient	(	LogFrame	frame,
		LogTypeHelper	logLevel,
		LogTypeHelper	discardLevel,
		boolean	unlimited,
		AudienceInfo	aInfo
	)			`[inline]`

The constructor

This constructor is called when this object runs in stand-alone mode i.e outside of the OMC GUI.

Parameters:

	frame	The shows this object
	logLevel	The initial log level
	discardLevel	The initial discard level
	unlimited	If `true` the number of logs in memory is unlimited, otherwise the default is used

References initAudience(), initialize(), isStopped, and logFrame.

Member Function Documentation

void com::cosylab::logging::LoggingClient::acsLogConnConnecting ( ) [inline]

Notify that an attempt to connect to ACS NC is in progress

See also:: com.cosylab.logging.engine.ACS.ACSLogConnectionListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References CONNECTING_ICON, connectionStatusIcons, and connectionStatusLbl.

void com::cosylab::logging::LoggingClient::acsLogConnDisconnected ( ) [inline]

See also:: com.cosylab.logging.engine.ACS.ACSLogConnectionListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References connectionStatusIcons, connectionStatusLbl, DISCONNECTED_ICON, glassPane, isConnected(), and com::cosylab::logging::TransparentGlassPane::setVisible().

void com::cosylab::logging::LoggingClient::acsLogConnEstablished ( ) [inline]

Notify that the connection with ACS NC has been established

See also:: com.cosylab.logging.engine.ACS.ACSLogConnectionListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References CONNECTED_ICON, connectionStatusIcons, connectionStatusLbl, errorWidget, com::cosylab::logging::MessageWidget::getAckButton(), glassPane, isConnected(), and com::cosylab::logging::TransparentGlassPane::setVisible().

void com::cosylab::logging::LoggingClient::acsLogConnLost ( ) [inline]

Notify that the connection with ACS NC has been lost

See also:: com.cosylab.logging.engine.ACS.ACSLogConnectionListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References glassPane, isConnected(), isStopped, com::cosylab::logging::TransparentGlassPane::setVisible(), and showErrorMessage().

void com::cosylab::logging::LoggingClient::acsLogConnSuspended ( ) [inline]

Notify that the service is suspended

See also:: com.cosylab.logging.engine.ACS.ACSLogConnectionListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References connectionStatusIcons, connectionStatusLbl, and SUSPENDED_ICON.

void com::cosylab::logging::LoggingClient::acsLogsDelay ( ) [inline]

Notify that for some internal reason the service is not able to follow the flow of the incoming logs

See also:: com.cosylab.logging.engine.ACS.ACSRemoteLogListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References connectionStatusIcons, connectionStatusLbl, and DELAY_ICON.

void com::cosylab::logging::LoggingClient::addErrorTab ( final String stackID ) [inline]

Add a new error stack to the error browser dialog

Parameters:

stackID The STACKID of the error trace in the tab

References alma::acs::logging::errorbrowser::ErrorBrowserDlg::addErrorTab(), getErrorDialog(), and getLCModel1().

Referenced by alma::acs::logging::table::TablePopupMenu::actionPerformed().

void com::cosylab::logging::LoggingClient::animateProgressBar ( final String text ) [inline]

Show the progress bar as indeterminate

Parameters:

text

The text to show in the toolbar If it is null or empty then no text will be displayed

References progressBar.

void com::cosylab::logging::LoggingClient::animateProgressBar	(	final String	text,
		final int	min,
		final int	max
	)			`[inline]`

Show the progres bar as determinate with the given min and max

Parameters:

	textThe	text to show in the toolbar If it is null or empty then no text will be displayed
	min	The starting position
	max	The final position

References progressBar.

Referenced by alma::acs::logging::table::LogEntryTable::sorterChanged().

void com::cosylab::logging::LoggingClient::close ( boolean sync ) [inline]

Close all the threads and release all the resources

Parameters:

sync

If it is true wait the termination of the threads before returning

References alma::acs::logging::archive::zoom::ManualZoomDlg::close(), alma::acs::logging::archive::QueryDlg::close(), alma::acs::logging::errorbrowser::ErrorBrowserDlg::close(), com::cosylab::logging::engine::ACS::LCEngine::close(), alma::acs::logging::table::LogEntryTable::close(), alma::acs::logging::table::LogTableDataModel::close(), databaseDlg, alma::acs::logging::dialogs::error::ErrorLogDialog::dispose(), engine, engineFiltersDlg, errorBrowserDialog, errorDialog, filterChooserDialog, logEntryTable, manualZoomDlg, searchDialog, com::cosylab::logging::settings::FilterChooserDialog::setVisible(), com::cosylab::logging::search::SearchDialog::setVisible(), com::cosylab::logging::stats::StatsDlg::setVisible(), alma::acs::logging::dialogs::error::ErrorLogDialog::setVisible(), statsDlg, and tableModel.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and stop().

void com::cosylab::logging::LoggingClient::connect ( ) [inline]

Connects to the remote system as soon as the item "New" is clicked.

References com::cosylab::logging::engine::ACS::LCEngine::connect(), containerServices, alma::acs::container::ContainerServicesBase::getAdvancedContainerServices(), getEngine(), alma::acs::container::AdvancedContainerServices::getORB(), handleException(), and com::cosylab::logging::engine::ACS::LCEngine::setConnectionParams().

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), connect(), and start().

void com::cosylab::logging::LoggingClient::connect ( boolean connectEngine ) [inline]

Connect or disconnect the engine to the NC

Parameters:

connect

If true the engine is connected otherwise it is disconnected

References connect(), disconnect(), alma::acs::logging::dialogs::main::LogMenuBar::getAutoReconnectMenuItem(), getEngine(), alma::acs::logging::dialogs::main::LogMenuBar::getSuspendMenuItem(), menuBar, and com::cosylab::logging::engine::ACS::LCEngine::setSupended().

Referenced by alma::acs::logging::io::LoadSwitchesPanel::execute(), and alma::acs::logging::dialogs::main::LogFrame::LogFrame().

void com::cosylab::logging::LoggingClient::connFields ( java.awt.event.ActionEvent arg1 ) [inline, private]

Triggers the Field Choser's dialog visual appearance as soon as the item "Fields" is clicked.

Parameters:

arg1

java.awt.event.ActionEvent

References getLogEntryTable(), handleException(), and alma::acs::logging::table::LogEntryTable::showFieldChooser().

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

void com::cosylab::logging::LoggingClient::connLCEngDisconnect ( WindowEvent arg1 ) [inline]

Disconnects the LCEngine.

Parameters:

arg1

java.awt.event.WindowEvent

References com::cosylab::logging::engine::ACS::LCEngine::disconnect(), getEngine(), and handleException().

void com::cosylab::logging::LoggingClient::disconnect ( ) [inline, private]

References com::cosylab::logging::engine::ACS::LCEngine::disconnect(), and getEngine().

Referenced by connect().

void com::cosylab::logging::LoggingClient::enableFiltersWidgets ( boolean enable ) [inline]

Enable/disable the filter menu item and the filter button in the tool bar

Parameters:

enable

true enables the widgets

References alma::acs::logging::dialogs::main::LogMenuBar::getEngineFiltersMenuItem(), alma::acs::logging::dialogs::main::LogToolBar::getFiltersBtn(), alma::acs::logging::dialogs::main::LogMenuBar::getFiltersMenuItem(), menuBar, and toolBar.

Referenced by com::cosylab::logging::settings::FilterChooserDialog::ButtonListener::actionPerformed(), com::cosylab::logging::settings::FilterChooserDialog::FilterChooserDialog(), and showTableFiltersDialog().

void com::cosylab::logging::LoggingClient::enableSearchNext ( boolean enable ) [inline]

Enable or disable the Search next menu item (tipically this action is preformed by the SearchDialog when a valid search is performed)

Parameters:

enable

true enable the searchNextMenuItem

References alma::acs::logging::dialogs::main::LogMenuBar::getSearchNextMenuItem(), and menuBar.

Referenced by com::cosylab::logging::search::SearchDialog::search().

void com::cosylab::logging::LoggingClient::errorAcknowledged ( ) [inline]

When the user acknowledges the message, we enable the glass pane to forward all the messages to the content pane.

This method is executed when the user presses over the ACK button of the error widget and remove the constraints on the glass pane.

See also:: showErrorMessage for further implementation details

Implements com::cosylab::logging::MessageWidget::MessageWidgetListener.

References glassPane, menuBar, navigationToolbar, alma::acs::logging::dialogs::main::LogMenuBar::setEnabled(), alma::acs::logging::dialogs::main::LogNavigationBar::setEnabled(), alma::acs::logging::dialogs::main::LogToolBar::setEnabled(), com::cosylab::logging::TransparentGlassPane::setEventComponent(), and toolBar.

void com::cosylab::logging::LoggingClient::errorReceived ( String xml ) [inline]

See also:: ACSRemoteErrorListener

Implements com::cosylab::logging::engine::ACS::ACSRemoteErrorListener.

References alma::acs::logging::dialogs::error::ErrorLogDialog::appendText(), getJLogErroDialog(), and jlogErrorLbl.

void com::cosylab::logging::LoggingClient::freezeProgressBar ( ) [inline]

Hide the progress bar (i.e. a long operation has terminated)

References progressBar.

Referenced by alma::acs::logging::table::LogEntryTable::sorterChanged().

ContainerServicesBase com::cosylab::logging::LoggingClient::getContainerServices ( ) [inline]

Returns:: the containerServices

References containerServices.

JPanel com::cosylab::logging::LoggingClient::getDeatailedInfoPanel ( ) [inline, private]

Returns the JPanel3 property value.

Returns:: javax.swing.JPanel

References detailedInfoPanel, getLogDetailScrollPane(), and handleException().

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), getTableDetailsVrPane(), and com::cosylab::logging::LoggingClient::EventHandler::menuSelected().

int com::cosylab::logging::LoggingClient::getDiscardLevel ( ) [inline]

Returns:: The discard log level

See also:: LoggingClient.discardLevelCB

References alma::acs::logging::dialogs::main::LogToolBar::getDiscardLevelCB(), and toolBar.

LCEngine com::cosylab::logging::LoggingClient::getEngine ( ) [inline]

Returns the LCEngine property value.

Returns:: com.cosylab.logging.LCEngine

References com::cosylab::logging::engine::ACS::LCEngine::addLogConnectionListener(), com::cosylab::logging::engine::ACS::LCEngine::addLogErrorListener(), com::cosylab::logging::engine::ACS::LCEngine::addLogListener(), engine, alma::acs::logging::dialogs::main::LogToolBar::getDiscardLevelCB(), handleException(), logFrame, com::cosylab::logging::engine::ACS::LCEngine::setDiscardLevel(), and toolBar.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), connect(), connLCEngDisconnect(), disconnect(), alma::acs::logging::dialogs::main::LogFrame::LogFrame(), com::cosylab::logging::LoggingClient::EventHandler::menuSelected(), com::cosylab::logging::stats::StatsDlg::refreshGUI(), and alma::acs::logging::io::IOLogsHelper::LoadLogs::run().

ErrorBrowserDlg com::cosylab::logging::LoggingClient::getErrorDialog ( ) [inline]

Returns:: The error browser dialog

References errorBrowserDialog.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and addErrorTab().

JPanel com::cosylab::logging::LoggingClient::getJFrameContentPane ( ) [inline, private]

Returns the JFrameContentPane property value.

Returns:: javax.swing.JPanel

References getStatusAreaHrPane(), handleException(), and ivjJFrameContentPane.

Referenced by initialize().

ErrorLogDialog com::cosylab::logging::LoggingClient::getJLogErroDialog ( ) [inline, private]

Returns:: The jlog error dialog

References errorDialog, and logFrame.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and errorReceived().

JPanel com::cosylab::logging::LoggingClient::getJPanel2 ( ) [inline, private]

Returns the JPanel2 property value.

Returns:: javax.swing.JPanel

References getStatusLinePnl(), getTableDetailsVrPane(), handleException(), and ivjJPanel2.

Referenced by getStatusAreaHrPane().

LogTableDataModel com::cosylab::logging::LoggingClient::getLCModel1 ( ) [inline]

Returns the LCModel1 property value.

Returns:: com.cosylab.logging.LogTableDataModel

References tableModel.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), addErrorTab(), alma::acs::logging::io::LoadSwitchesPanel::checkControlsState(), alma::acs::logging::io::LoadSwitchesPanel::execute(), initialize(), alma::acs::logging::dialogs::main::LogFrame::LogFrame(), and com::cosylab::logging::LoggingClient::EventHandler::menuSelected().

JScrollPane com::cosylab::logging::LoggingClient::getLogDetailScrollPane ( ) [inline]

Returns the scroll pane with the details of the logs

Returns:: JScrollPane

References detailedInfoScrollPane, detailedLogTable, and handleException().

Referenced by getDeatailedInfoPanel().

LogEntryTable com::cosylab::logging::LoggingClient::getLogEntryTable ( ) [inline]

Returns the table of logs

Returns:: the table of logs

References alma::acs::logging::table::LogEntryTable::getLCModel(), alma::acs::logging::dialogs::main::LogMenuBar::getLogTypeDescriptionViewMenuItem(), alma::acs::logging::dialogs::main::LogMenuBar::getShortDateViewMenuItem(), handleException(), logEntryTable, menuBar, and tableModel.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), com::cosylab::logging::LoggingClient::CustomColumnListener::componentResized(), connFields(), getLogTableScroolP(), initialize(), com::cosylab::logging::search::SearchDialog::initializeAdvancedPanel(), alma::acs::logging::table::LogTableDataModel::loadFromFile(), logEntryReceived(), alma::acs::logging::dialogs::main::LogFrame::LogFrame(), loggingClient_ComponentResized(), com::cosylab::logging::stats::StatsDlg::refreshGUI(), alma::acs::logging::io::IOLogsHelper::SaveLogs::run(), alma::acs::logging::io::IOLogsHelper::LoadLogs::run(), com::cosylab::logging::search::SearchDialog::search(), com::cosylab::logging::search::SearchDialog::SearchDialog(), and showDetailedLogInfo().

JScrollPane com::cosylab::logging::LoggingClient::getLogTableScroolP ( ) [inline]

Returns the scroll panel with the table of logs

Returns:: the scroll panel with the table of logs

References getLogEntryTable(), handleException(), and scrollLogTable.

Referenced by getTableDetailsVrPane().

UserPreferences com::cosylab::logging::LoggingClient::getPrefs ( ) [inline]

Returns:: A reference to the preferences

References userPreferences.

StatsDlg com::cosylab::logging::LoggingClient::getStatisticDialog ( ) [inline]

Return a dialog showing the statistics

Returns:: The dialog showing the statistic

References statsDlg.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

SmartTextArea com::cosylab::logging::LoggingClient::getStatusArea ( ) [inline, private]

Returns the StatusArea property value.

Returns:: com.cosylab.gui.components.SmartTextArea

References handleException(), and ivjStatusArea.

Referenced by getStatusAreaPanel(), and reportStatus().

JSplitPane com::cosylab::logging::LoggingClient::getStatusAreaHrPane ( ) [inline, private]

Returns the JSplitPane1 property value.

Returns:: javax.swing.JSplitPane

References getJPanel2(), getStatusAreaPanel(), handleException(), and statusAreaHrSplitP.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), getJFrameContentPane(), initialize(), and loggingClient_ComponentResized().

javax.swing.JScrollPane com::cosylab::logging::LoggingClient::getStatusAreaPanel ( ) [inline, private]

Returns the JScrollPane1 property value.

Returns:: javax.swing.JScrollPane

References getStatusArea(), handleException(), and statusAreaPanel.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), getStatusAreaHrPane(), and com::cosylab::logging::LoggingClient::EventHandler::menuSelected().

JPanel com::cosylab::logging::LoggingClient::getStatusLinePnl ( ) [inline, private]

Returns the panel for the status line

Returns:: the panel for the status line

References audienceLbl, CONNECTED_ICON, CONNECTING_ICON, connectionDBLbl, connectionStatusIcons, connectionStatusLbl, DELAY_ICON, DISCONNECTED_ICON, engineFiltersLbl, errorDialog, handleException(), jlogErrorLbl, maxNumOfLogsLbl, progressBar, alma::acs::logging::dialogs::error::ErrorLogDialog::setVisible(), statusLinePnl, SUSPENDED_ICON, and tableFiltersLbl.

Referenced by getJPanel2().

JSplitPane com::cosylab::logging::LoggingClient::getTableDetailsVrPane ( ) [inline, private]

Returns:: the split pane with the table of logs and the table with the details of a log

References getDeatailedInfoPanel(), getLogTableScroolP(), handleException(), and tableDetailsVrSplitP.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), getJPanel2(), initialize(), and loggingClient_ComponentResized().

LogToolBar com::cosylab::logging::LoggingClient::getToolBar ( ) [inline]

Returns:: the toolBar

References toolBar.

Referenced by alma::acs::logging::table::LogEntryTable::TableMouseAdapter::mousePressed().

ZoomManager com::cosylab::logging::LoggingClient::getZoomManager ( ) [inline]

Returns:: the zoom

References zoom.

Referenced by alma::acs::logging::table::LogEntryTable::TableMouseAdapter::mousePressed(), alma::acs::logging::table::TablePopupMenu::show(), alma::acs::logging::table::LogEntryTable::zoom(), and alma::acs::logging::table::LogEntryTable::zoomReadingFile().

void com::cosylab::logging::LoggingClient::handleException ( java.lang.Throwable exception ) [inline, private]

Called whenever the part throws an exception.

Parameters:

exception

java.lang.Throwable

References showErrorMessage().

Referenced by connect(), connFields(), connLCEngDisconnect(), getDeatailedInfoPanel(), getEngine(), getJFrameContentPane(), getJPanel2(), getLogDetailScrollPane(), getLogEntryTable(), getLogTableScroolP(), getStatusArea(), getStatusAreaHrPane(), getStatusAreaPanel(), getStatusLinePnl(), getTableDetailsVrPane(), initialize(), setLCModel1(), and showDetailedLogInfo().

void com::cosylab::logging::LoggingClient::hideExitMenu ( boolean hide ) [inline]

Hide the Exit menu item

Parameters:

hide

If true the menu is set to invisible

References alma::acs::logging::dialogs::main::LogMenuBar::hideExitMenu(), and menuBar.

boolean com::cosylab::logging::LoggingClient::inDebugMode ( ) [inline]

Returns:: true if jlog runs in debug mode

References debugMode.

Referenced by alma::acs::logging::archive::ArchiveConnectionManager::getDBStatus().

void com::cosylab::logging::LoggingClient::initAudience ( AudienceInfo audienceInfo ) [inline, private]

Init the audience.

If an audience has been specified in the command line then it will be used otherwise it tries to check if a java property has been set.
The audience dafaults to ENGINEER.

Parameters:

audienceInfo The audience: it can be null.

References AUDIENCE_PROPERTY, alma::acs::logging::dialogs::main::LogMenuBar::getEngineeringMode(), alma::acs::logging::dialogs::main::LogMenuBar::getOperatorMode(), alma::acs::logging::dialogs::main::LogMenuBar::getSciLogMode(), and menuBar.

Referenced by LoggingClient().

void com::cosylab::logging::LoggingClient::initConnections ( ) throws java.lang.Exception [inline, private]

Initializes connections and adds listeners to all the menus and menu items.

Exceptions:

java.lang.Exception

The exception description.

References eventHandler, menuBar, navigationToolbar, alma::acs::logging::dialogs::main::LogNavigationBar::setEventHandler(), alma::acs::logging::dialogs::main::LogToolBar::setEventHandler(), alma::acs::logging::dialogs::main::LogMenuBar::setEventHandler(), and toolBar.

Referenced by initialize().

void com::cosylab::logging::LoggingClient::initialize	(	LogTypeHelper	logLevel,
		LogTypeHelper	discardLevel,
		boolean	unlimited
	)			`[inline, private]`

Initializes the object.

Parameters:

	logLevel	The initial log level to set in the toolbar and in the table
	discardLevel	The initial discard level to set in the toolbar and in the engine
	unlimited	If `true` the number of logs in memory is unlimited, otherwise the default is used

Referenced by LoggingClient().

boolean com::cosylab::logging::LoggingClient::isConnected ( ) [inline]

Returns:: true if the application is connected to the notification channel

Referenced by acsLogConnDisconnected(), acsLogConnEstablished(), acsLogConnLost(), and com::cosylab::logging::LoggingClient::EventHandler::menuSelected().

boolean com::cosylab::logging::LoggingClient::isPaused ( ) [inline]

Return true if the application is paused

Returns:

References alma::acs::logging::dialogs::main::LogToolBar::isPaused(), and toolBar.

Referenced by alma::acs::logging::table::LogTableDataModel::deleteLogsFromTable().

void com::cosylab::logging::LoggingClient::logEntryReceived ( ILogEntry logEntry ) [inline]

See also:: com.cosylab.logging.engine.ACS.ACSRemoteLogListener

Implements com::cosylab::logging::engine::ACS::ACSRemoteLogListener.

References alma::acs::logging::table::LogEntryTableModelBase::appendLog(), alma::acs::logging::table::LogEntryTable::getLCModel(), and getLogEntryTable().

Referenced by alma::acs::logging::archive::zoom::ManualZoomDlg::logEntryReceived().

void com::cosylab::logging::LoggingClient::loggingClient_ComponentResized ( ComponentEvent e ) [inline]

Sets the height and width generated by user's actions.

References getLogEntryTable(), getStatusAreaHrPane(), and getTableDetailsVrPane().

void com::cosylab::logging::LoggingClient::moveProgressBar ( final int newPos ) [inline]

Move the progressbar when in determinate mode

Parameters:

newPos

References progressBar.

void com::cosylab::logging::LoggingClient::pause ( ) throws Exception [inline]

Method used by the plugin interface in EXEC. Pause the application (scroll lock enabled)

See also:: alma.exec.extension.subsystemplugin.IPauseResume

Exceptions:

Exception

References engine, alma::acs::logging::dialogs::main::LogToolBar::pause(), com::cosylab::logging::engine::ACS::LCEngine::setPaused(), and toolBar.

void com::cosylab::logging::LoggingClient::reportStatus ( String status ) [inline]

Append the report status message to the status area

See also:: com.cosylab.logging.engine.ACS.ACSRemoteLogListener

Implements com::cosylab::logging::engine::ACS::ACSLogConnectionListener.

References com::cosylab::gui::components::r2::SmartTextArea::append(), and getStatusArea().

Referenced by alma::acs::logging::archive::QueryDlg::submitQuery().

void com::cosylab::logging::LoggingClient::resume ( ) throws Exception [inline]

Method used by the plugin interface in EXEC. Unpause the application (scroll lock disabled)

See also:: alma.exec.extension.subsystemplugin.IPauseResume

Exceptions:

Exception

References engine, com::cosylab::logging::engine::ACS::LCEngine::setPaused(), toolBar, and alma::acs::logging::dialogs::main::LogToolBar::unpause().

void com::cosylab::logging::LoggingClient::setEnabled ( boolean enabled ) [inline]

References menuBar, navigationToolbar, alma::acs::logging::dialogs::main::LogMenuBar::setEnabled(), alma::acs::logging::dialogs::main::LogNavigationBar::setEnabled(), alma::acs::logging::dialogs::main::LogToolBar::setEnabled(), and toolBar.

Referenced by alma::acs::logging::table::LogEntryTable::sorterChanged().

void com::cosylab::logging::LoggingClient::setEngineFilterLbl ( ) [inline, private]

Update the label of the filtering of the table

References engine, engineFiltersLbl, com::cosylab::logging::engine::ACS::LCEngine::getFilters(), com::cosylab::logging::engine::ACS::LCEngine::getFiltersString(), and com::cosylab::logging::engine::FiltersVector::hasActiveFilters().

Referenced by initialize(), and showEngineFiltersDialog().

void com::cosylab::logging::LoggingClient::setLCModel1 ( LogTableDataModel newValue ) [inline, private]

Sets the LCModel1 to a new value.

Parameters:

newValue

com.cosylab.logging.LogTableDataModel

References handleException(), and tableModel.

void com::cosylab::logging::LoggingClient::setLogDetailContent ( ILogEntry log ) [inline]

Set the content of the detailed info table from the given log

Parameters:

log The log entry which fields have to be shown in the table It can be null

References detailedLogTable, and com::cosylab::logging::client::DetailedLogTable::setupContent().

Referenced by alma::acs::logging::table::TablePopupMenu::actionPerformed(), and alma::acs::logging::table::LogEntryTable::changeSelection().

void com::cosylab::logging::LoggingClient::setNumberOfLogsLbl ( ) [inline, private]

Update the label with the number of logs in memory

References alma::acs::logging::preferences::UserPreferences::getMaxNumOfLogs(), maxNumOfLogsLbl, and userPreferences.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and initialize().

void com::cosylab::logging::LoggingClient::setTableFilterLbl ( ) [inline, private]

Update the label of the filtering of the table

References alma::acs::logging::table::LogEntryTable::getFilters(), alma::acs::logging::table::LogEntryTable::getFiltersString(), com::cosylab::logging::engine::FiltersVector::hasActiveFilters(), logEntryTable, and tableFiltersLbl.

Referenced by initialize(), and showTableFiltersDialog().

void com::cosylab::logging::LoggingClient::showDBStatus	(	ImageIcon	icon,
		String	msg
	)			`[inline]`

Update the GUI with the status of the DB connection

Parameters:

	icon	The icon
	msg	A message to show as tooltip

References connectionDBLbl.

Referenced by alma::acs::logging::archive::ArchiveConnectionManager::showDBStatus().

void com::cosylab::logging::LoggingClient::showDetailedLogInfo ( ) [inline]

Show a detailed view of the selected log in the right panel

References detailedLogTable, alma::acs::logging::table::LogEntryTable::getLCModel(), getLogEntryTable(), alma::acs::logging::table::LogEntryTableModelBase::getVisibleLogEntry(), handleException(), and com::cosylab::logging::client::DetailedLogTable::setupContent().

void com::cosylab::logging::LoggingClient::showEngineFiltersDialog ( ) [inline, private]

Shows the dialog to set filters in the engine

References engine, engineFiltersDlg, com::cosylab::logging::engine::ACS::LCEngine::getFilters(), setEngineFilterLbl(), com::cosylab::logging::settings::FilterChooserDialog::setFilters(), com::cosylab::logging::engine::ACS::LCEngine::setFilters(), and com::cosylab::logging::settings::FilterChooserDialog::setVisible().

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

void com::cosylab::logging::LoggingClient::showErrorMessage	(	String	shortDescription,
		Throwable	t
	)			`[inline]`

Show an error in the error panel displayed on top of the table of logs.

Implementation notes:

this method shows the error widget and set the glass pane so that it will catch all the events but those directed the error widget's ACK button. What this method does not do, is to make the glass pane visible. This is done by the connection listener methods. If, in future, you want to show the glass pane even here, you should do it explicitly.
when the connection with ACS is again available, the acsLogConnEstablished programmatically pushes the ACS button of the error widget causing the widget to disappear without any intervention from the user. This is very useful when the auto reconnect option is enabled. However, note that if showErrorMessage is used for notifying other abnormal situations then a different strategy must be used to avoid the error widget to disappear at the wrong time (i.e. without the user acknowledge the problem).

showErrorMessage prints a message in the stderr too in case the glass pane can't be made visible (for example if an error occurs while building the LoggingClient object).

Parameters:

	shortDescription	The description of the error
	t	The throwable that caused the error (can be `null`).

Returns:

References errorWidget, com::cosylab::logging::MessageWidget::getAckButton(), glassPane, menuBar, navigationToolbar, alma::acs::logging::dialogs::main::LogMenuBar::setEnabled(), alma::acs::logging::dialogs::main::LogNavigationBar::setEnabled(), alma::acs::logging::dialogs::main::LogToolBar::setEnabled(), com::cosylab::logging::TransparentGlassPane::setEventComponent(), com::cosylab::logging::MessageWidget::showMessage(), and toolBar.

Referenced by acsLogConnLost(), and handleException().

void com::cosylab::logging::LoggingClient::showTableFiltersDialog ( java.awt.event.ActionEvent arg1 ) [inline, private]

Triggers the Filters dialog visual appearance as soon as the item "Filters" is clicked.

Parameters:

arg1

java.awt.event.ActionEvent

References enableFiltersWidgets(), filterChooserDialog, alma::acs::logging::table::LogEntryTable::getFilters(), logEntryTable, com::cosylab::logging::settings::FilterChooserDialog::setFilters(), alma::acs::logging::table::LogEntryTable::setFilters(), setTableFilterLbl(), and com::cosylab::logging::settings::FilterChooserDialog::setVisible().

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

void com::cosylab::logging::LoggingClient::start ( ) throws Exception [inline]

Method used by the plugin interface in EXEC: it connects the application to the NC

See also:: alma.exec.extension.subsystemplugin.SubsystemPlugin

Exceptions:

Exception

References connect(), containerServices, and isStopped.

void com::cosylab::logging::LoggingClient::stop ( ) throws Exception [inline]

Method used by the plugin interface in EXEC. Stop the application disconnecting from the NC

See also:: alma.exec.extension.subsystemplugin.SubsystemPlugin

Exceptions:

Exception

References close(), and isStopped.

Referenced by alma::acs::logging::dialogs::main::LogFrame::closeApplication().

Member Data Documentation

ArchiveConnectionManager com::cosylab::logging::LoggingClient::archive [private]

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), initialize(), and com::cosylab::logging::LoggingClient::EventHandler::menuSelected().

final String com::cosylab::logging::LoggingClient::AUDIENCE_PROPERTY = "jlog.mode.audience" [static, private]

The name of the property to set for enabling the operator mode at startup.

If the property is not found, ENGINEER audience is set in the engine

initAudience()

Referenced by initAudience().

JLabel com::cosylab::logging::LoggingClient::audienceLbl = new JLabel() [private]

The audience in use by the engine and shown in the status line

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and getStatusLinePnl().

final int com::cosylab::logging::LoggingClient::CONNECTED_ICON = 0 [private]

The icons to show the status of the connection

Referenced by acsLogConnEstablished(), and getStatusLinePnl().

final int com::cosylab::logging::LoggingClient::CONNECTING_ICON = 1 [private]

Referenced by acsLogConnConnecting(), and getStatusLinePnl().

JLabel com::cosylab::logging::LoggingClient::connectionDBLbl [private]

The label where the icon representing the status of the connection with the DB is shown

Referenced by getStatusLinePnl(), and showDBStatus().

ImageIcon [] com::cosylab::logging::LoggingClient::connectionStatusIcons [private]

Referenced by acsLogConnConnecting(), acsLogConnDisconnected(), acsLogConnEstablished(), acsLogConnSuspended(), acsLogsDelay(), and getStatusLinePnl().

JLabel com::cosylab::logging::LoggingClient::connectionStatusLbl [private]

The label where icon is shown

Referenced by acsLogConnConnecting(), acsLogConnDisconnected(), acsLogConnEstablished(), acsLogConnSuspended(), acsLogsDelay(), and getStatusLinePnl().

ContainerServicesBase com::cosylab::logging::LoggingClient::containerServices = null [protected]

containerServices is always set while running as OMC plugin.

It is used to avoid creating a new ORB when one is already available.

See also:: connect()

Referenced by connect(), getContainerServices(), and start().

QueryDlg com::cosylab::logging::LoggingClient::databaseDlg = null [private]

The dialog to query the database

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), and close().

final String com::cosylab::logging::LoggingClient::DEBUG_MODE_PROPERTY = "alma.acs.jlog.debugMode" [static, private]

The following property is set if logs runs in debug mode

final boolean com::cosylab::logging::LoggingClient::debugMode = Boolean.getBoolean(DEBUG_MODE_PROPERTY) [private]

true if jlog runs in debug mode

Referenced by inDebugMode().

final LogTypeHelper com::cosylab::logging::LoggingClient::DEFAULT_DISCARDLEVEL = LogTypeHelper.DEBUG [static]

The default discard level

Referenced by LoggingClient().

final LogTypeHelper com::cosylab::logging::LoggingClient::DEFAULT_LOGLEVEL = LogTypeHelper.INFO [static]

The default log level

Referenced by LoggingClient().

final int com::cosylab::logging::LoggingClient::DELAY_ICON = 4 [private]

Referenced by acsLogsDelay(), and getStatusLinePnl().

JPanel com::cosylab::logging::LoggingClient::detailedInfoPanel = null [private]

Referenced by getDeatailedInfoPanel().

JScrollPane com::cosylab::logging::LoggingClient::detailedInfoScrollPane = null [private]

Referenced by getLogDetailScrollPane().

DetailedLogTable com::cosylab::logging::LoggingClient::detailedLogTable = new DetailedLogTable() [private]

Referenced by getLogDetailScrollPane(), setLogDetailContent(), and showDetailedLogInfo().

final int com::cosylab::logging::LoggingClient::DISCONNECTED_ICON = 2 [private]

Referenced by acsLogConnDisconnected(), and getStatusLinePnl().

LCEngine com::cosylab::logging::LoggingClient::engine = null [private]

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), close(), getEngine(), pause(), resume(), setEngineFilterLbl(), and showEngineFiltersDialog().

FilterChooserDialog com::cosylab::logging::LoggingClient::engineFiltersDlg = null [private]

The dialog to choose filters to apply to the engine

Referenced by close(), and showEngineFiltersDialog().

JLabel com::cosylab::logging::LoggingClient::engineFiltersLbl = new JLabel() [private]

The label showing if there are active filters in the engine

Referenced by getStatusLinePnl(), and setEngineFilterLbl().

ErrorBrowserDlg com::cosylab::logging::LoggingClient::errorBrowserDialog = null [private]

The error broser dialog

Referenced by close(), and getErrorDialog().

ErrorLogDialog com::cosylab::logging::LoggingClient::errorDialog [private]

The error dialog

Referenced by close(), getJLogErroDialog(), and getStatusLinePnl().

MessageWidget com::cosylab::logging::LoggingClient::errorWidget = new MessageWidget() [private]

The glass pane showing messages to the user

Referenced by acsLogConnEstablished(), initialize(), and showErrorMessage().

EventHandler com::cosylab::logging::LoggingClient::eventHandler = new EventHandler() [private]

Referenced by initConnections().

FilterChooserDialog com::cosylab::logging::LoggingClient::filterChooserDialog = null [private]

The dialog to manage table filters There is only one instance of this dialog that can be visible or invisible. It is disposed by calling the close() (usually done by the LoggingClient before exiting.

Referenced by close(), and showTableFiltersDialog().

TransparentGlassPane com::cosylab::logging::LoggingClient::glassPane [private]

The glass pane visible when jlog runs offline.

Referenced by acsLogConnDisconnected(), acsLogConnEstablished(), acsLogConnLost(), errorAcknowledged(), initialize(), and showErrorMessage().

boolean com::cosylab::logging::LoggingClient::isConnected = false [private]

true if the engine is connected.

Referenced by alma::acs::logging::io::LoadSwitchesPanel::checkControlsState().

volatile boolean com::cosylab::logging::LoggingClient::isStopped = true [private]

true if the application is stopped

This property is set by the start() and stop(). It is also set in the constructor for the stand alone version because in that case the start is not executed.

Referenced by acsLogConnLost(), LoggingClient(), start(), and stop().

JPanel com::cosylab::logging::LoggingClient::ivjJFrameContentPane = null [private]

Referenced by getJFrameContentPane().

JPanel com::cosylab::logging::LoggingClient::ivjJPanel2 = null [private]

Referenced by getJPanel2().

SmartTextArea com::cosylab::logging::LoggingClient::ivjStatusArea = null [private]

The status area

Referenced by getStatusArea().

final JLabel com::cosylab::logging::LoggingClient::jlogErrorLbl = new JLabel(new ImageIcon(this.getClass().getResource("/errorLogIcon.png"))) [private]

The label where appears the icon to tell that there are error in the jlog error log dialog

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), errorReceived(), and getStatusLinePnl().

LogEntryTable com::cosylab::logging::LoggingClient::logEntryTable = null [private]

The table of logs

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), close(), getLogEntryTable(), setTableFilterLbl(), and showTableFiltersDialog().