psdi.util.logging

Class LoggingService

java.lang.Object

psdi.server.AppService

psdi.util.logging.LoggingService

All Implemented Interfaces:

java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers, LoggingServiceRemote

public class LoggingService
extends AppService
implements LoggingServiceRemote

Field Summary

Fields inherited from interface psdi.util.logging.LoggingServiceRemote

MAXLOGGERCACHE

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
LoggingService()
LoggingService(MXServer mxServer)

Method Summary

Methods

Modifier and Type	Method and Description
void	applySettings(boolean startup) Reload logging configurations from database tables and apply the settings.
java.lang.String	generateLoggingProperties() Return the logging properties in the format of a property file.
MboSetRemote	getAppenderList() Returns all the available appenders.
java.util.Vector<java.lang.String>	getLogFiles() Returns a list of log file paths.
MboSetRemote	getLoggerList() Returns all the available loggers.
java.lang.String	getLogLevel(java.lang.String logKey) Given a logger by its logkey, return its log level.
java.lang.String	getLTA_URL() Launch the Log and Trace Analyzer.
static boolean	getReadFromFile() Returns the flag which indicates whether the server's logging is read from a properties file.
java.lang.String	getRootFolder() Returns the root logging folder.
void	setLogLevel(java.lang.String logKey, java.lang.String logLevel) Sets the log level of the specified logger.
static void	setReadFromFile(boolean flag) Sets the flag which indicates whether the server's logging is read from a properties file.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Constructor Detail

LoggingService

public LoggingService()
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

LoggingService

public LoggingService(MXServer mxServer)
               throws java.rmi.RemoteException

Parameters:

mxServer - The "Server Environment" this Service is being created in.

Throws:

java.rmi.RemoteException

Method Detail

generateLoggingProperties

public java.lang.String generateLoggingProperties()
                                           throws MXException,
                                                  java.rmi.RemoteException

Return the logging properties in the format of a property file.

Specified by:

generateLoggingProperties in interface LoggingServiceRemote

Throws:

MXException

java.rmi.RemoteException

applySettings

public void applySettings(boolean startup)
                   throws MXException,
                          java.rmi.RemoteException

Reload logging configurations from database tables and apply the settings.

Specified by:

applySettings in interface LoggingServiceRemote

Parameters:

startup - Boolean flag to indicate whether the method is being called when the server is starting up, or from the action menu.

Throws:

MXException

java.rmi.RemoteException

getRootFolder

public java.lang.String getRootFolder()
                               throws java.rmi.RemoteException

Returns the root logging folder.

Specified by:

getRootFolder in interface LoggingServiceRemote

Returns:

The root logging folder.

Throws:

java.rmi.RemoteException

getLoggerList

public MboSetRemote getLoggerList()
                           throws MXException,
                                  java.rmi.RemoteException

Returns all the available loggers.

Specified by:

getLoggerList in interface LoggingServiceRemote

Returns:

A list of loggers

Throws:

MXException

java.rmi.RemoteException

getAppenderList

public MboSetRemote getAppenderList()
                             throws MXException,
                                    java.rmi.RemoteException

Returns all the available appenders.

Specified by:

getAppenderList in interface LoggingServiceRemote

Returns:

A list of appenders

Throws:

MXException

java.rmi.RemoteException

getLogLevel

public java.lang.String getLogLevel(java.lang.String logKey)
                             throws MXException,
                                    java.rmi.RemoteException

Given a logger by its logkey, return its log level.

Specified by:

getLogLevel in interface LoggingServiceRemote

Parameters:

logKey - The key uniquely identifies the logger.

Returns:

The logger's log level.

Throws:

MXException

java.rmi.RemoteException

setLogLevel

public void setLogLevel(java.lang.String logKey,
               java.lang.String logLevel)
                 throws MXException,
                        java.rmi.RemoteException

Sets the log level of the specified logger. Note: This is a web service method and should be used as a web service only. Do not call from Maximo app.

Specified by:

setLogLevel in interface LoggingServiceRemote

Parameters:

logkey - The key uniquely identifies the logger.

logLevel - The loglevel to set to thelogger.

Throws:

MXException

java.rmi.RemoteException

setReadFromFile

public static void setReadFromFile(boolean flag)

Sets the flag which indicates whether the server's logging is read from a properties file.

Parameters:

flag -

getReadFromFile

public static boolean getReadFromFile()

Returns the flag which indicates whether the server's logging is read from a properties file.

Returns:

Boolean

getLogFiles

public java.util.Vector<java.lang.String> getLogFiles()
                                               throws MXException,
                                                      java.rmi.RemoteException

Returns a list of log file paths.

Specified by:

getLogFiles in interface LoggingServiceRemote

Returns:

Vector

Throws:

MXException

java.rmi.RemoteException

getLTA_URL

public java.lang.String getLTA_URL()
                            throws MXException,
                                   java.rmi.RemoteException

Launch the Log and Trace Analyzer.

Specified by:

getLTA_URL in interface LoggingServiceRemote

Throws:

MXException

java.rmi.RemoteException