com.paypal.test.utilities.logging

Class SimpleLoggerSettings

java.lang.Object

com.paypal.test.utilities.logging.SimpleLoggerSettings

Direct Known Subclasses:

SeLionLogger.SeLionLoggerSettings

public class SimpleLoggerSettings
extends Object

This class represents the collections of settings which are consumed by SimpleLogger. Use this class to configure your customized logger.

With this class you can configure SimpleLogger to create User and/or Developer log files and at Level s which best fit your needs. In addition, you can attach a ConsoleHandler to either the User or Developer log. You can enable rolling logs by specifying a max size you want your log file to grow to and the number of files to save (roll).

Default settings are as follows;

      - Logger name = return value of SimpleLogger.class.getCanonicalName();
      - Logger class name = return value of SimpleLogger.class.getSimpleName();
      - Logger directory = return value of System.getProperty(String) with 'user.dir' passed
      - User log filename = user.log
      - Developer log filename = developer.log
      - User log level = Level.FINE
      - Developer log level = Level.ALL
      - Application identifier = ''
      - Console log level = SimpleLogger.ConsoleLevel.OFF
      - SimpleLogger events = none
      - Max File Size = 0 (unlimited)
      - Max File Count = 1
 

Constructor Summary

Constructors

Constructor and Description
SimpleLoggerSettings() Create new SimpleLoggerSettings with default settings

Method Summary

Modifier and Type	Method and Description
String	getClassName()
String	getDeveloperLogFileName()
Level	getDevLevel()
String	getIdentifier()
SimpleLogger.ConsoleLevel	getLog2Console()
String	getLoggerName()
String	getLogsDir()
int	getMaxFileCount()
int	getMaxFileSize()
SimpleLoggerEvents	getSimpleLoggerEventsImpl()
Level	getUserLevel()
String	getUserLogFileName()
void	setClassName(String className) set the logging class name
void	setDeveloperLogFileName(String filename) set the filename for developer log activity
void	setDevLevel(Level level) set the Level for developer log activity
void	setIdentifier(String identifier) set the application identifier for logging activity.
void	setLog2Console(SimpleLogger.ConsoleLevel level) set the SimpleLogger.ConsoleLevel that represents the log activity you want to see in stderr via a ConsoleHandler
void	setLoggerName(String name) set the logger name
void	setLogsDir(String dir) set the directory for storing log files
void	setMaxFileCount(int maxFileCount)
void	setMaxFileSize(int maxFileSize)
void	setSimpleLoggerEventsImpl(SimpleLoggerEvents impl) register your own SimpleLoggerEvents implementation for receiving SimpleLogger events
void	setUserLevel(Level level) set the Level for user log activity
void	setUserLogFileName(String filename) set the filename for user log activity

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLoggerSettings

public SimpleLoggerSettings()

Create new SimpleLoggerSettings with default settings

Method Detail

getClassName

public String getClassName()

Returns:

the configured logging class name

getDeveloperLogFileName

public String getDeveloperLogFileName()

Returns:

the configured developer log file name for developer level events

getDevLevel

public Level getDevLevel()

Returns:

the configured log Level for developer level events

getLoggerName

public String getLoggerName()

Returns:

the configured logger name

getUserLogFileName

public String getUserLogFileName()

Returns:

the configured user log file name for user level events

getUserLevel

public Level getUserLevel()

Returns:

the configured log Level for user level events

getIdentifier

public String getIdentifier()

Returns:

the configured application identifier for logging events

setClassName

public void setClassName(String className)

set the logging class name

Parameters:

className -

setDeveloperLogFileName

public void setDeveloperLogFileName(String filename)

set the filename for developer log activity

Parameters:

filename -

setDevLevel

public void setDevLevel(Level level)

set the Level for developer log activity

Parameters:

level -

setLoggerName

public void setLoggerName(String name)

set the logger name

Parameters:

name -

setUserLogFileName

public void setUserLogFileName(String filename)

set the filename for user log activity

Parameters:

filename -

setUserLevel

public void setUserLevel(Level level)

set the Level for user log activity

Parameters:

level -

setIdentifier

public void setIdentifier(String identifier)

set the application identifier for logging activity.

Parameters:

identifier -

getLogsDir

public String getLogsDir()

Returns:

the configured directory for storing log files

setLogsDir

public void setLogsDir(String dir)

set the directory for storing log files

Parameters:

dir -

getLog2Console

public SimpleLogger.ConsoleLevel getLog2Console()

Returns:

the configured SimpleLogger.ConsoleLevel for echoing log activity to stderr via a ConsoleHandler

setLog2Console

public void setLog2Console(SimpleLogger.ConsoleLevel level)

set the SimpleLogger.ConsoleLevel that represents the log activity you want to see in stderr via a ConsoleHandler

Parameters:

level -

setSimpleLoggerEventsImpl

public void setSimpleLoggerEventsImpl(SimpleLoggerEvents impl)

register your own SimpleLoggerEvents implementation for receiving SimpleLogger events

Parameters:

impl -

getSimpleLoggerEventsImpl

public SimpleLoggerEvents getSimpleLoggerEventsImpl()

Returns:

the configured SimpleLoggerEvents implementation to receive SimpleLogger events

getMaxFileSize

public int getMaxFileSize()

Returns:

the maxFileSize in MB. If 0 then there is no max file size limit.

setMaxFileSize

public void setMaxFileSize(int maxFileSize)

Parameters:

maxFileSize - the maxFileSize in MB to set. Use 0 to set no max file size limit.

getMaxFileCount

public int getMaxFileCount()

Returns:

the maximum number of files that will be created from rolling logs.

setMaxFileCount

public void setMaxFileCount(int maxFileCount)

Parameters:

maxFileCount - the maximum number of files that will be created from rolling logs.