Package org.apache.logging.log4j.core.appender

Class RandomAccessFileManager

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

org.apache.logging.log4j.core.appender.OutputStreamManager

org.apache.logging.log4j.core.appender.RandomAccessFileManager

All Implemented Interfaces:

java.lang.AutoCloseable, ByteBufferDestination

public class RandomAccessFileManager
extends OutputStreamManager

Extends OutputStreamManager but instead of using a buffered output stream, this class uses a ByteBuffer and a RandomAccessFile to do the I/O.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RandomAccessFileManager.FactoryData	Factory Data.
private static class	RandomAccessFileManager.RandomAccessFileManagerFactory	Factory to create a RandomAccessFileManager.

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractManager

AbstractManager.AbstractFactoryData

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	advertiseURI
(package private) static int	DEFAULT_BUFFER_SIZE
private static RandomAccessFileManager.RandomAccessFileManagerFactory	FACTORY
private java.io.RandomAccessFile	randomAccessFile

Fields inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

byteBuffer, layout

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager

count, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RandomAccessFileManager(LoggerContext loggerContext, java.io.RandomAccessFile file, java.lang.String fileName, java.io.OutputStream os, int bufferSize, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, boolean writeHeader)

Method Summary

Modifier and Type	Method	Description
boolean	closeOutputStream()
void	flush()	Flushes any buffers.
int	getBufferSize()	Returns the buffer capacity.
java.util.Map<java.lang.String,java.lang.String>	getContentFormat()	Gets this FileManager's content format specified by:
static RandomAccessFileManager	getFileManager(java.lang.String fileName, boolean append, boolean immediateFlush, int bufferSize, java.lang.String advertiseURI, Layout<? extends java.io.Serializable> layout, Configuration configuration)	Returns the RandomAccessFileManager.
java.lang.String	getFileName()	Returns the name of the File being managed.
java.lang.Boolean	isEndOfBatch()	Deprecated. end-of-batch on the event is used instead.
void	setEndOfBatch(boolean endOfBatch)	Deprecated. end-of-batch on the event is used instead.
protected void	writeToDestination(byte[] bytes, int offset, int length)	Writes the specified section of the specified byte array to the stream.

Methods inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

createOutputStream, drain, flushBuffer, flushDestination, getByteBuffer, getManager, getOutputStream, hasOutputStream, isOpen, releaseSub, setOutputStream, skipFooter, write, write, write, write, writeBytes, writeBytes, writeFooter, writeHeader

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager

close, getCount, getLoggerContext, getManager, getManagerCount, getName, getStrSubstitutor, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

FACTORY

private static final RandomAccessFileManager.RandomAccessFileManagerFactory FACTORY

advertiseURI

private final java.lang.String advertiseURI

randomAccessFile

private final java.io.RandomAccessFile randomAccessFile

Constructor Detail

RandomAccessFileManager

protected RandomAccessFileManager(LoggerContext loggerContext,
                                  java.io.RandomAccessFile file,
                                  java.lang.String fileName,
                                  java.io.OutputStream os,
                                  int bufferSize,
                                  java.lang.String advertiseURI,
                                  Layout<? extends java.io.Serializable> layout,
                                  boolean writeHeader)

Method Detail

getFileManager

public static RandomAccessFileManager getFileManager(java.lang.String fileName,
                                                     boolean append,
                                                     boolean immediateFlush,
                                                     int bufferSize,
                                                     java.lang.String advertiseURI,
                                                     Layout<? extends java.io.Serializable> layout,
                                                     Configuration configuration)

Returns the RandomAccessFileManager.

Parameters:

fileName - The name of the file to manage.

append - true if the file should be appended to, false if it should be overwritten.

immediateFlush - true if the contents should be flushed to disk on every write

bufferSize - The buffer size.

advertiseURI - the URI to use when advertising the file

layout - The layout.

configuration - The configuration.

Returns:

A RandomAccessFileManager for the File.

isEndOfBatch

@Deprecated
public java.lang.Boolean isEndOfBatch()

Deprecated.

end-of-batch on the event is used instead.

No longer used, the LogEvent.isEndOfBatch() attribute is used instead.

Returns:

Boolean.FALSE.

setEndOfBatch

@Deprecated
public void setEndOfBatch(boolean endOfBatch)

Deprecated.

end-of-batch on the event is used instead.

No longer used, the LogEvent.isEndOfBatch() attribute is used instead. This method is a no-op.

writeToDestination

protected void writeToDestination(byte[] bytes,
                                  int offset,
                                  int length)

Description copied from class: OutputStreamManager

Writes the specified section of the specified byte array to the stream.

Overrides:

writeToDestination in class OutputStreamManager

Parameters:

bytes - the array containing data

offset - from where to write

length - how many bytes to write

flush

public void flush()

Description copied from class: OutputStreamManager

Flushes any buffers.

Overrides:

flush in class OutputStreamManager

closeOutputStream

public boolean closeOutputStream()

Overrides:

closeOutputStream in class OutputStreamManager

getFileName

public java.lang.String getFileName()

Returns the name of the File being managed.

Returns:

The name of the File being managed.

getBufferSize

public int getBufferSize()

Returns the buffer capacity.

Returns:

the buffer size

getContentFormat

public java.util.Map<java.lang.String,java.lang.String> getContentFormat()

Gets this FileManager's content format specified by:

Key: "fileURI" Value: provided "advertiseURI" param.

Overrides:

getContentFormat in class AbstractManager

Returns:

Map of content format keys supporting FileManager