org.opencms.ui.apps.logfile

Class CmsLogFileApp

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceApp

org.opencms.ui.apps.logfile.CmsLogFileApp

All Implemented Interfaces:

I_CmsWorkplaceApp

public class CmsLogFileApp
extends A_CmsWorkplaceApp

Main class of Log managment app.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

A_CmsWorkplaceApp.NavEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LOG_FOLDER Log folder path.
protected CmsLogFileView	m_fileView The log file view layout.

Fields inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

m_infoLayout, m_rootLayout, m_uiContext, PARAM_ASSIGN, PARAM_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
CmsLogFileApp()

Method Summary

Modifier and Type	Method and Description
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	getBreadCrumbForState(java.lang.String state) Returns the current bread crumb entries in an ordered map.
protected com.vaadin.ui.Component	getComponentForState(java.lang.String state) Returns the app component for the given state.
protected static java.lang.String	getFileName(org.apache.logging.log4j.core.Appender app) Returns the file name or null associated with the given appender.
protected java.util.List<A_CmsWorkplaceApp.NavEntry>	getSubNavEntries(java.lang.String state) Returns the sub navigation entries.
void	initUI(I_CmsAppUIContext context) Within this method the app UI should be initialized.
protected static boolean	isFileAppender(org.apache.logging.log4j.core.Appender appender) Checks whether the given log appender has a getFileName method to identify file based appenders.

Methods inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

addParamToState, addSubNavEntry, getLastPathLevel, getOfflineCmsObject, getParamFromState, getParamsFromState, onStateChange, openSubView, setBreadCrumbEntries, updateBreadCrumb, updateSubNav

Methods inherited from class java.lang.Object

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

Field Detail

LOG_FOLDER

protected static final java.lang.String LOG_FOLDER

Log folder path.

m_fileView

protected CmsLogFileView m_fileView

The log file view layout.

Constructor Detail

CmsLogFileApp

public CmsLogFileApp()

Method Detail

getFileName

protected static java.lang.String getFileName(org.apache.logging.log4j.core.Appender app)

Returns the file name or null associated with the given appender.

Parameters:

app - the appender

Returns:

the file name

isFileAppender

protected static boolean isFileAppender(org.apache.logging.log4j.core.Appender appender)

Checks whether the given log appender has a getFileName method to identify file based appenders.

As since log4j 2.0 file appenders don't have one common super class that allows access to the file name, but they all implement a method 'getFileName'.

Parameters:

appender - the appender to check

Returns:

in case of a file based appender

initUI

public void initUI(I_CmsAppUIContext context)

Description copied from interface: I_CmsWorkplaceApp

Within this method the app UI should be initialized.

Use the context to add the app's components to the UI.

Specified by:

initUI in interface I_CmsWorkplaceApp

Overrides:

initUI in class A_CmsWorkplaceApp

Parameters:

context - the UI context

See Also:

A_CmsWorkplaceApp.initUI(org.opencms.ui.apps.I_CmsAppUIContext)

getBreadCrumbForState

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> getBreadCrumbForState(java.lang.String state)

Description copied from class: A_CmsWorkplaceApp

Returns the current bread crumb entries in an ordered map.

Specified by:

getBreadCrumbForState in class A_CmsWorkplaceApp

Parameters:

state - the current state

Returns:

bread crumb entry name by state, in case the state is empty, the entry will be disabled

See Also:

A_CmsWorkplaceApp.getBreadCrumbForState(java.lang.String)

getComponentForState

protected com.vaadin.ui.Component getComponentForState(java.lang.String state)

Description copied from class: A_CmsWorkplaceApp

Returns the app component for the given state.

Specified by:

getComponentForState in class A_CmsWorkplaceApp

Parameters:

state - the state to render

Returns:

the app component

See Also:

A_CmsWorkplaceApp.getComponentForState(java.lang.String)

getSubNavEntries

protected java.util.List<A_CmsWorkplaceApp.NavEntry> getSubNavEntries(java.lang.String state)

Description copied from class: A_CmsWorkplaceApp

Returns the sub navigation entries.

Specified by:

getSubNavEntries in class A_CmsWorkplaceApp

Parameters:

state - the state

Returns:

the sub navigation entries

See Also:

A_CmsWorkplaceApp.getSubNavEntries(java.lang.String)