A B C D E F G H I J L M N O P R S T U W X

A

AbstractFilterTarget - class org.apache.log.filter.AbstractFilterTarget.

Abstract implementation of FilterTarget.

AbstractFilterTarget() - Constructor for class org.apache.log.filter.AbstractFilterTarget

AbstractJDBCTarget - class org.apache.log.output.db.AbstractJDBCTarget.

Abstract JDBC target.

AbstractJDBCTarget(DataSource) - Constructor for class org.apache.log.output.db.AbstractJDBCTarget

Creation of a new instance of the AbstractJDBCTarget.

AbstractJMSTarget - class org.apache.log.output.jms.AbstractJMSTarget.

A target that writes to a JMS Topic.

AbstractJMSTarget(MessageBuilder) - Constructor for class org.apache.log.output.jms.AbstractJMSTarget

AbstractJMSTarget(MessageBuilder, ErrorHandler) - Constructor for class org.apache.log.output.jms.AbstractJMSTarget

AbstractOutputTarget - class org.apache.log.output.AbstractOutputTarget.

Abstract output target.

AbstractOutputTarget() - Constructor for class org.apache.log.output.AbstractOutputTarget

Parameterless constructor.

AbstractOutputTarget(Formatter) - Constructor for class org.apache.log.output.AbstractOutputTarget

Creation of a new abstract output target instance.

AbstractTarget - class org.apache.log.output.AbstractTarget.

Abstract target.

AbstractTarget() - Constructor for class org.apache.log.output.AbstractTarget

AbstractTarget constructor.

AbstractTarget(ErrorHandler) - Constructor for class org.apache.log.output.AbstractTarget

AbstractTarget constructor.

addLoggerListener(LoggerListener) - Method in class org.apache.log.Hierarchy

Set the LoggerListener associated with hierarchy.

addTarget(LogTarget) - Method in interface org.apache.log.FilterTarget

Deprecated. Add a target to output chain.

addTarget(LogTarget) - Method in class org.apache.log.filter.AbstractFilterTarget

Add a new target to output chain.

AsyncLogTarget - class org.apache.log.output.AsyncLogTarget.

An asynchronous LogTarget that sends entries on in another thread.

AsyncLogTarget(LogTarget) - Constructor for class org.apache.log.output.AsyncLogTarget

Creation of a new async log target.

AsyncLogTarget(LogTarget, int) - Constructor for class org.apache.log.output.AsyncLogTarget

Creation of a new async log target.

AvalonFormatter - class org.apache.log.format.AvalonFormatter.

Deprecated. Use org.apache.avalon.framework.logger.AvalonFormatter instead of this one.

AvalonFormatter(String) - Constructor for class org.apache.log.format.AvalonFormatter

Deprecated. Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth of 8.

AvalonFormatter(String, int, boolean) - Constructor for class org.apache.log.format.AvalonFormatter

Deprecated. Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth specified.

B

bind(ContextMap) - Static method in class org.apache.log.ContextMap

Bind a particular ContextMap to current thread.

buildMessage(Session, LogEvent) - Method in class org.apache.log.output.jms.TextMessageBuilder

Build a message from the supplied session for the supplied event

buildMessage(Session, LogEvent) - Method in class org.apache.log.output.jms.ObjectMessageBuilder

Creation of a new message.

buildMessage(Session, LogEvent) - Method in interface org.apache.log.output.jms.MessageBuilder

Creation of a new message.

C

CATEGORY - Static variable in class org.apache.log.output.db.ColumnType

CATEGORY - Static variable in class org.apache.log.output.jms.PropertyType

CATEGORY_SEPARATOR - Static variable in class org.apache.log.Logger

Separator character use to separate different categories

CATEGORY_STR - Static variable in class org.apache.log.output.db.ColumnType

CATEGORY_STR - Static variable in class org.apache.log.output.jms.PropertyType

checkConnection() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Utility method to check connection and bring it back up if necessary.

clear() - Method in class org.apache.log.ContextStack

Deprecated. Empty the context stack.

clear() - Method in class org.apache.log.ContextMap

Empty the context map.

close() - Method in class org.apache.log.output.ServletOutputLogTarget

Shutdown target.

close() - Method in class org.apache.log.output.AbstractTarget

Shutdown target.

close() - Method in class org.apache.log.output.AbstractOutputTarget

Shutdown target.

close() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Shutdown target.

close() - Method in class org.apache.log.output.io.WriterTarget

Shutdown target.

close() - Method in class org.apache.log.output.io.StreamTarget

Shutdown target.

close() - Method in class org.apache.log.output.jms.AbstractJMSTarget

Shutdown target.

close() - Method in class org.apache.log.output.net.SocketOutputTarget

Shutdown target.

close() - Method in class org.apache.log.output.net.SMTPOutputLogTarget

Closes this log target.

close() - Method in class org.apache.log.output.net.DatagramOutputTarget

Shutdown target.

close() - Method in class org.apache.log.util.LoggerOutputStream

Shutdown stream.

closeConnection() - Method in class org.apache.log.output.db.DefaultJDBCTarget

Close connection to underlying database.

closeConnection() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Close connection to underlying database.

closeConnection() - Method in class org.apache.log.output.jms.JMSTopicTarget

closeConnection() - Method in class org.apache.log.output.jms.JMSQueueTarget

closeConnection() - Method in class org.apache.log.output.jms.AbstractJMSTarget

ColumnInfo - class org.apache.log.output.db.ColumnInfo.

A descriptor for each column stored in table.

ColumnInfo(String, int, String) - Constructor for class org.apache.log.output.db.ColumnInfo

Creation of a new column info instance.

ColumnType - class org.apache.log.output.db.ColumnType.

A class to hold all constants for ColumnTypes.

ColumnType() - Constructor for class org.apache.log.output.db.ColumnType

CONTEXT - Static variable in class org.apache.log.output.db.ColumnType

CONTEXT - Static variable in class org.apache.log.output.jms.PropertyType

CONTEXT_STR - Static variable in class org.apache.log.output.db.ColumnType

CONTEXT_STR - Static variable in class org.apache.log.output.jms.PropertyType

ContextMap - class org.apache.log.ContextMap.

The ContextMap contains non-hierarchical context information relevant to a particular LogEvent.

ContextMap() - Constructor for class org.apache.log.ContextMap

Default constructor.

ContextMap(ContextMap) - Constructor for class org.apache.log.ContextMap

Constructor that sets parent contextMap.

ContextStack - class org.apache.log.ContextStack.

Deprecated. This class has been deprecated as it encouraged use of bad design practices. Use org.apache.log.ContextMap instead.

ContextStack() - Constructor for class org.apache.log.ContextStack

Deprecated.

D

DatagramOutputTarget - class org.apache.log.output.DatagramOutputTarget.

Deprecated. Use org.apache.log.output.net.DatagramOutputTarget instead

DatagramOutputTarget - class org.apache.log.output.net.DatagramOutputTarget.

A datagram output target.

DatagramOutputTarget(InetAddress, int) - Constructor for class org.apache.log.output.DatagramOutputTarget

Deprecated. Create a output target with end point specified by address and port.

DatagramOutputTarget(InetAddress, int) - Constructor for class org.apache.log.output.net.DatagramOutputTarget

Create a output target with end point specified by address and port.

DatagramOutputTarget(InetAddress, int, Formatter) - Constructor for class org.apache.log.output.DatagramOutputTarget

Deprecated. Create a output target with end point specified by address and port.

DatagramOutputTarget(InetAddress, int, Formatter) - Constructor for class org.apache.log.output.net.DatagramOutputTarget

Create a output target with end point specified by address and port.

DEBUG - Static variable in class org.apache.log.Priority

Developer orientated messages, usually used during development of product.

debug(String) - Method in class org.apache.log.Logger

Log a debug priority event.

debug(String, Throwable) - Method in class org.apache.log.Logger

Log a debug priority event.

DEFAULT_PRINT_CASCADING - Static variable in class org.apache.log.format.AvalonFormatter

Deprecated. The constant defining the default behaviour for printing nested exceptions.

DEFAULT_STACK_DEPTH - Static variable in class org.apache.log.format.AvalonFormatter

Deprecated. The constant defining the default stack depth when none other is specified.

DefaultDataSource - class org.apache.log.output.db.DefaultDataSource.

A basic datasource that doesn't do any pooling but just wraps around default mechanisms.

DefaultDataSource(String, String, String) - Constructor for class org.apache.log.output.db.DefaultDataSource

DefaultErrorHandler - class org.apache.log.util.DefaultErrorHandler.

Handle unrecoverable errors that occur during logging by writing to standard error.

DefaultErrorHandler() - Constructor for class org.apache.log.util.DefaultErrorHandler

DefaultJDBCTarget - class org.apache.log.output.db.DefaultJDBCTarget.

The basic DB target for configurable output formats.

DefaultJDBCTarget(DataSource, String, ColumnInfo[]) - Constructor for class org.apache.log.output.db.DefaultJDBCTarget

Creation of a new JDBC logging target.

DefaultOutputLogTarget - class org.apache.log.output.DefaultOutputLogTarget.

Deprecated. Use org.apache.log.output.io.WriterTarget or org.apache.log.output.io.StreamTarget as appropriate as this class encourages unsafe behaviour

DefaultOutputLogTarget() - Constructor for class org.apache.log.output.DefaultOutputLogTarget

Deprecated. Default Constructor.

DefaultOutputLogTarget(Formatter) - Constructor for class org.apache.log.output.DefaultOutputLogTarget

Deprecated.

DefaultOutputLogTarget(OutputStream) - Constructor for class org.apache.log.output.DefaultOutputLogTarget

Deprecated. Constructor that takes a stream arguement.

DefaultOutputLogTarget(Writer) - Constructor for class org.apache.log.output.DefaultOutputLogTarget

Deprecated. Constructor that takes a writer parameter.

DefaultOutputLogTarget(Writer, Formatter) - Constructor for class org.apache.log.output.DefaultOutputLogTarget

Deprecated.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.MemoryTarget

Process a log event, via formatting and outputting it.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.AsyncLogTarget

Process a log event by adding it to queue.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.AbstractTarget

Process a log event, via formatting and outputting it.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.AbstractOutputTarget

Process a log event.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.db.AbstractJDBCTarget

Process a log event, via formatting and outputting it.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.jms.AbstractJMSTarget

Process a log event, via formatting and outputting it.

doProcessEvent(LogEvent) - Method in class org.apache.log.output.net.SocketOutputTarget

To process the LogEvent

E

ERROR - Static variable in class org.apache.log.Priority

A problem has occurred but it is not fatal.

error(String) - Method in class org.apache.log.Logger

Log a error priority event.

error(String, Throwable) - Method in class org.apache.log.Logger

Log a error priority event.

error(String, Throwable) - Method in class org.apache.log.output.AbstractTarget

Deprecated. Use getErrorHandler().error(...) directly

error(String, Throwable, LogEvent) - Method in interface org.apache.log.ErrorHandler

Log an unrecoverable error.

error(String, Throwable, LogEvent) - Method in class org.apache.log.util.DefaultErrorHandler

Log an unrecoverable error.

ErrorAware - interface org.apache.log.ErrorAware.

Interface implemented by components that wish to delegate ErrorHandling to an ErrorHandler.

ErrorHandler - interface org.apache.log.ErrorHandler.

Handle unrecoverable errors that occur during logging.

ExtendedPatternFormatter - class org.apache.log.format.ExtendedPatternFormatter.

Formatter especially designed for debugging applications.

ExtendedPatternFormatter(String) - Constructor for class org.apache.log.format.ExtendedPatternFormatter

Creation of a new extended pattern formatter.

ExtendedPatternFormatter(String, int) - Constructor for class org.apache.log.format.ExtendedPatternFormatter

Creation of a new extended pattern formatter.

F

FACILITY_AUTH - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_AUTHPRIV - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_CRON - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_DAEMON - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_DESCRIPTIONS - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_FTP - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_KERN - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL0 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL1 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL2 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL3 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL4 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL5 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL6 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LOCAL7 - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_LPR - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_MAIL - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_NEWS - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_SYSLOG - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_USER - Static variable in class org.apache.log.format.SyslogFormatter

FACILITY_UUCP - Static variable in class org.apache.log.format.SyslogFormatter

FATAL_ERROR - Static variable in class org.apache.log.Priority

Something caused whole system to fail.

fatalError(String) - Method in class org.apache.log.Logger

Log a fatalError priority event.

fatalError(String, Throwable) - Method in class org.apache.log.Logger

Log a fatalError priority event.

FileOutputLogTarget - class org.apache.log.output.FileOutputLogTarget.

Deprecated. Use org.apache.log.output.io.FileTarget as this class is not thread safe

FileOutputLogTarget() - Constructor for class org.apache.log.output.FileOutputLogTarget

Deprecated.

FileOutputLogTarget(String) - Constructor for class org.apache.log.output.FileOutputLogTarget

Deprecated.

FileOutputLogTarget(String, boolean) - Constructor for class org.apache.log.output.FileOutputLogTarget

Deprecated.

FileStrategy - interface org.apache.log.output.io.rotate.FileStrategy.

Strategy for naming log files.

FileTarget - class org.apache.log.output.io.FileTarget.

A basic target that writes to a File.

FileTarget(File, boolean, Formatter) - Constructor for class org.apache.log.output.io.FileTarget

Construct file target to write to a file with a formatter.

filter(LogEvent) - Method in class org.apache.log.filter.PriorityFilter

Filter the log event based on priority.

filter(LogEvent) - Method in class org.apache.log.filter.AbstractFilterTarget

Filter the log event.

FilterTarget - interface org.apache.log.FilterTarget.

Deprecated. Interface offered no significant advantage and thus will no longer be used by new interfaces

flush() - Method in class org.apache.log.util.LoggerOutputStream

Flush data to underlying logger.

format(LogEvent) - Method in interface org.apache.log.Formatter

Deprecated. Serialize log event into string.

format(LogEvent) - Method in class org.apache.log.format.XMLFormatter

Format log event into string.

format(LogEvent) - Method in class org.apache.log.format.SyslogFormatter

Format log event into syslog string.

format(LogEvent) - Method in class org.apache.log.format.RawFormatter

Format log event into string.

format(LogEvent) - Method in class org.apache.log.format.PatternFormatter

Format the event according to the pattern.

format(LogEvent) - Method in interface org.apache.log.format.Formatter

Serialize log event into string.

formatPatternRun(LogEvent, PatternFormatter.PatternRun) - Method in class org.apache.log.format.PatternFormatter

Formats a single pattern run (can be extended in subclasses).

formatPatternRun(LogEvent, PatternFormatter.PatternRun) - Method in class org.apache.log.format.ExtendedPatternFormatter

Formats a single pattern run (can be extended in subclasses).

formatPatternRun(LogEvent, PatternFormatter.PatternRun) - Method in class org.apache.log.format.AvalonFormatter

Deprecated.

Formatter - interface org.apache.log.Formatter.

Deprecated. Use org.apache.log.format.Formatter instead.

Formatter - interface org.apache.log.format.Formatter.

This defines the interface for components that wish to serialize LogEvents into Strings.

G

get(int) - Method in class org.apache.log.ContextStack

Deprecated. Get the context at a particular depth.

get(String) - Method in class org.apache.log.ContextMap

Get an entry from the context.

get(String, Object) - Method in class org.apache.log.ContextMap

Get an entry from the context.

getAux() - Method in class org.apache.log.output.db.ColumnInfo

Return the auxillary column information.

getAux() - Method in class org.apache.log.output.jms.PropertyInfo

Return the property auxilliary information

getCallerClass(Class) - Static method in class org.apache.log.util.StackIntrospector

Find the caller of the passed in Class.

getCallerClass(Class, int) - Static method in class org.apache.log.util.StackIntrospector

Find the caller of the passed in Class.

getCallerMethod(Class) - Static method in class org.apache.log.util.StackIntrospector

Get the method path name for the method from which the LogEvent was created, this includes the path name and the source filename and line number if the source was compiled with debugging on.

getCategory() - Method in class org.apache.log.Logger

Deprecated. This method violates Inversion of Control principle. If you are relying on its presence then there may be something wrong with the design of your system

getCategory() - Method in class org.apache.log.LogEvent

Get the category that LogEvent relates to.

getCategory(String, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format category.

getChildLogger(String) - Method in class org.apache.log.Logger

Create a new child logger.

getChildren() - Method in class org.apache.log.Logger

Get all the child Loggers of current logger.

getColumn(int) - Method in class org.apache.log.output.db.DefaultJDBCTarget

Return the column info for an supplied index.

getConnection() - Method in class org.apache.log.output.db.DefaultDataSource

Attempt to establish a database connection.

getConnection() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Utility method for subclasses to access connection.

getConnection(String, String) - Method in class org.apache.log.output.db.DefaultDataSource

Attempt to establish a database connection.

getContext(ContextStack, String) - Method in class org.apache.log.format.PatternFormatter

Deprecated. Use getContextStack rather than this method

getContextMap() - Method in class org.apache.log.LogEvent

Get ContextMap associated with LogEvent

getContextMap(ContextMap, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format context map.

getContextStack() - Method in class org.apache.log.LogEvent

Deprecated. ContextStack has been deprecated and thus so has this method

getContextStack(ContextStack, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format context.

getCurrentContext() - Static method in class org.apache.log.LogKit

Deprecated. Use ContextStack.getCurrentContext() instead

getCurrentContext() - Static method in class org.apache.log.ContextStack

Deprecated. Get the Current ContextStack.

getCurrentContext() - Static method in class org.apache.log.ContextMap

Get the Current ContextMap.

getCurrentContext(boolean) - Static method in class org.apache.log.ContextMap

Get the Current ContextMap.

getCurrentRotation() - Method in class org.apache.log.output.io.rotate.RevolvingFileStrategy

Retrieve the current rotation number.

getDefaultHierarchy() - Static method in class org.apache.log.Hierarchy

Retrieve the default hierarchy.

getDefaultMonitor() - Static method in class org.apache.log.output.lf5.LF5LogTarget

Get the default LogBrokerMonitor instance.

getErrorHandler() - Method in class org.apache.log.output.AbstractTarget

Helper method to retrieve ErrorHandler for subclasses.

getFacilityDescription(int) - Method in class org.apache.log.format.SyslogFormatter

Retrieve description for facility.

getFile() - Method in class org.apache.log.output.io.FileTarget

Retrieve file associated with target.

getFormatter() - Method in class org.apache.log.output.AbstractOutputTarget

Deprecated. Access to formatter is not advised and this method will be removed in future iterations. It remains only for backwards compatability.

getID(String, HashMap, String) - Method in class org.apache.log.output.db.NormalizedJDBCTarget

getLoggerFor(String) - Static method in class org.apache.log.LogKit

Deprecated. Use Hierarchy.getDefaultHierarchy().getLoggerFor() instead

getLoggerFor(String) - Method in class org.apache.log.Hierarchy

Retrieve a logger for named category.

getLoginTimeout() - Method in class org.apache.log.output.db.DefaultDataSource

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.

getLogTargets() - Method in class org.apache.log.Logger

Deprecated. This method is deprecated and will be removed in Future version. Previously it allowed unsafe access to logtargets which permitted masqurade attacks. It currently returns a zero sized array.

getLogWriter() - Method in class org.apache.log.output.db.DefaultDataSource

Get the log writer for this data source.

getMessage() - Method in class org.apache.log.LogEvent

Get the message associated with event.

getMessage(String, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format message.

getName() - Method in class org.apache.log.Priority

Get name of priority.

getName() - Method in class org.apache.log.output.db.ColumnInfo

Return the column name

getName() - Method in class org.apache.log.output.jms.PropertyInfo

Return the property name

getPriority() - Method in class org.apache.log.Logger

Deprecated. This method violates Inversion of Control principle. It will downgraded to protected access in a future release. When user needs to check priority it is advised that they use the is[Priority]Enabled() functions.

getPriority() - Method in class org.apache.log.LogEvent

Get Priority for LogEvent.

getPriority(Priority, String) - Method in class org.apache.log.format.PatternFormatter

Get formatted priority string.

getPriorityForName(String) - Static method in class org.apache.log.Priority

Retrieve a Priority object for the name parameter.

getPriorityForName(String) - Static method in class org.apache.log.LogKit

Deprecated. Use Priority.getPriorityForName() instead

getRecentStack(Class, int) - Static method in class org.apache.log.util.StackIntrospector

Return the current call stack as a String, starting with the first call in the stack after a reference to the clazz class, and then display entries entries.

getRelativeTime() - Method in class org.apache.log.LogEvent

Get the time of the log event relative to start of application.

getRootLogger() - Method in class org.apache.log.Hierarchy

Utility method to retrieve logger for hierarchy.

getRTime(long, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format relative time.

getSession() - Method in class org.apache.log.output.jms.JMSTopicTarget

getSession() - Method in class org.apache.log.output.jms.JMSQueueTarget

getSession() - Method in class org.apache.log.output.jms.AbstractJMSTarget

getSize() - Method in class org.apache.log.ContextStack

Deprecated. Get the number of contexts in stack.

getSize() - Method in class org.apache.log.ContextMap

Get the number of contexts in map.

getStackTrace(Throwable, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format stack trace.

getStackTrace(Throwable, String) - Method in class org.apache.log.format.AvalonFormatter

Deprecated. Utility method to format stack trace.

getStatementSQL() - Method in class org.apache.log.output.db.DefaultJDBCTarget

Return the SQL insert statement.

getSyslogFacility(LogEvent) - Method in class org.apache.log.format.SyslogFormatter

Get facility associated with event.

getSyslogPriority(LogEvent) - Method in class org.apache.log.format.SyslogFormatter

Get syslog priority code for LogEvent.

getTable() - Method in class org.apache.log.output.db.DefaultJDBCTarget

Return the underlying table

getThread(String) - Method in class org.apache.log.format.PatternFormatter

Get formatted thread string.

getThrowable() - Method in class org.apache.log.LogEvent

Get throwabe instance associated with event.

getTime() - Method in class org.apache.log.LogEvent

Get the absolute time of the log event.

getTime(long, String) - Method in class org.apache.log.format.PatternFormatter

Utility method to format time.

getType() - Method in class org.apache.log.output.db.ColumnInfo

Return the column type as an integer

getType() - Method in class org.apache.log.output.jms.PropertyInfo

Return the property type

getTypeIdFor(String) - Method in class org.apache.log.format.PatternFormatter

Retrieve the type-id for a particular string.

getTypeIdFor(String) - Method in class org.apache.log.format.ExtendedPatternFormatter

Retrieve the type-id for a particular string.

getTypeIdFor(String) - Method in class org.apache.log.format.AvalonFormatter

Deprecated. Retrieve the type-id for a particular string.

getTypeIdFor(String) - Static method in class org.apache.log.output.db.ColumnType

getTypeIdFor(String) - Static method in class org.apache.log.output.jms.PropertyType

getValue() - Method in class org.apache.log.Priority

Get numerical value associated with priority.

H

Hierarchy - class org.apache.log.Hierarchy.

This class encapsulates a basic independent log hierarchy.

Hierarchy() - Constructor for class org.apache.log.Hierarchy

Create a hierarchy object.

HOSTNAME - Static variable in class org.apache.log.output.db.ColumnType

HOSTNAME_STR - Static variable in class org.apache.log.output.db.ColumnType

I

INFO - Static variable in class org.apache.log.Priority

Useful information messages such as state changes, client connection, user login etc.

info(String) - Method in class org.apache.log.Logger

Log a info priority event.

info(String, Throwable) - Method in class org.apache.log.Logger

Log a info priority event.

initPattern() - Method in class org.apache.log.output.DefaultOutputLogTarget

Deprecated. This is no longer the recomended way to set formatter. It is recomended that it be passed into constructor.

isDebugEnabled() - Method in class org.apache.log.Logger

Determine if messages of priority DEBUG will be logged.

isErrorEnabled() - Method in class org.apache.log.Logger

Determine if messages of priority ERROR will be logged.

isFatalErrorEnabled() - Method in class org.apache.log.Logger

Determine if messages of priority FATAL_ERROR will be logged.

isFull() - Method in class org.apache.log.output.MemoryTarget

Check if memory buffer is full.

isGreater(Priority) - Method in class org.apache.log.Priority

Test whether this priority is greater than other priority.

isInfoEnabled() - Method in class org.apache.log.Logger

Determine if messages of priority INFO will be logged.

isLower(Priority) - Method in class org.apache.log.Priority

Test whether this priority is lower than other priority.

isLowerOrEqual(Priority) - Method in class org.apache.log.Priority

Test whether this priority is lower or equal to other priority.

isOpen() - Method in class org.apache.log.output.AbstractTarget

Return the open state of the target.

isPriorityEnabled(Priority) - Method in class org.apache.log.Logger

Determine if messages of priority will be logged.

isReadOnly() - Method in class org.apache.log.ContextMap

Determine if context is read-only.

isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.RotateStrategyByTime

Check if now a log rotation is neccessary.

isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.RotateStrategyBySize

Check if now a log rotation is neccessary.

isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.RotateStrategyByDate

Test is a rotation is required.

isRotationNeeded(String, File) - Method in interface org.apache.log.output.io.rotate.RotateStrategy

Check if a log rotation is neccessary at this time.

isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.OrRotateStrategy

check if now a log rotation is neccessary.

isSevereLevel() - Method in class org.apache.log.output.lf5.LogKitLogRecord

isStale() - Method in class org.apache.log.output.db.DefaultJDBCTarget

Test if the target is stale.

isStale() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Detect if connection is stale and should be reopened.

isWarnEnabled() - Method in class org.apache.log.Logger

Determine if messages of priority WARN will be logged.

J

JMSQueueTarget - class org.apache.log.output.jms.JMSQueueTarget.

A target that writes to a JMS Queue.

JMSQueueTarget(MessageBuilder, QueueConnectionFactory, Queue) - Constructor for class org.apache.log.output.jms.JMSQueueTarget

JMSQueueTarget(MessageBuilder, QueueConnectionFactory, Queue, ErrorHandler) - Constructor for class org.apache.log.output.jms.JMSQueueTarget

JMSTopicTarget - class org.apache.log.output.jms.JMSTopicTarget.

A target that writes to a JMS Topic.

JMSTopicTarget(MessageBuilder, TopicConnectionFactory, Topic) - Constructor for class org.apache.log.output.jms.JMSTopicTarget

JMSTopicTarget(MessageBuilder, TopicConnectionFactory, Topic, ErrorHandler) - Constructor for class org.apache.log.output.jms.JMSTopicTarget

L

LF5LogTarget - class org.apache.log.output.lf5.LF5LogTarget.

A LogTarget that displays log events using the LogFactor5 Swing GUI.

LF5LogTarget() - Constructor for class org.apache.log.output.lf5.LF5LogTarget

Create LogFactorLogTarget on the default LogBrokerMonitor.

LF5LogTarget(LogBrokerMonitor) - Constructor for class org.apache.log.output.lf5.LF5LogTarget

Create a LogFactorLogTarget on a given LogBrokerMonitor.

log(Priority, String) - Method in class org.apache.log.Logger

Log a event at specific priority with a certain message.

log(Priority, String, Throwable) - Method in class org.apache.log.Logger

Log a event at specific priority with a certain message and throwable.

log(String) - Static method in class org.apache.log.LogKit

Deprecated. Use Hierarchy.getDefaultHierarchy().log() instead

log(String) - Method in class org.apache.log.Hierarchy

Deprecated. Logging components should use ErrorHandler rather than Hierarchy.log()

log(String, Throwable) - Static method in class org.apache.log.LogKit

Deprecated. Use Hierarchy.getDefaultHierarchy().log() instead

log(String, Throwable) - Method in class org.apache.log.Hierarchy

Deprecated. Logging components should use ErrorHandler rather than Hierarchy.log()

LogEvent - class org.apache.log.LogEvent.

This class encapsulates each individual log event.

LogEvent() - Constructor for class org.apache.log.LogEvent

Logger - class org.apache.log.Logger.

The object interacted with by client objects to perform logging.

loggerCreated(String, Logger) - Method in class org.apache.log.util.LoggerListener

Notify listener that Logger was created.

LoggerListener - class org.apache.log.util.LoggerListener.

The LoggerListener class is used to notify listeners when a new Logger object is created.

LoggerListener() - Constructor for class org.apache.log.util.LoggerListener

LoggerOutputStream - class org.apache.log.util.LoggerOutputStream.

Redirect an output stream to a logger.

LoggerOutputStream(Logger, Priority) - Constructor for class org.apache.log.util.LoggerOutputStream

Construct OutputStreamLogger to write to a particular logger at a particular priority.

LogKit - class org.apache.log.LogKit.

Deprecated. Instead of using LogKit directly use the facilities in code itself

LOGKIT_LOGLEVELS - Static variable in class org.apache.log.output.lf5.LogKitLogRecord

The LogLevels corresponding to LogKit priorities.

LogKitLogRecord - class org.apache.log.output.lf5.LogKitLogRecord.

An implementation of a LogFactor5 LogRecord based on a LogKit LogEvent.

LogKitLogRecord(LogEvent, Formatter) - Constructor for class org.apache.log.output.lf5.LogKitLogRecord

Create a LogFactor record from a LogKit event

LogTarget - interface org.apache.log.LogTarget.

LogTarget is a class to encapsulate outputting LogEvent's.

M

m_data - Variable in class org.apache.log.format.PatternFormatter.PatternRun

m_format - Variable in class org.apache.log.format.PatternFormatter.PatternRun

m_formatter - Variable in class org.apache.log.output.AbstractOutputTarget

Deprecated. You should not be directly accessing this attribute as it will become private next release

m_maxSize - Variable in class org.apache.log.format.PatternFormatter.PatternRun

m_minSize - Variable in class org.apache.log.format.PatternFormatter.PatternRun

m_output - Variable in class org.apache.log.output.io.WriterTarget

Deprecated. Accessing this variable in subclasses is no longer supported and will become private in the future.

m_rightJustify - Variable in class org.apache.log.format.PatternFormatter.PatternRun

m_type - Variable in class org.apache.log.format.PatternFormatter.PatternRun

makeReadOnly() - Method in class org.apache.log.ContextMap

Make the context read-only.

MAX_TYPE - Static variable in class org.apache.log.format.PatternFormatter

The maximum value used for TYPEs.

MemoryTarget - class org.apache.log.output.MemoryTarget.

Output LogEvents into an buffer in memory.

MemoryTarget(LogTarget, int, Priority) - Constructor for class org.apache.log.output.MemoryTarget

Creation of a new instance of the memory target.

MESSAGE - Static variable in class org.apache.log.output.db.ColumnType

MESSAGE - Static variable in class org.apache.log.output.jms.PropertyType

MESSAGE_STR - Static variable in class org.apache.log.output.db.ColumnType

MESSAGE_STR - Static variable in class org.apache.log.output.jms.PropertyType

MessageBuilder - interface org.apache.log.output.jms.MessageBuilder.

Interface that classes implement to build JMS Messages.

N

nextFile() - Method in class org.apache.log.output.io.rotate.UniqueFileStrategy

Calculate the real file name from the base filename.

nextFile() - Method in class org.apache.log.output.io.rotate.RevolvingFileStrategy

Calculate the real file name from the base filename.

nextFile() - Method in interface org.apache.log.output.io.rotate.FileStrategy

Get the next log file to rotate to.

NONE - Static variable in class org.apache.log.Priority

Do not log anything.

NormalizedJDBCTarget - class org.apache.log.output.db.NormalizedJDBCTarget.

JDBC target that writes to normalized tables.

NormalizedJDBCTarget(DataSource, String, ColumnInfo[]) - Constructor for class org.apache.log.output.db.NormalizedJDBCTarget

NullOutputLogTarget - class org.apache.log.output.NullOutputLogTarget.

A output target that does nothing.

NullOutputLogTarget() - Constructor for class org.apache.log.output.NullOutputLogTarget

Creation of a new null log target.

O

ObjectMessageBuilder - class org.apache.log.output.jms.ObjectMessageBuilder.

Basic message factory that stores LogEvent in Message.

ObjectMessageBuilder() - Constructor for class org.apache.log.output.jms.ObjectMessageBuilder

open() - Method in class org.apache.log.output.AbstractTarget

Startup log session.

open() - Method in class org.apache.log.output.AbstractOutputTarget

Startup log session.

open() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Startup log session.

open() - Method in class org.apache.log.output.jms.AbstractJMSTarget

Startup log session.

openConnection() - Method in class org.apache.log.output.db.DefaultJDBCTarget

Open connection to underlying database.

openConnection() - Method in class org.apache.log.output.db.AbstractJDBCTarget

Open connection to underlying database.

openConnection() - Method in class org.apache.log.output.jms.JMSTopicTarget

openConnection() - Method in class org.apache.log.output.jms.JMSQueueTarget

openConnection() - Method in class org.apache.log.output.jms.AbstractJMSTarget

openFile() - Method in class org.apache.log.output.io.FileTarget

Open underlying file and allocate resources.

org.apache.log - package org.apache.log

Avalon LogKit is the logging framework used throughout the Avalon project.

org.apache.log.filter - package org.apache.log.filter

This package contains filters to limit or modify LogEvents as they are passed down LogEvent chain.

org.apache.log.format - package org.apache.log.format

This package contains formmaters that serialize LogEvents to strings.

org.apache.log.output - package org.apache.log.output

This package contains some useful output destination LogTargets.

org.apache.log.output.db - package org.apache.log.output.db

Database output destination LogTargets.

org.apache.log.output.io - package org.apache.log.output.io

Stream anf file based output destination LogTargets.

org.apache.log.output.io.rotate - package org.apache.log.output.io.rotate

Log file rotation policies.

org.apache.log.output.jms - package org.apache.log.output.jms

JMS based output destination LogTargets.

org.apache.log.output.lf5 - package org.apache.log.output.lf5

LogFactor5 (Swing GUI) based LogTarget.

org.apache.log.output.net - package org.apache.log.output.net

Datagram, Socket and SMTP output destination LogTargets.

org.apache.log.util - package org.apache.log.util

Utilities suppporting the logging framework.

OrRotateStrategy - class org.apache.log.output.io.rotate.OrRotateStrategy.

Hierarchical rotation strategy.

OrRotateStrategy(RotateStrategy[]) - Constructor for class org.apache.log.output.io.rotate.OrRotateStrategy

Constructor

output(LogEvent) - Method in class org.apache.log.output.db.DefaultJDBCTarget

Output a log event to DB.

output(LogEvent) - Method in class org.apache.log.output.db.AbstractJDBCTarget

Output a log event to DB.

output(String) - Method in class org.apache.log.output.AbstractOutputTarget

Deprecated. User should overide write() instead of output(). Output exists for backwards compatability and will be removed in future.

OutputStreamLogger - class org.apache.log.util.OutputStreamLogger.

Deprecated. Use LoggerOutputStream as this class was misnamed.

OutputStreamLogger(Logger, Priority) - Constructor for class org.apache.log.util.OutputStreamLogger

Deprecated. Use LoggerOutputStream as this class was misnamed.

P

parse(String) - Method in class org.apache.log.format.PatternFormatter

Parse the input pattern and build internal data structures.

PatternFormatter - class org.apache.log.format.PatternFormatter.

This formater formats the LogEvents according to a input pattern string.

PatternFormatter.PatternRun - class org.apache.log.format.PatternFormatter.PatternRun.

PatternFormatter.PatternRun() - Constructor for class org.apache.log.format.PatternFormatter.PatternRun

PatternFormatter() - Constructor for class org.apache.log.format.PatternFormatter

Deprecated. Use constructor PatternFormatter(String pattern) as this does not correctly initialize object

PatternFormatter(String) - Constructor for class org.apache.log.format.PatternFormatter

Creation of a new patter formatter baseed on a supplied pattern.

pop() - Method in class org.apache.log.ContextStack

Deprecated. Remove a context from top of stack and return it.

Priority - class org.apache.log.Priority.

Class representing and holding constants for priority.

PRIORITY - Static variable in class org.apache.log.output.db.ColumnType

PRIORITY - Static variable in class org.apache.log.output.jms.PropertyType

PRIORITY_ALERT - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_CRIT - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_DEBUG - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_EMERG - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_ERR - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_INFO - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_NOTICE - Static variable in class org.apache.log.format.SyslogFormatter

PRIORITY_STR - Static variable in class org.apache.log.output.db.ColumnType

PRIORITY_STR - Static variable in class org.apache.log.output.jms.PropertyType

PRIORITY_WARNING - Static variable in class org.apache.log.format.SyslogFormatter

PriorityFilter - class org.apache.log.filter.PriorityFilter.

Filters log events based on priority.

PriorityFilter(Priority) - Constructor for class org.apache.log.filter.PriorityFilter

Constructor that sets the priority that is filtered against.

processEvent(LogEvent) - Method in interface org.apache.log.LogTarget

Process a log event.

processEvent(LogEvent) - Method in class org.apache.log.filter.AbstractFilterTarget

Process a log event

processEvent(LogEvent) - Method in class org.apache.log.output.AbstractTarget

Process a log event, via formatting and outputting it.

processEvent(LogEvent) - Method in class org.apache.log.output.io.SafeFileTarget

Process a log event, via formatting and outputting it.

processEvent(LogEvent) - Method in class org.apache.log.output.lf5.LF5LogTarget

Process a log event.

PropertyInfo - class org.apache.log.output.jms.PropertyInfo.

A descriptor for each message property.

PropertyInfo(String, int, String) - Constructor for class org.apache.log.output.jms.PropertyInfo

Creation of a new property info instance.

PropertyType - class org.apache.log.output.jms.PropertyType.

A class to hold all constants for PropertyTypes.

PropertyType() - Constructor for class org.apache.log.output.jms.PropertyType

push() - Method in class org.apache.log.output.MemoryTarget

Push log events to target.

push(Object) - Method in class org.apache.log.ContextStack

Deprecated. Push the context onto top of context stack.

R

RawFormatter - class org.apache.log.format.RawFormatter.

Basic formatter that just returns raw message string and ignores remainder of LogEvent.

RawFormatter() - Constructor for class org.apache.log.format.RawFormatter

RELATIVE_TIME - Static variable in class org.apache.log.output.db.ColumnType

RELATIVE_TIME - Static variable in class org.apache.log.output.jms.PropertyType

RELATIVE_TIME_STR - Static variable in class org.apache.log.output.db.ColumnType

RELATIVE_TIME_STR - Static variable in class org.apache.log.output.jms.PropertyType

removeLoggerListener(LoggerListener) - Method in class org.apache.log.Hierarchy

Remove the LoggerListener associated with hierarchy.

reset() - Method in class org.apache.log.output.io.rotate.RotateStrategyByTime

reset interval history counters.

reset() - Method in class org.apache.log.output.io.rotate.RotateStrategyBySize

Reset log size written so far.

reset() - Method in class org.apache.log.output.io.rotate.RotateStrategyByDate

Reset the strategy.

reset() - Method in interface org.apache.log.output.io.rotate.RotateStrategy

Reset cumulative rotation history data.

reset() - Method in class org.apache.log.output.io.rotate.OrRotateStrategy

reset.

RevolvingFileStrategy - class org.apache.log.output.io.rotate.RevolvingFileStrategy.

strategy for naming log files based on appending revolving suffix.

RevolvingFileStrategy(File, int) - Constructor for class org.apache.log.output.io.rotate.RevolvingFileStrategy

Creation of a new instane ofthe revolving file strategy.

RevolvingFileStrategy(File, int, int) - Constructor for class org.apache.log.output.io.rotate.RevolvingFileStrategy

Creation of a new instane ofthe revolving file strategy.

rotate() - Method in class org.apache.log.output.io.rotate.RotatingFileTarget

Rotates the file.

RotateStrategy - interface org.apache.log.output.io.rotate.RotateStrategy.

Strategy that checks condition under which file rotation is needed.

RotateStrategyByDate - class org.apache.log.output.io.rotate.RotateStrategyByDate.

Rotation stragety based on SimpleDateFormat.

RotateStrategyByDate() - Constructor for class org.apache.log.output.io.rotate.RotateStrategyByDate

Creation of a new rotation strategy based on a date policy.

RotateStrategyByDate(String) - Constructor for class org.apache.log.output.io.rotate.RotateStrategyByDate

Creation of a new rotation strategy based on a date policy using a supplied pattern.

RotateStrategyBySize - class org.apache.log.output.io.rotate.RotateStrategyBySize.

Rotation strategy based on size written to log file.

RotateStrategyBySize() - Constructor for class org.apache.log.output.io.rotate.RotateStrategyBySize

Rotate logs by size.

RotateStrategyBySize(long) - Constructor for class org.apache.log.output.io.rotate.RotateStrategyBySize

Rotate logs by size.

RotateStrategyByTime - class org.apache.log.output.io.rotate.RotateStrategyByTime.

rotation stragety based when log writting started.

RotateStrategyByTime() - Constructor for class org.apache.log.output.io.rotate.RotateStrategyByTime

Rotate logs by time.

RotateStrategyByTime(long) - Constructor for class org.apache.log.output.io.rotate.RotateStrategyByTime

Rotate logs by time.

RotatingFileTarget - class org.apache.log.output.io.rotate.RotatingFileTarget.

This is a basic Output log target that writes to rotating files.

RotatingFileTarget(boolean, Formatter, RotateStrategy, FileStrategy) - Constructor for class org.apache.log.output.io.rotate.RotatingFileTarget

Construct RotatingFileTarget object.

RotatingFileTarget(Formatter, RotateStrategy, FileStrategy) - Constructor for class org.apache.log.output.io.rotate.RotatingFileTarget

Construct RotatingFileTarget object.

run() - Method in class org.apache.log.output.AsyncLogTarget

Thread startup.

S

SafeFileTarget - class org.apache.log.output.io.SafeFileTarget.

A target that will open and close a file for each logevent.

SafeFileTarget(File, boolean, Formatter) - Constructor for class org.apache.log.output.io.SafeFileTarget

Construct file target to write to a file with a formatter.

send(Message) - Method in class org.apache.log.output.jms.JMSTopicTarget

send(Message) - Method in class org.apache.log.output.jms.JMSQueueTarget

send(Message) - Method in class org.apache.log.output.jms.AbstractJMSTarget

ServletOutputLogTarget - class org.apache.log.output.ServletOutputLogTarget.

Generic logging interface.

ServletOutputLogTarget(ServletContext) - Constructor for class org.apache.log.output.ServletOutputLogTarget

Constructor.

set(ContextStack) - Method in class org.apache.log.ContextStack

Deprecated. Set the current ContextSet to be equl to other ContextStack.

set(String, Object) - Method in class org.apache.log.ContextMap

Set a value in context

setAdditivity(boolean) - Method in class org.apache.log.Logger

Make this logger additive.

setAppend(boolean) - Method in class org.apache.log.output.FileOutputLogTarget

Deprecated.

setCategory(String) - Method in class org.apache.log.LogEvent

Set the LogEvent category.

setContextMap(ContextMap) - Method in class org.apache.log.LogEvent

Set the ContextMap for this LogEvent.

setContextStack(ContextStack) - Method in class org.apache.log.LogEvent

Deprecated. ContextStack has been deprecated and thus so has this method

setDebug(boolean) - Method in class org.apache.log.output.net.SMTPOutputLogTarget

Method to enable/disable debugging on the mail session.

setDefaultLogTarget(LogTarget) - Static method in class org.apache.log.LogKit

Deprecated. Use Hierarchy.getDefaultHierarchy().setDefaultLogTarget() instead

setDefaultLogTarget(LogTarget) - Method in class org.apache.log.Hierarchy

Set the default log target for hierarchy.

setDefaultLogTargets(LogTarget[]) - Method in class org.apache.log.Hierarchy

Set the default log targets for this hierarchy.

setDefaultPriority(Priority) - Method in class org.apache.log.Hierarchy

Set the default priority for hierarchy.

setErrorHandler(ErrorHandler) - Method in class org.apache.log.Hierarchy

Set the ErrorHandler associated with hierarchy.

setErrorHandler(ErrorHandler) - Method in interface org.apache.log.ErrorAware

Provide component with ErrorHandler.

setErrorHandler(ErrorHandler) - Method in class org.apache.log.output.AsyncLogTarget

Provide component with ErrorHandler.

setErrorHandler(ErrorHandler) - Method in class org.apache.log.output.AbstractTarget

Provide component with ErrorHandler.

setFile(File, boolean) - Method in class org.apache.log.output.io.FileTarget

Set the file for this target.

setFilename(String) - Method in class org.apache.log.output.FileOutputLogTarget

Deprecated. Overwrites the m_output value in the super class through assignment of an OutputStreamWriter based on a supplied file path.

setFormat(String) - Method in class org.apache.log.format.PatternFormatter

Deprecated. Parse format in via constructor rather than use this method

setFormat(String) - Method in class org.apache.log.output.DefaultOutputLogTarget

Deprecated. This method is unsafe as it assumes formatter is PatternFormatter and accesses a protected attribute. Instead of calling this method It is recomended that a fully configured formatter is passed into constructor.

setFormatter(Formatter) - Method in class org.apache.log.output.AbstractOutputTarget

Deprecated. In future this method will become protected access.

setLoginTimeout(int) - Method in class org.apache.log.output.db.DefaultDataSource

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

setLogTargets(LogTarget[]) - Method in class org.apache.log.Logger

Set the log targets for this logger.

setLogWriter(PrintWriter) - Method in class org.apache.log.output.db.DefaultDataSource

setMessage(String) - Method in class org.apache.log.LogEvent

Set the message for LogEvent.

setNDCFormatter(Formatter) - Method in class org.apache.log.output.lf5.LF5LogTarget

Sets the Formatter that will be used to produce the "NDC" (nested diagnostic context) text on the GUI.

setOutputStream(OutputStream) - Method in class org.apache.log.output.io.StreamTarget

Set the output stream.

setOverwrite(boolean) - Method in class org.apache.log.output.MemoryTarget

Set flag indicating whether it is valid to overwrite memory buffer.

setPrintCategory(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out category field to log.

setPrintContext(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out context field to log.

setPrintException(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out exception field to log.

setPrintMessage(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out message field to log.

setPrintPriority(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out priority field to log.

setPrintRelativeTime(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out relativeTime field to log.

setPrintTime(boolean) - Method in class org.apache.log.format.XMLFormatter

Print out time field to log.

setPriority(Priority) - Method in class org.apache.log.Logger

Set the priority for this logger.

setPriority(Priority) - Method in class org.apache.log.LogEvent

Set the priority of LogEvent.

setPriority(Priority) - Method in class org.apache.log.filter.PriorityFilter

Set priority used to filter.

setThrowable(Throwable) - Method in class org.apache.log.LogEvent

Set the throwable for LogEvent.

setTime(long) - Method in class org.apache.log.LogEvent

Set the absolute time of LogEvent.

setWriter(Writer) - Method in class org.apache.log.output.io.WriterTarget

Set the writer.

shouldPush(LogEvent) - Method in class org.apache.log.output.MemoryTarget

Determine if LogEvent should initiate a push to target.

shutdownStream() - Method in class org.apache.log.output.io.StreamTarget

Shutdown output stream.

shutdownWriter() - Method in class org.apache.log.output.io.WriterTarget

Shutdown Writer.

SMTPOutputLogTarget - class org.apache.log.output.net.SMTPOutputLogTarget.

Logkit output target that logs data via SMTP (ie.

SMTPOutputLogTarget(Session, Address[], Address, String, int, Formatter) - Constructor for class org.apache.log.output.net.SMTPOutputLogTarget

SMTPOutputLogTarget constructor, creates a logkit output target capable of logging to SMTP (ie.

SocketOutputTarget - class org.apache.log.output.net.SocketOutputTarget.

SocketOutputTarget Useful for writing the output to a TCP/IP client socket.

SocketOutputTarget(InetAddress, int) - Constructor for class org.apache.log.output.net.SocketOutputTarget

Creates output target with the end point specified by the address and port

SocketOutputTarget(String, int) - Constructor for class org.apache.log.output.net.SocketOutputTarget

Creates the output target with the end point specified by host and port

specifyColumn(PreparedStatement, int, LogEvent) - Method in class org.apache.log.output.db.NormalizedJDBCTarget

Adds a single object into statement.

specifyColumn(PreparedStatement, int, LogEvent) - Method in class org.apache.log.output.db.DefaultJDBCTarget

Adds a single object into statement.

StackIntrospector - class org.apache.log.util.StackIntrospector.

A set of utilities to inspect current stack frame.

STATIC - Static variable in class org.apache.log.output.db.ColumnType

STATIC - Static variable in class org.apache.log.output.jms.PropertyType

STATIC_STR - Static variable in class org.apache.log.output.db.ColumnType

The maximum value used for TYPEs.

STATIC_STR - Static variable in class org.apache.log.output.jms.PropertyType

The maximum value used for TYPEs.

StreamTarget - class org.apache.log.output.io.StreamTarget.

A basic target that writes to an OutputStream.

StreamTarget(OutputStream, Formatter) - Constructor for class org.apache.log.output.io.StreamTarget

Constructor that writes to a stream and uses a particular formatter.

SyslogFormatter - class org.apache.log.format.SyslogFormatter.

A formatter that serializes in the format originally used by BSD syslog daemon.

SyslogFormatter() - Constructor for class org.apache.log.format.SyslogFormatter

Constructor that assumes FACILITY_USER.

SyslogFormatter(int) - Constructor for class org.apache.log.format.SyslogFormatter

Constructor so that you can associate facility with formatter.

SyslogFormatter(int, boolean) - Constructor for class org.apache.log.format.SyslogFormatter

Constructor allowing setting of facility and whether to show banner.

T

TextMessageBuilder - class org.apache.log.output.jms.TextMessageBuilder.

Basic message factory that stores LogEvent in Message.

TextMessageBuilder(Formatter) - Constructor for class org.apache.log.output.jms.TextMessageBuilder

Creation of a new text message builder.

TextMessageBuilder(PropertyInfo[], Formatter) - Constructor for class org.apache.log.output.jms.TextMessageBuilder

Creation of a new text message builder.

THROWABLE - Static variable in class org.apache.log.output.db.ColumnType

THROWABLE - Static variable in class org.apache.log.output.jms.PropertyType

THROWABLE_STR - Static variable in class org.apache.log.output.db.ColumnType

THROWABLE_STR - Static variable in class org.apache.log.output.jms.PropertyType

TIME - Static variable in class org.apache.log.output.db.ColumnType

TIME - Static variable in class org.apache.log.output.jms.PropertyType

TIME_STR - Static variable in class org.apache.log.output.db.ColumnType

TIME_STR - Static variable in class org.apache.log.output.jms.PropertyType

toLogLevel(Priority) - Method in class org.apache.log.output.lf5.LogKitLogRecord

Convert a LogKit Priority to a LogFactor LogLevel.

toString() - Method in class org.apache.log.Priority

Overidden string to display Priority in human readable form.

toString() - Method in class org.apache.log.ContextStack

Deprecated. Format context stack into a string.

toString(int) - Method in class org.apache.log.ContextStack

Deprecated. Format context stack into a string.

U

UniqueFileStrategy - class org.apache.log.output.io.rotate.UniqueFileStrategy.

Strategy for naming log files based on appending time suffix.

UniqueFileStrategy(File) - Constructor for class org.apache.log.output.io.rotate.UniqueFileStrategy

Creation of a new Unique File Strategy ??

UniqueFileStrategy(File, String) - Constructor for class org.apache.log.output.io.rotate.UniqueFileStrategy

Creation of a new Unique File Strategy ??

UniqueFileStrategy(File, String, String) - Constructor for class org.apache.log.output.io.rotate.UniqueFileStrategy

Creation of a new Unique File Strategy ??

unsetLogTargets() - Method in class org.apache.log.Logger

Unset the logtargets for this logger.

unsetLogTargets(boolean) - Method in class org.apache.log.Logger

Unset the logtargets for this logger and all child loggers if recursive is set.

unsetPriority() - Method in class org.apache.log.Logger

Unset the priority of Logger.

unsetPriority(boolean) - Method in class org.apache.log.Logger

Unset the priority of Logger.

W

WARN - Static variable in class org.apache.log.Priority

A problem or conflict has occurred but it may be recoverable, then again it could be the start of the system failing.

warn(String) - Method in class org.apache.log.Logger

Log a warn priority event.

warn(String, Throwable) - Method in class org.apache.log.Logger

Log a warn priority event.

write(int) - Method in class org.apache.log.util.LoggerOutputStream

Write a single byte of data to output stream.

write(LogEvent) - Method in class org.apache.log.output.net.SocketOutputTarget

Writes the output as a LogEvent without formatting.

write(String) - Method in class org.apache.log.output.ServletOutputLogTarget

Logs message to servlet context log file

write(String) - Method in class org.apache.log.output.NullOutputLogTarget

Do nothing output method.

write(String) - Method in class org.apache.log.output.AbstractOutputTarget

Abstract method to write data.

write(String) - Method in class org.apache.log.output.io.WriterTarget

Concrete implementation of output that writes out to underlying writer.

write(String) - Method in class org.apache.log.output.io.StreamTarget

Abstract method that will output event.

write(String) - Method in class org.apache.log.output.io.rotate.RotatingFileTarget

Output the log message, and check if rotation is needed.

write(String) - Method in class org.apache.log.output.net.SMTPOutputLogTarget

Method to write data to the log target.

write(String) - Method in class org.apache.log.output.net.DatagramOutputTarget

Method to write output to datagram.

WriterTarget - class org.apache.log.output.io.WriterTarget.

This target outputs to a writer.

WriterTarget(Writer, Formatter) - Constructor for class org.apache.log.output.io.WriterTarget

Construct target with a specific writer and formatter.

X

XMLFormatter - class org.apache.log.format.XMLFormatter.

Basic XML formatter that writes out a basic XML-ified log event.

XMLFormatter() - Constructor for class org.apache.log.format.XMLFormatter

A B C D E F G H I J L M N O P R S T U W X