A B C D E F G H I 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
 
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
 
AbstractTarget - class org.apache.log.output.AbstractTarget.
Abstract target.
AbstractTarget() - Constructor for class org.apache.log.output.AbstractTarget
 
addTarget(LogTarget) - Method in interface org.apache.log.FilterTarget
 
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
 
AsyncLogTarget(LogTarget, int) - Constructor for class org.apache.log.output.AsyncLogTarget
 

B

bind(ContextMap) - Static method in class org.apache.log.ContextMap
Bind a particular ContextMap to current thread.

C

CATEGORY_SEPARATOR - Static variable in class org.apache.log.Logger
 
clear() - Method in class org.apache.log.ContextMap
Empty the context map.
clear() - Method in class org.apache.log.ContextStack
 
close() - Method in class org.apache.log.util.LoggerOutputStream
Shutdown stream.
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.io.StreamTarget
Shutdown target.
close() - Method in class org.apache.log.output.io.WriterTarget
Shutdown target.
close() - Method in class org.apache.log.output.net.SocketOutputTarget
Shutdown target.
close() - Method in class org.apache.log.output.net.DatagramOutputTarget
Shutdown target.
ContextMap - class org.apache.log.ContextMap.
The ContextMap contains non-hierarchical context information relevent 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.
 
ContextStack() - Constructor for class org.apache.log.ContextStack
 

D

DatagramOutputTarget - class org.apache.log.output.net.DatagramOutputTarget.
A datagram output target.
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.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.
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
 
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.MemoryTarget
Process a log event, via formatting and outputting it.
doProcessEvent(LogEvent) - Method in class org.apache.log.output.AbstractOutputTarget
 
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.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
 

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.
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.AbstractFilterTarget
Filter the log event.
filter(LogEvent) - Method in class org.apache.log.filter.PriorityFilter
Filter the log event based on priority.
FilterTarget - interface org.apache.log.FilterTarget.
 
flush() - Method in class org.apache.log.util.LoggerOutputStream
Flush data to underlying logger.
format(LogEvent) - Method in interface org.apache.log.Formatter
 
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.
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.
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).
Formatter - interface org.apache.log.Formatter.
 
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
 
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.
getCallerClass(Class) - 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.LogEvent
Get the category that LogEvent relates to.
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(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.
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.ContextMap
Get the Current ContextMap.
getCurrentContext() - Static method in class org.apache.log.ContextStack
 
getCurrentContext(boolean) - Static method in class org.apache.log.ContextMap
Get the Current ContextMap.
getDefaultHierarchy() - Static method in class org.apache.log.Hierarchy
Retrieve the default hierarchy.
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.
getLoggerFor(String) - Method in class org.apache.log.Hierarchy
Retrieve a logger for named category.
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.
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.
getPriority() - Method in class org.apache.log.LogEvent
Get Priority for LogEvent.
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(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.
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.
getSize() - Method in class org.apache.log.ContextMap
Get the number of contexts in map.
getSize() - Method in class org.apache.log.ContextStack
 
getStackTrace(Throwable, String) - Method in class org.apache.log.format.PatternFormatter
Utility method to format stack trace.
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.
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.
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.
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.

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.
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
 
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 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.RotateStrategyBySize
Check if now a log rotation is neccessary.
isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.OrRotateStrategy
check if now a log rotation is neccessary.
isRotationNeeded(String, File) - Method in class org.apache.log.output.io.rotate.RotateStrategyByTime
Check if now a log rotation is neccessary.
isWarnEnabled() - Method in class org.apache.log.Logger
Determine if messages of priority WARN will be logged.

L

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) - Method in class org.apache.log.Hierarchy
Deprecated. Logging components should use ErrorHandler rather than Hierarchy.log()
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.
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.
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
 

N

nextFile() - Method in class org.apache.log.output.io.rotate.UniqueFileStrategy
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.
nextFile() - Method in class org.apache.log.output.io.rotate.RevolvingFileStrategy
Calculate the real file name from the base filename.
NullOutputLogTarget - class org.apache.log.output.NullOutputLogTarget.
A output target that does nothing.
NullOutputLogTarget() - Constructor for class org.apache.log.output.NullOutputLogTarget
 

O

open() - Method in class org.apache.log.output.AbstractTarget
Startup log session.
open() - Method in class org.apache.log.output.AbstractOutputTarget
Startup log session.
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.io - package org.apache.log.output.io
 
org.apache.log.output.io.rotate - package org.apache.log.output.io.rotate
 
org.apache.log.output.net - package org.apache.log.output.net
 
org.apache.log.util - package org.apache.log.util
 
OrRotateStrategy - class org.apache.log.output.io.rotate.OrRotateStrategy.
Hierarchical Rotation stragety.
OrRotateStrategy(RotateStrategy[]) - Constructor for class org.apache.log.output.io.rotate.OrRotateStrategy
Constructor
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
 
pop() - Method in class org.apache.log.ContextStack
 
Priority - class org.apache.log.Priority.
Class representing and holding constants for priority.
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_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.
push() - Method in class org.apache.log.output.MemoryTarget
Push log events to target.
push(Object) - Method in class org.apache.log.ContextStack
 

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
 
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.RotateStrategyBySize
reset log size written so far.
reset() - Method in class org.apache.log.output.io.rotate.OrRotateStrategy
reset.
reset() - Method in class org.apache.log.output.io.rotate.RotateStrategyByTime
reset interval history counters.
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
 
RevolvingFileStrategy(File, int, int) - Constructor for class org.apache.log.output.io.rotate.RevolvingFileStrategy
 
rotate() - Method in class org.apache.log.output.io.rotate.RotatingFileTarget
 
RotateStrategy - interface org.apache.log.output.io.rotate.RotateStrategy.
Strategy that checks condition under which file rotation is needed.
RotateStrategyBySize - class org.apache.log.output.io.rotate.RotateStrategyBySize.
Rotation stragety 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(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
 

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.
set(ContextStack) - Method in class org.apache.log.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. ie Send all log events to parent loggers LogTargets regardless of whether or not the LogTargets have been overidden.
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
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 interface org.apache.log.ErrorAware
Provide component with ErrorHandler.
setErrorHandler(ErrorHandler) - Method in class org.apache.log.Hierarchy
Set the ErrorHandler associated with hierarchy.
setErrorHandler(ErrorHandler) - Method in class org.apache.log.output.AbstractTarget
Provide component with ErrorHandler.
setErrorHandler(ErrorHandler) - Method in class org.apache.log.output.AsyncLogTarget
Provide component with ErrorHandler.
setFile(File, boolean) - Method in class org.apache.log.output.io.FileTarget
Set the file for this target.
setFormat(String) - Method in class org.apache.log.format.PatternFormatter
Deprecated. Parse format in via constructor rather than use this method
setFormatter(Formatter) - Method in class org.apache.log.output.AbstractOutputTarget
Deprecated. In future this method will become protected access.
setLogTargets(LogTarget[]) - Method in class org.apache.log.Logger
Set the log targets for this logger.
setMessage(String) - Method in class org.apache.log.LogEvent
Set the message for LogEvent.
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.LogEvent
Set the priority of LogEvent.
setPriority(Priority) - Method in class org.apache.log.Logger
Set the priority for this logger.
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.
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
StackIntrospector - class org.apache.log.util.StackIntrospector.
A set of utilities to inspect current stack frame.
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

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
 
toString(int) - Method in class org.apache.log.ContextStack
 

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
 
UniqueFileStrategy(File, String) - Constructor for class org.apache.log.output.io.rotate.UniqueFileStrategy
 
UniqueFileStrategy(File, String, String) - Constructor for class org.apache.log.output.io.rotate.UniqueFileStrategy
 
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.AbstractOutputTarget
Abstract method to write data.
write(String) - Method in class org.apache.log.output.NullOutputLogTarget
Do nothing output method.
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.WriterTarget
Concrete implementation of output that writes out to underlying writer.
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.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 L M N O P R S T U W X

"Copyright © 2001 Apache Jakarta Project. All Rights Reserved."