From f8e01cac63c2468e082a77889c3a7b354eb14c8e Mon Sep 17 00:00:00 2001
From: Jean-Noël Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 06 Oct 2015 08:08:53 +0000
Subject: [PATCH] Text*LogPublisher.java: Code cleanup Extracted methods newParallelWriter(), newAsyncWriter(), configure(). In applyConfigurationChange(), rewrote the conditions to make them more readable.
---
opendj-server-legacy/src/main/java/org/opends/server/loggers/TextDebugLogPublisher.java | 145 ++---
opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAccessLogPublisher.java | 632 ++++++----------------------
opendj-server-legacy/src/main/java/org/opends/server/loggers/TextHTTPAccessLogPublisher.java | 191 ++++----
opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAuditLogPublisher.java | 175 +++----
opendj-server-legacy/src/main/java/org/opends/server/loggers/TextErrorLogPublisher.java | 139 ++---
5 files changed, 419 insertions(+), 863 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAccessLogPublisher.java b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAccessLogPublisher.java
index f284bdf..d95a719 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAccessLogPublisher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAccessLogPublisher.java
@@ -32,7 +32,6 @@
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
-import java.util.Iterator;
import java.util.List;
import java.util.Set;
@@ -42,6 +41,7 @@
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.ResultCode;
+import org.forgerock.util.Utils;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.std.meta.FileBasedAccessLogPublisherCfgDefn.LogFormat;
import org.opends.server.admin.std.server.FileBasedAccessLogPublisherCfg;
@@ -51,27 +51,16 @@
import org.opends.server.types.*;
import org.opends.server.util.TimeThread;
-/**
- * This class provides the implementation of the access logger used by the
- * directory server.
- */
+/** This class provides the implementation of the access logger used by the directory server. */
public final class TextAccessLogPublisher extends
AbstractTextAccessLogPublisher<FileBasedAccessLogPublisherCfg> implements
ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
{
-
- /**
- * The category to use when logging responses.
- */
+ /** The category to use when logging responses. */
private static final String CATEGORY_RESPONSE = "RES";
-
- /**
- * The category to use when logging requests.
- */
+ /** The category to use when logging requests. */
private static final String CATEGORY_REQUEST = "REQ";
-
-
/**
* Returns an instance of the text access log publisher that will print all
* messages to the provided writer. This is used to print the messages to the
@@ -87,43 +76,28 @@
public static TextAccessLogPublisher getStartupTextAccessPublisher(
final TextWriter writer, final boolean suppressInternal)
{
- final TextAccessLogPublisher startupPublisher =
- new TextAccessLogPublisher();
+ final TextAccessLogPublisher startupPublisher = new TextAccessLogPublisher();
startupPublisher.writer = writer;
startupPublisher.buildFilters(suppressInternal);
return startupPublisher;
}
-
-
private TextWriter writer;
private FileBasedAccessLogPublisherCfg cfg;
private boolean isCombinedMode;
private boolean includeControlOIDs;
private String timeStampFormat = "dd/MMM/yyyy:HH:mm:ss Z";
-
-
- /** {@inheritDoc} */
@Override
- public ConfigChangeResult applyConfigurationChange(
- final FileBasedAccessLogPublisherCfg config)
+ public ConfigChangeResult applyConfigurationChange(FileBasedAccessLogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
- final File logFile = getFileForPath(config.getLogFile());
- final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- final FilePermission perm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
-
- final boolean writerAutoFlush = config.isAutoFlush()
- && !config.isAsynchronous();
-
+ // Determine the writer we are using. If we were writing asynchronously,
+ // we need to modify the underlying writer.
TextWriter currentWriter;
- // Determine the writer we are using. If we were writing
- // asynchronously, we need to modify the underlying writer.
if (writer instanceof AsynchronousTextWriter)
{
currentWriter = ((AsynchronousTextWriter) writer).getWrappedWriter();
@@ -139,59 +113,36 @@
if (currentWriter instanceof MultifileTextWriter)
{
- final MultifileTextWriter mfWriter =
- (MultifileTextWriter) currentWriter;
+ final MultifileTextWriter mfWriter = (MultifileTextWriter) currentWriter;
+ configure(mfWriter, config);
- mfWriter.setNamingPolicy(fnPolicy);
- mfWriter.setFilePermissions(perm);
- mfWriter.setAppend(config.isAppend());
- mfWriter.setAutoFlush(writerAutoFlush);
- mfWriter.setBufferSize((int) config.getBufferSize());
- mfWriter.setInterval(config.getTimeInterval());
-
- mfWriter.removeAllRetentionPolicies();
- mfWriter.removeAllRotationPolicies();
-
- for (final DN dn : config.getRotationPolicyDNs())
- {
- mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
- }
-
- for (final DN dn : config.getRetentionPolicyDNs())
- {
- mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
- }
-
- if (writer instanceof AsynchronousTextWriter
- && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- final AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (writer instanceof ParallelTextWriter && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- final ParallelTextWriter asyncWriter = (ParallelTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (!(writer instanceof AsynchronousTextWriter)
- && config.isAsynchronous())
+ if (config.isAsynchronous())
{
// The asynchronous setting is being turned on.
- writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ if (!(writer instanceof AsynchronousTextWriter))
+ {
+ writer = newAsyncWriter(mfWriter, config);
+ }
+ if (!(writer instanceof ParallelTextWriter))
+ {
+ writer = newParallelWriter(mfWriter, config);
+ }
}
-
- if (!(writer instanceof ParallelTextWriter) && config.isAsynchronous())
+ else
{
- // The asynchronous setting is being turned on.
- writer = new ParallelTextWriter("Parallel Text Writer for " + config.dn(),
- config.isAutoFlush(), mfWriter);
+ // The asynchronous setting is being turned off.
+ if (writer instanceof AsynchronousTextWriter)
+ {
+ final AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
+ if (writer instanceof ParallelTextWriter)
+ {
+ final ParallelTextWriter asyncWriter = (ParallelTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
}
if (cfg.isAsynchronous() && config.isAsynchronous()
@@ -221,26 +172,50 @@
return ccr;
}
+ private void configure(MultifileTextWriter mfWriter, FileBasedAccessLogPublisherCfg config) throws DirectoryException
+ {
+ final FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ final boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
+ final File logFile = getLogFile(config);
+ final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
- /** {@inheritDoc} */
+ mfWriter.setNamingPolicy(fnPolicy);
+ mfWriter.setFilePermissions(perm);
+ mfWriter.setAppend(config.isAppend());
+ mfWriter.setAutoFlush(writerAutoFlush);
+ mfWriter.setBufferSize((int) config.getBufferSize());
+ mfWriter.setInterval(config.getTimeInterval());
+
+ mfWriter.removeAllRetentionPolicies();
+ mfWriter.removeAllRotationPolicies();
+ for (final DN dn : config.getRotationPolicyDNs())
+ {
+ mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ }
+ for (final DN dn : config.getRetentionPolicyDNs())
+ {
+ mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
+ }
+ }
+
+ private File getLogFile(final FileBasedAccessLogPublisherCfg config)
+ {
+ return getFileForPath(config.getLogFile());
+ }
+
@Override
public void initializeLogPublisher(final FileBasedAccessLogPublisherCfg cfg, ServerContext serverContext)
throws ConfigException, InitializationException
{
- final File logFile = getFileForPath(cfg.getLogFile());
+ final File logFile = getLogFile(cfg);
final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- final FilePermission perm = FilePermission.decodeUNIXMode(cfg
- .getLogFilePermissions());
-
- final LogPublisherErrorHandler errorHandler =
- new LogPublisherErrorHandler(cfg.dn());
-
- final boolean writerAutoFlush = cfg.isAutoFlush()
- && !cfg.isAsynchronous();
+ final FilePermission perm = FilePermission.decodeUNIXMode(cfg.getLogFilePermissions());
+ final LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(cfg.dn());
+ final boolean writerAutoFlush = cfg.isAutoFlush() && !cfg.isAsynchronous();
final MultifileTextWriter theWriter = new MultifileTextWriter(
"Multifile Text Writer for " + cfg.dn(),
@@ -252,7 +227,6 @@
{
theWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
}
-
for (final DN dn : cfg.getRetentionPolicyDNs())
{
theWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
@@ -262,14 +236,11 @@
{
if (cfg.getQueueSize() > 0)
{
- this.writer = new AsynchronousTextWriter(
- "Asynchronous Text Writer for " + cfg.dn(),
- cfg.getQueueSize(), cfg.isAutoFlush(), theWriter);
+ this.writer = newAsyncWriter(theWriter, cfg);
}
else
{
- this.writer = new ParallelTextWriter("Parallel Text Writer for " + cfg.dn(),
- cfg.isAutoFlush(), theWriter);
+ this.writer = newParallelWriter(theWriter, cfg);
}
}
else
@@ -286,7 +257,6 @@
{
throw new InitializationException(
ERR_CONFIG_LOGGING_CANNOT_OPEN_FILE.get(logFile, cfg.dn(), e), e);
-
}
initializeFilters(cfg);
@@ -299,9 +269,18 @@
cfg.addFileBasedAccessChangeListener(this);
}
+ private AsynchronousTextWriter newAsyncWriter(MultifileTextWriter mfWriter, FileBasedAccessLogPublisherCfg config)
+ {
+ String name = "Asynchronous Text Writer for " + config.dn();
+ return new AsynchronousTextWriter(name, config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ }
+ private ParallelTextWriter newParallelWriter(MultifileTextWriter mfWriter, FileBasedAccessLogPublisherCfg config)
+ {
+ String name = "Parallel Text Writer for " + config.dn();
+ return new ParallelTextWriter(name, config.isAutoFlush(), mfWriter);
+ }
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAcceptable(
final FileBasedAccessLogPublisherCfg configuration,
@@ -311,9 +290,6 @@
&& isConfigurationChangeAcceptable(configuration, unacceptableReasons);
}
-
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
final FileBasedAccessLogPublisherCfg config,
@@ -335,12 +311,10 @@
// Make sure the permission is valid.
try
{
- final FilePermission filePerm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
+ final FilePermission filePerm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
if (!filePerm.isOwnerWritable())
{
- final LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config
- .getLogFilePermissions());
+ final LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config.getLogFilePermissions());
unacceptableReasons.add(message);
return false;
}
@@ -354,16 +328,6 @@
return true;
}
-
-
- /**
- * Writes a message to the access logger with information about the abandon
- * request associated with the provided abandon operation.
- *
- * @param abandonOperation
- * The abandon operation containing the information to use to log the
- * abandon request.
- */
@Override
public void logAbandonRequest(final AbandonOperation abandonOperation)
{
@@ -378,16 +342,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the result of
- * the provided abandon operation.
- *
- * @param abandonOperation
- * The abandon operation containing the information to use to log the
- * abandon request.
- */
@Override
public void logAbandonResult(final AbandonOperation abandonOperation)
{
@@ -403,24 +357,11 @@
appendAbandonRequest(abandonOperation, buffer);
}
appendResultCodeAndMessage(buffer, abandonOperation);
-
logAdditionalLogItems(abandonOperation, buffer);
-
appendEtime(buffer, abandonOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the add
- * request associated with the provided add operation.
- *
- * @param addOperation
- * The add operation containing the information to use to log the add
- * request.
- */
@Override
public void logAddRequest(final AddOperation addOperation)
{
@@ -435,16 +376,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the add
- * response associated with the provided add operation.
- *
- * @param addOperation
- * The add operation containing the information to use to log the add
- * response.
- */
@Override
public void logAddResponse(final AddOperation addOperation)
{
@@ -460,27 +391,12 @@
appendAddRequest(addOperation, buffer);
}
appendResultCodeAndMessage(buffer, addOperation);
-
logAdditionalLogItems(addOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", addOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", addOperation.getProxiedAuthorizationDN());
appendEtime(buffer, addOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the bind
- * request associated with the provided bind operation.
- *
- * @param bindOperation
- * The bind operation with the information to use to log the bind
- * request.
- */
@Override
public void logBindRequest(final BindOperation bindOperation)
{
@@ -495,16 +411,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the bind
- * response associated with the provided bind operation.
- *
- * @param bindOperation
- * The bind operation containing the information to use to log the
- * bind response.
- */
@Override
public void logBindResponse(final BindOperation bindOperation)
{
@@ -524,14 +430,12 @@
final LocalizableMessage failureMessage = bindOperation.getAuthFailureReason();
if (failureMessage != null)
{
- // this code path is mutually exclusive with the if result code is success
- // down below
+ // this code path is mutually exclusive with the if result code is success down below
appendLabel(buffer, "authFailureReason", failureMessage);
if (bindOperation.getSASLMechanism() != null
&& bindOperation.getSASLAuthUserEntry() != null)
{ // SASL bind and we have successfully found a user entry for auth
- appendLabel(buffer, "authDN", bindOperation.getSASLAuthUserEntry()
- .getName());
+ appendLabel(buffer, "authDN", bindOperation.getSASLAuthUserEntry().getName());
}
else
{ // SASL bind failed to find user entry for auth or simple bind
@@ -543,8 +447,7 @@
if (bindOperation.getResultCode() == ResultCode.SUCCESS)
{
- // this code path is mutually exclusive with the if failure message exist
- // just above
+ // this code path is mutually exclusive with the if failure message that exists just above
final AuthenticationInfo authInfo = bindOperation.getAuthenticationInfo();
if (authInfo != null)
{
@@ -571,16 +474,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the compare
- * request associated with the provided compare operation.
- *
- * @param compareOperation
- * The compare operation containing the information to use to log the
- * compare request.
- */
@Override
public void logCompareRequest(final CompareOperation compareOperation)
{
@@ -595,16 +488,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the compare
- * response associated with the provided compare operation.
- *
- * @param compareOperation
- * The compare operation containing the information to use to log the
- * compare response.
- */
@Override
public void logCompareResponse(final CompareOperation compareOperation)
{
@@ -620,27 +503,12 @@
appendCompareRequest(compareOperation, buffer);
}
appendResultCodeAndMessage(buffer, compareOperation);
-
logAdditionalLogItems(compareOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", compareOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", compareOperation.getProxiedAuthorizationDN());
appendEtime(buffer, compareOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about a new client
- * connection that has been established, regardless of whether it will be
- * immediately terminated.
- *
- * @param clientConnection
- * The client connection that has been established.
- */
@Override
public void logConnect(final ClientConnection clientConnection)
{
@@ -651,31 +519,15 @@
final long connectionID = clientConnection.getConnectionID();
final StringBuilder buffer = new StringBuilder(100);
- buffer.append('[');
- buffer.append(TimeThread.getUserDefinedTime(timeStampFormat));
- buffer.append(']');
- buffer.append(" CONNECT conn=");
- buffer.append(connectionID);
- buffer.append(" from=");
- buffer.append(clientConnection.getClientHostPort());
- buffer.append(" to=");
- buffer.append(clientConnection.getServerHostPort());
- buffer.append(" protocol=");
- buffer.append(clientConnection.getProtocol());
+ buffer.append('[').append(TimeThread.getUserDefinedTime(timeStampFormat)).append(']');
+ buffer.append(" CONNECT conn=").append(connectionID);
+ buffer.append(" from=").append(clientConnection.getClientHostPort());
+ buffer.append(" to=").append(clientConnection.getServerHostPort());
+ buffer.append(" protocol=").append(clientConnection.getProtocol());
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the delete
- * request associated with the provided delete operation.
- *
- * @param deleteOperation
- * The delete operation with the information to use to log the delete
- * request.
- */
@Override
public void logDeleteRequest(final DeleteOperation deleteOperation)
{
@@ -690,16 +542,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the delete
- * response associated with the provided delete operation.
- *
- * @param deleteOperation
- * The delete operation containing the information to use to log the
- * delete response.
- */
@Override
public void logDeleteResponse(final DeleteOperation deleteOperation)
{
@@ -715,31 +557,12 @@
appendDeleteRequest(deleteOperation, buffer);
}
appendResultCodeAndMessage(buffer, deleteOperation);
-
logAdditionalLogItems(deleteOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", deleteOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", deleteOperation.getProxiedAuthorizationDN());
appendEtime(buffer, deleteOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the
- * termination of an existing client connection.
- *
- * @param clientConnection
- * The client connection that has been terminated.
- * @param disconnectReason
- * A generic disconnect reason for the connection termination.
- * @param message
- * A human-readable message that can provide additional information
- * about the disconnect.
- */
@Override
public void logDisconnect(final ClientConnection clientConnection,
final DisconnectReason disconnectReason, final LocalizableMessage message)
@@ -751,27 +574,14 @@
final long connectionID = clientConnection.getConnectionID();
final StringBuilder buffer = new StringBuilder(100);
- buffer.append('[');
- buffer.append(TimeThread.getUserDefinedTime(timeStampFormat));
- buffer.append(']');
- buffer.append(" DISCONNECT conn=");
- buffer.append(connectionID);
+ buffer.append('[').append(TimeThread.getUserDefinedTime(timeStampFormat)).append(']');
+ buffer.append(" DISCONNECT conn=").append(connectionID);
appendLabel(buffer, "reason", disconnectReason);
appendLabelIfNotNull(buffer, "msg", message);
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the extended
- * request associated with the provided extended operation.
- *
- * @param extendedOperation
- * The extended operation containing the information to use to log
- * the extended request.
- */
@Override
public void logExtendedRequest(final ExtendedOperation extendedOperation)
{
@@ -786,16 +596,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the extended
- * response associated with the provided extended operation.
- *
- * @param extendedOperation
- * The extended operation containing the info to use to log the
- * extended response.
- */
@Override
public void logExtendedResponse(final ExtendedOperation extendedOperation)
{
@@ -824,24 +624,12 @@
appendLabel(buffer, "oid", oid);
}
appendResultCodeAndMessage(buffer, extendedOperation);
-
logAdditionalLogItems(extendedOperation, buffer);
-
appendEtime(buffer, extendedOperation);
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the modify DN
- * request associated with the provided modify DN operation.
- *
- * @param modifyDNOperation
- * The modify DN operation containing the info to use to log the
- * modify DN request.
- */
@Override
public void logModifyDNRequest(final ModifyDNOperation modifyDNOperation)
{
@@ -856,16 +644,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the modify DN
- * response associated with the provided modify DN operation.
- *
- * @param modifyDNOperation
- * The modify DN operation containing the information to use to log
- * the modify DN response.
- */
@Override
public void logModifyDNResponse(final ModifyDNOperation modifyDNOperation)
{
@@ -881,27 +659,12 @@
appendModifyDNRequest(modifyDNOperation, buffer);
}
appendResultCodeAndMessage(buffer, modifyDNOperation);
-
logAdditionalLogItems(modifyDNOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", modifyDNOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", modifyDNOperation.getProxiedAuthorizationDN());
appendEtime(buffer, modifyDNOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the modify
- * request associated with the provided modify operation.
- *
- * @param modifyOperation
- * The modify operation containing the information to use to log the
- * modify request.
- */
@Override
public void logModifyRequest(final ModifyOperation modifyOperation)
{
@@ -916,16 +679,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the modify
- * response associated with the provided modify operation.
- *
- * @param modifyOperation
- * The modify operation containing the information to use to log the
- * modify response.
- */
@Override
public void logModifyResponse(final ModifyOperation modifyOperation)
{
@@ -941,27 +694,12 @@
appendModifyRequest(modifyOperation, buffer);
}
appendResultCodeAndMessage(buffer, modifyOperation);
-
logAdditionalLogItems(modifyOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", modifyOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", modifyOperation.getProxiedAuthorizationDN());
appendEtime(buffer, modifyOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the search
- * request associated with the provided search operation.
- *
- * @param searchOperation
- * The search operation containing the info to use to log the search
- * request.
- */
@Override
public void logSearchRequest(final SearchOperation searchOperation)
{
@@ -976,16 +714,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the completion
- * of the provided search operation.
- *
- * @param searchOperation
- * The search operation containing the information to use to log the
- * search result done message.
- */
@Override
public void logSearchResultDone(final SearchOperation searchOperation)
{
@@ -1001,30 +729,13 @@
appendSearchRequest(searchOperation, buffer);
}
appendResultCodeAndMessage(buffer, searchOperation);
-
- buffer.append(" nentries=");
- buffer.append(searchOperation.getEntriesSent());
-
+ buffer.append(" nentries=").append(searchOperation.getEntriesSent());
logAdditionalLogItems(searchOperation, buffer);
-
- appendLabelIfNotNull(buffer, "authzDN", searchOperation
- .getProxiedAuthorizationDN());
-
+ appendLabelIfNotNull(buffer, "authzDN", searchOperation.getProxiedAuthorizationDN());
appendEtime(buffer, searchOperation);
-
writer.writeRecord(buffer.toString());
}
-
-
- /**
- * Writes a message to the access logger with information about the unbind
- * request associated with the provided unbind operation.
- *
- * @param unbindOperation
- * The unbind operation containing the info to use to log the unbind
- * request.
- */
@Override
public void logUnbind(final UnbindOperation unbindOperation)
{
@@ -1043,9 +754,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /** {@inheritDoc} */
@Override
protected void close0()
{
@@ -1057,10 +765,7 @@
}
}
-
-
- private void appendAbandonRequest(final AbandonOperation abandonOperation,
- final StringBuilder buffer)
+ private void appendAbandonRequest(final AbandonOperation abandonOperation, final StringBuilder buffer)
{
buffer.append(" idToAbandon=");
buffer.append(abandonOperation.getIDToAbandon());
@@ -1071,10 +776,7 @@
}
}
-
-
- private void appendAddRequest(final AddOperation addOperation,
- final StringBuilder buffer)
+ private void appendAddRequest(final AddOperation addOperation, final StringBuilder buffer)
{
appendLabel(buffer, "dn", addOperation.getRawEntryDN());
appendRequestControls(addOperation, buffer);
@@ -1084,10 +786,7 @@
}
}
-
-
- private void appendBindRequest(final BindOperation bindOperation,
- final StringBuilder buffer)
+ private void appendBindRequest(final BindOperation bindOperation, final StringBuilder buffer)
{
final String protocolVersion = bindOperation.getProtocolVersion();
if (protocolVersion != null)
@@ -1102,12 +801,10 @@
buffer.append(" type=SIMPLE");
break;
case SASL:
- buffer.append(" type=SASL mechanism=");
- buffer.append(bindOperation.getSASLMechanism());
+ buffer.append(" type=SASL mechanism=").append(bindOperation.getSASLMechanism());
break;
default:
- buffer.append(" type=");
- buffer.append(bindOperation.getAuthenticationType());
+ buffer.append(" type=").append(bindOperation.getAuthenticationType());
break;
}
@@ -1119,10 +816,7 @@
}
}
-
-
- private void appendCompareRequest(final CompareOperation compareOperation,
- final StringBuilder buffer)
+ private void appendCompareRequest(final CompareOperation compareOperation, final StringBuilder buffer)
{
appendLabel(buffer, "dn", compareOperation.getRawEntryDN());
buffer.append(" attr=");
@@ -1134,10 +828,7 @@
}
}
-
-
- private void appendDeleteRequest(final DeleteOperation deleteOperation,
- final StringBuilder buffer)
+ private void appendDeleteRequest(final DeleteOperation deleteOperation, final StringBuilder buffer)
{
appendLabel(buffer, "dn", deleteOperation.getRawEntryDN());
appendRequestControls(deleteOperation, buffer);
@@ -1147,14 +838,11 @@
}
}
-
-
private void appendExtendedRequest(final ExtendedOperation extendedOperation,
final StringBuilder buffer)
{
final String oid = extendedOperation.getRequestOID();
- final ExtendedOperationHandler<?> extOpHandler = DirectoryServer
- .getExtendedOperationHandler(oid);
+ final ExtendedOperationHandler<?> extOpHandler = DirectoryServer.getExtendedOperationHandler(oid);
if (extOpHandler != null)
{
final String name = extOpHandler.getExtendedOperationName();
@@ -1168,10 +856,7 @@
}
}
-
-
- private void appendLabel(final StringBuilder buffer, final String label,
- final Object obj)
+ private void appendLabel(final StringBuilder buffer, final String label, final Object obj)
{
buffer.append(' ').append(label).append("=\"");
if (obj != null)
@@ -1181,8 +866,7 @@
buffer.append('\"');
}
- private void appendLabelIfNotNull(final StringBuilder buffer,
- final String label, final Object obj)
+ private void appendLabelIfNotNull(final StringBuilder buffer, final String label, final Object obj)
{
if (obj != null)
{
@@ -1190,8 +874,7 @@
}
}
- private void appendResultCodeAndMessage(StringBuilder buffer,
- Operation operation)
+ private void appendResultCodeAndMessage(StringBuilder buffer, Operation operation)
{
buffer.append(" result=");
buffer.append(operation.getResultCode().intValue());
@@ -1214,8 +897,7 @@
}
}
- private void appendEtime(final StringBuilder buffer,
- final Operation operation)
+ private void appendEtime(final StringBuilder buffer, final Operation operation)
{
buffer.append(" etime=");
// the server can be configured to log processing time as nanos xor millis
@@ -1228,31 +910,21 @@
buffer.append(etime);
}
- /**
- * Appends the common log header information to the provided buffer.
- */
+ /** Appends the common log header information to the provided buffer. */
private void appendHeader(final Operation operation, final String opType,
final String category, final StringBuilder buffer)
{
- buffer.append('[');
- buffer.append(TimeThread.getUserDefinedTime(timeStampFormat));
- buffer.append("] ");
+ buffer.append('[').append(TimeThread.getUserDefinedTime(timeStampFormat)).append("] ");
buffer.append(opType);
if (!isCombinedMode)
{
- buffer.append(' ');
- buffer.append(category);
+ buffer.append(' ').append(category);
}
- buffer.append(" conn=");
- buffer.append(operation.getConnectionID());
- buffer.append(" op=");
- buffer.append(operation.getOperationID());
- buffer.append(" msgID=");
- buffer.append(operation.getMessageID());
+ buffer.append(" conn=").append(operation.getConnectionID());
+ buffer.append(" op=").append(operation.getOperationID());
+ buffer.append(" msgID=").append(operation.getMessageID());
}
-
-
private void appendModifyDNRequest(final ModifyDNOperation modifyDNOperation,
final StringBuilder buffer)
{
@@ -1269,10 +941,7 @@
}
}
-
-
- private void appendModifyRequest(final ModifyOperation modifyOperation,
- final StringBuilder buffer)
+ private void appendModifyRequest(final ModifyOperation modifyOperation, final StringBuilder buffer)
{
appendLabel(buffer, "dn", modifyOperation.getRawEntryDN());
appendRequestControls(modifyOperation, buffer);
@@ -1282,16 +951,23 @@
}
}
-
-
- private void appendRequestControls(final Operation operation,
- final StringBuilder buffer)
+ private void appendRequestControls(final Operation operation, final StringBuilder buffer)
{
- if (includeControlOIDs && !operation.getRequestControls().isEmpty())
+ appendControls(buffer, " requestControls=", operation.getRequestControls());
+ }
+
+ private void appendResponseControls(final Operation operation, final StringBuilder buffer)
+ {
+ appendControls(buffer, " responseControls=", operation.getResponseControls());
+ }
+
+ private void appendControls(final StringBuilder buffer, String label, List<Control> controls)
+ {
+ if (includeControlOIDs && !controls.isEmpty())
{
- buffer.append(" requestControls=");
+ buffer.append(label);
boolean isFirst = true;
- for (final Control control : operation.getRequestControls())
+ for (final Control control : controls)
{
if (!isFirst)
{
@@ -1303,31 +979,7 @@
}
}
-
-
- private void appendResponseControls(final Operation operation,
- final StringBuilder buffer)
- {
- if (includeControlOIDs && !operation.getResponseControls().isEmpty())
- {
- buffer.append(" responseControls=");
- boolean isFirst = true;
- for (final Control control : operation.getResponseControls())
- {
- if (!isFirst)
- {
- buffer.append(",");
- }
- buffer.append(control.getOID());
- isFirst = false;
- }
- }
- }
-
-
-
- private void appendSearchRequest(final SearchOperation searchOperation,
- final StringBuilder buffer)
+ private void appendSearchRequest(final SearchOperation searchOperation, final StringBuilder buffer)
{
appendLabel(buffer, "base", searchOperation.getRawBaseDN());
buffer.append(" scope=");
@@ -1343,15 +995,7 @@
else
{
buffer.append("\" attrs=\"");
-
- final Iterator<String> iterator = attrs.iterator();
- buffer.append(iterator.next());
- while (iterator.hasNext())
- {
- buffer.append(",");
- buffer.append(iterator.next());
- }
-
+ Utils.joinAsString(buffer, ",", attrs);
buffer.append("\"");
}
appendRequestControls(searchOperation, buffer);
@@ -1361,13 +1005,8 @@
}
}
-
-
- /**
- * Appends additional log items to the provided builder.
- */
- private void logAdditionalLogItems(final Operation operation,
- final StringBuilder builder)
+ /** Appends additional log items to the provided builder. */
+ private void logAdditionalLogItems(final Operation operation, final StringBuilder builder)
{
appendResponseControls(operation, builder);
for (final AdditionalLogItem item : operation.getAdditionalLogItems())
@@ -1376,5 +1015,4 @@
item.toString(builder);
}
}
-
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAuditLogPublisher.java b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAuditLogPublisher.java
index e1a25db..5491222 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAuditLogPublisher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextAuditLogPublisher.java
@@ -26,8 +26,8 @@
*/
package org.opends.server.loggers;
-import static org.opends.messages.ConfigMessages.*;
import static org.forgerock.opendj.ldap.ResultCode.*;
+import static org.opends.messages.ConfigMessages.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;
@@ -36,52 +36,36 @@
import java.util.List;
import org.forgerock.i18n.LocalizableMessage;
-import org.opends.server.admin.server.ConfigurationChangeListener;
-import org.opends.server.admin.std.server.FileBasedAuditLogPublisherCfg;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
-import org.opends.server.core.*;
-import org.opends.server.types.*;
import org.forgerock.opendj.ldap.ByteSequence;
import org.forgerock.opendj.ldap.ByteString;
+import org.opends.server.admin.server.ConfigurationChangeListener;
+import org.opends.server.admin.std.server.FileBasedAuditLogPublisherCfg;
+import org.opends.server.core.*;
+import org.opends.server.types.*;
import org.opends.server.util.Base64;
import org.opends.server.util.StaticUtils;
import org.opends.server.util.TimeThread;
-/**
- * This class provides the implementation of the audit logger used by
- * the directory server.
- */
+/** This class provides the implementation of the audit logger used by the directory server. */
public final class TextAuditLogPublisher extends
AbstractTextAccessLogPublisher<FileBasedAuditLogPublisherCfg> implements
ConfigurationChangeListener<FileBasedAuditLogPublisherCfg>
{
-
private TextWriter writer;
private FileBasedAuditLogPublisherCfg cfg;
- /** {@inheritDoc} */
@Override
- public ConfigChangeResult applyConfigurationChange(
- FileBasedAuditLogPublisherCfg config)
+ public ConfigChangeResult applyConfigurationChange(FileBasedAuditLogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
- File logFile = getFileForPath(config.getLogFile());
- FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
-
try
{
- FilePermission perm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
-
- boolean writerAutoFlush = config.isAutoFlush()
- && !config.isAsynchronous();
-
- TextWriter currentWriter;
- // Determine the writer we are using. If we were writing
- // asynchronously,
+ // Determine the writer we are using. If we were writing asynchronously,
// we need to modify the underlying writer.
+ TextWriter currentWriter;
if (writer instanceof AsynchronousTextWriter)
{
currentWriter = ((AsynchronousTextWriter) writer).getWrappedWriter();
@@ -93,43 +77,26 @@
if (currentWriter instanceof MultifileTextWriter)
{
- MultifileTextWriter mfWriter = (MultifileTextWriter) currentWriter;
+ final MultifileTextWriter mfWriter = (MultifileTextWriter) currentWriter;
+ configure(mfWriter, config);
- mfWriter.setNamingPolicy(fnPolicy);
- mfWriter.setFilePermissions(perm);
- mfWriter.setAppend(config.isAppend());
- mfWriter.setAutoFlush(writerAutoFlush);
- mfWriter.setBufferSize((int) config.getBufferSize());
- mfWriter.setInterval(config.getTimeInterval());
-
- mfWriter.removeAllRetentionPolicies();
- mfWriter.removeAllRotationPolicies();
-
- for (DN dn : config.getRotationPolicyDNs())
+ if (config.isAsynchronous())
{
- mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ if (!(writer instanceof AsynchronousTextWriter))
+ {
+ // The asynchronous setting is being turned on.
+ writer = newAsyncWriter(mfWriter, config);
+ }
}
-
- for (DN dn : config.getRetentionPolicyDNs())
+ else
{
- mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
- }
-
- if (writer instanceof AsynchronousTextWriter
- && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (!(writer instanceof AsynchronousTextWriter)
- && config.isAsynchronous())
- {
- // The asynchronous setting is being turned on.
- writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ if (writer instanceof AsynchronousTextWriter)
+ {
+ // The asynchronous setting is being turned off.
+ AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
}
if (cfg.isAsynchronous() && config.isAsynchronous()
@@ -151,9 +118,38 @@
return ccr;
}
+ private void configure(MultifileTextWriter mfWriter, FileBasedAuditLogPublisherCfg config) throws DirectoryException
+ {
+ final FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ final boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
+ final File logFile = getLogFile(config);
+ final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
- /** {@inheritDoc} */
+ mfWriter.setNamingPolicy(fnPolicy);
+ mfWriter.setFilePermissions(perm);
+ mfWriter.setAppend(config.isAppend());
+ mfWriter.setAutoFlush(writerAutoFlush);
+ mfWriter.setBufferSize((int) config.getBufferSize());
+ mfWriter.setInterval(config.getTimeInterval());
+
+ mfWriter.removeAllRetentionPolicies();
+ mfWriter.removeAllRotationPolicies();
+ for (final DN dn : config.getRotationPolicyDNs())
+ {
+ mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ }
+ for (final DN dn : config.getRetentionPolicyDNs())
+ {
+ mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
+ }
+ }
+
+ private File getLogFile(final FileBasedAuditLogPublisherCfg config)
+ {
+ return getFileForPath(config.getLogFile());
+ }
+
@Override
protected void close0()
{
@@ -161,26 +157,18 @@
cfg.removeFileBasedAuditChangeListener(this);
}
-
-
- /** {@inheritDoc} */
@Override
public void initializeLogPublisher(FileBasedAuditLogPublisherCfg cfg, ServerContext serverContext)
throws ConfigException, InitializationException
{
- File logFile = getFileForPath(cfg.getLogFile());
+ File logFile = getLogFile(cfg);
FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- FilePermission perm = FilePermission.decodeUNIXMode(cfg
- .getLogFilePermissions());
-
- LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(
- cfg.dn());
-
- boolean writerAutoFlush = cfg.isAutoFlush()
- && !cfg.isAsynchronous();
+ final FilePermission perm = FilePermission.decodeUNIXMode(cfg.getLogFilePermissions());
+ final LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(cfg.dn());
+ final boolean writerAutoFlush = cfg.isAutoFlush() && !cfg.isAsynchronous();
MultifileTextWriter writer = new MultifileTextWriter("Multifile Text Writer for " + cfg.dn(),
cfg.getTimeInterval(), fnPolicy, perm, errorHandler, "UTF-8",
@@ -191,7 +179,6 @@
{
writer.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
}
-
for (DN dn : cfg.getRetentionPolicyDNs())
{
writer.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
@@ -199,8 +186,7 @@
if (cfg.isAsynchronous())
{
- this.writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + cfg.dn(),
- cfg.getQueueSize(), cfg.isAutoFlush(), writer);
+ this.writer = newAsyncWriter(writer, cfg);
}
else
{
@@ -223,9 +209,12 @@
cfg.addFileBasedAuditChangeListener(this);
}
+ private AsynchronousTextWriter newAsyncWriter(MultifileTextWriter writer, FileBasedAuditLogPublisherCfg cfg)
+ {
+ String name = "Asynchronous Text Writer for " + cfg.dn();
+ return new AsynchronousTextWriter(name, cfg.getQueueSize(), cfg.isAutoFlush(), writer);
+ }
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAcceptable(
FileBasedAuditLogPublisherCfg configuration,
@@ -235,9 +224,6 @@
&& isConfigurationChangeAcceptable(configuration, unacceptableReasons);
}
-
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
FileBasedAuditLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
@@ -245,12 +231,10 @@
// Make sure the permission is valid.
try
{
- FilePermission filePerm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
+ FilePermission filePerm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
if (!filePerm.isOwnerWritable())
{
- LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config
- .getLogFilePermissions());
+ LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config.getLogFilePermissions());
unacceptableReasons.add(message);
return false;
}
@@ -264,9 +248,6 @@
return true;
}
-
-
- /** {@inheritDoc} */
@Override
public void logAddResponse(AddOperation addOperation)
{
@@ -300,8 +281,7 @@
}
}
- for (List<Attribute> attrList : addOperation.getOperationalAttributes()
- .values())
+ for (List<Attribute> attrList : addOperation.getOperationalAttributes().values())
{
for (Attribute a : attrList)
{
@@ -312,9 +292,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /** {@inheritDoc} */
@Override
public void logDeleteResponse(DeleteOperation deleteOperation)
{
@@ -336,9 +313,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /** {@inheritDoc} */
@Override
public void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
{
@@ -383,9 +357,6 @@
writer.writeRecord(buffer.toString());
}
-
-
- /** {@inheritDoc} */
@Override
public void logModifyResponse(ModifyOperation modifyOperation)
{
@@ -445,8 +416,6 @@
writer.writeRecord(buffer.toString());
}
-
-
private void append(StringBuilder buffer, Attribute a)
{
for (ByteString v : a)
@@ -458,8 +427,6 @@
}
}
-
-
/** Appends the common log header information to the provided buffer. */
private void appendHeader(Operation operation, StringBuilder buffer)
{
@@ -472,8 +439,6 @@
buffer.append(EOL);
}
-
-
/**
* Appends the appropriately-encoded attribute value to the provided
* buffer.
@@ -497,8 +462,6 @@
}
}
-
-
/**
* Appends the appropriately-encoded attribute value to the provided
* buffer.
@@ -522,8 +485,6 @@
}
}
-
-
/** Determines whether the provided operation should be logged. */
private boolean isLoggable(Operation operation)
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextDebugLogPublisher.java b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextDebugLogPublisher.java
index 888b2fe..6bdb010 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextDebugLogPublisher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextDebugLogPublisher.java
@@ -32,16 +32,16 @@
import java.util.Map;
import org.forgerock.i18n.LocalizableMessage;
+import org.forgerock.opendj.config.server.ConfigChangeResult;
+import org.forgerock.opendj.config.server.ConfigException;
import org.opends.server.admin.server.ConfigurationAddListener;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.server.ConfigurationDeleteListener;
import org.opends.server.admin.std.server.DebugTargetCfg;
import org.opends.server.admin.std.server.FileBasedDebugLogPublisherCfg;
import org.opends.server.api.DirectoryThread;
-import org.forgerock.opendj.config.server.ConfigException;
import org.opends.server.core.DirectoryServer;
import org.opends.server.core.ServerContext;
-import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.types.DN;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.FilePermission;
@@ -63,9 +63,7 @@
ConfigurationDeleteListener<DebugTargetCfg>
{
private static long globalSequenceNumber;
-
private TextWriter writer;
-
private FileBasedDebugLogPublisherCfg currentConfig;
/**
@@ -105,7 +103,6 @@
return startupPublisher;
}
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAcceptable(
FileBasedDebugLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
@@ -113,7 +110,6 @@
return isConfigurationChangeAcceptable(config, unacceptableReasons);
}
- /** {@inheritDoc} */
@Override
public void initializeLogPublisher(FileBasedDebugLogPublisherCfg config, ServerContext serverContext)
throws ConfigException, InitializationException
@@ -123,14 +119,9 @@
try
{
- FilePermission perm =
- FilePermission.decodeUNIXMode(config.getLogFilePermissions());
-
- LogPublisherErrorHandler errorHandler =
- new LogPublisherErrorHandler(config.dn());
-
- boolean writerAutoFlush =
- config.isAutoFlush() && !config.isAsynchronous();
+ FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(config.dn());
+ boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
MultifileTextWriter writer = new MultifileTextWriter("Multifile Text Writer for " + config.dn(),
config.getTimeInterval(),
@@ -147,7 +138,6 @@
{
writer.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
}
-
for(DN dn: config.getRetentionPolicyDNs())
{
writer.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
@@ -155,8 +145,7 @@
if(config.isAsynchronous())
{
- this.writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), writer);
+ this.writer = newAsyncWriter(writer, config);
}
else
{
@@ -174,7 +163,6 @@
ERR_CONFIG_LOGGING_CANNOT_OPEN_FILE.get(logFile, config.dn(), e), e);
}
-
config.addDebugTargetAddListener(this);
config.addDebugTargetDeleteListener(this);
@@ -191,9 +179,6 @@
config.addFileBasedDebugChangeListener(this);
}
-
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
FileBasedDebugLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
@@ -201,17 +186,15 @@
// Make sure the permission is valid.
try
{
- FilePermission filePerm =
- FilePermission.decodeUNIXMode(config.getLogFilePermissions());
- if(!filePerm.isOwnerWritable())
+ FilePermission filePerm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ if (!filePerm.isOwnerWritable())
{
- LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(
- config.getLogFilePermissions());
+ LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config.getLogFilePermissions());
unacceptableReasons.add(message);
return false;
}
}
- catch(DirectoryException e)
+ catch (DirectoryException e)
{
unacceptableReasons.add(ERR_CONFIG_LOGGING_MODE_INVALID.get(config.getLogFilePermissions(), e));
return false;
@@ -220,30 +203,19 @@
return true;
}
- /** {@inheritDoc} */
@Override
- public ConfigChangeResult applyConfigurationChange(
- FileBasedDebugLogPublisherCfg config)
+ public ConfigChangeResult applyConfigurationChange(FileBasedDebugLogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
addTraceSettings(null, getDefaultSettings(config));
DebugLogger.updateTracerSettings();
- File logFile = getFileForPath(config.getLogFile());
- FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
-
try
{
- FilePermission perm =
- FilePermission.decodeUNIXMode(config.getLogFilePermissions());
-
- boolean writerAutoFlush =
- config.isAutoFlush() && !config.isAsynchronous();
-
- TextWriter currentWriter;
// Determine the writer we are using. If we were writing asynchronously,
// we need to modify the underlying writer.
+ TextWriter currentWriter;
if(writer instanceof AsynchronousTextWriter)
{
currentWriter = ((AsynchronousTextWriter)writer).getWrappedWriter();
@@ -256,41 +228,25 @@
if(currentWriter instanceof MultifileTextWriter)
{
MultifileTextWriter mfWriter = (MultifileTextWriter)writer;
+ configure(mfWriter, config);
- mfWriter.setNamingPolicy(fnPolicy);
- mfWriter.setFilePermissions(perm);
- mfWriter.setAppend(config.isAppend());
- mfWriter.setAutoFlush(writerAutoFlush);
- mfWriter.setBufferSize((int)config.getBufferSize());
- mfWriter.setInterval(config.getTimeInterval());
-
- mfWriter.removeAllRetentionPolicies();
- mfWriter.removeAllRotationPolicies();
-
- for(DN dn : config.getRotationPolicyDNs())
+ if (config.isAsynchronous())
{
- mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ if (!(writer instanceof AsynchronousTextWriter))
+ {
+ // The asynchronous setting is being turned on.
+ writer = newAsyncWriter(mfWriter, config);
+ }
}
-
- for(DN dn: config.getRetentionPolicyDNs())
+ else
{
- mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
- }
-
- if(writer instanceof AsynchronousTextWriter && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if(!(writer instanceof AsynchronousTextWriter) &&
- config.isAsynchronous())
- {
- // The asynchronous setting is being turned on.
- writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ if (writer instanceof AsynchronousTextWriter)
+ {
+ // The asynchronous setting is being turned off.
+ AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
}
if(currentConfig.isAsynchronous() && config.isAsynchronous() &&
@@ -312,6 +268,44 @@
return ccr;
}
+ private AsynchronousTextWriter newAsyncWriter(MultifileTextWriter writer, FileBasedDebugLogPublisherCfg config)
+ {
+ String name = "Asynchronous Text Writer for " + config.dn();
+ return new AsynchronousTextWriter(name, config.getQueueSize(), config.isAutoFlush(), writer);
+ }
+
+ private void configure(MultifileTextWriter mfWriter, FileBasedDebugLogPublisherCfg config) throws DirectoryException
+ {
+ FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
+
+ File logFile = getLogFile(config);
+ FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
+
+ mfWriter.setNamingPolicy(fnPolicy);
+ mfWriter.setFilePermissions(perm);
+ mfWriter.setAppend(config.isAppend());
+ mfWriter.setAutoFlush(writerAutoFlush);
+ mfWriter.setBufferSize((int)config.getBufferSize());
+ mfWriter.setInterval(config.getTimeInterval());
+
+ mfWriter.removeAllRetentionPolicies();
+ mfWriter.removeAllRotationPolicies();
+ for(DN dn : config.getRotationPolicyDNs())
+ {
+ mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ }
+ for(DN dn: config.getRetentionPolicyDNs())
+ {
+ mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
+ }
+ }
+
+ private File getLogFile(FileBasedDebugLogPublisherCfg config)
+ {
+ return getFileForPath(config.getLogFile());
+ }
+
private TraceSettings getDefaultSettings(FileBasedDebugLogPublisherCfg config)
{
return new TraceSettings(
@@ -322,7 +316,6 @@
config.isDefaultIncludeThrowableCause());
}
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAddAcceptable(DebugTargetCfg config,
List<LocalizableMessage> unacceptableReasons)
@@ -330,7 +323,6 @@
return !hasTraceSettings(config.getDebugScope());
}
- /** {@inheritDoc} */
@Override
public boolean isConfigurationDeleteAcceptable(DebugTargetCfg config,
List<LocalizableMessage> unacceptableReasons)
@@ -339,7 +331,6 @@
return true;
}
- /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationAdd(DebugTargetCfg config)
{
@@ -350,7 +341,6 @@
return new ConfigChangeResult();
}
- /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationDelete(DebugTargetCfg config)
{
@@ -361,7 +351,6 @@
return new ConfigChangeResult();
}
- /** {@inheritDoc} */
@Override
public void trace(TraceSettings settings, String signature,
String sourceLocation, String msg, StackTraceElement[] stackTrace)
@@ -375,7 +364,6 @@
publish(signature, sourceLocation, msg, stack);
}
- /** {@inheritDoc} */
@Override
public void traceException(TraceSettings settings, String signature,
String sourceLocation, String msg, Throwable ex,
@@ -392,7 +380,6 @@
publish(signature, sourceLocation, message, stack);
}
- /** {@inheritDoc} */
@Override
public void close()
{
@@ -404,7 +391,6 @@
}
}
-
/**
* Publishes a record, optionally performing some "special" work:
* - injecting a stack trace into the message
@@ -469,7 +455,6 @@
writer.writeRecord(buf.toString());
}
- /** {@inheritDoc} */
@Override
public DN getDN()
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextErrorLogPublisher.java b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextErrorLogPublisher.java
index 73c610f..2592f20 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextErrorLogPublisher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextErrorLogPublisher.java
@@ -40,6 +40,7 @@
import java.util.StringTokenizer;
import org.forgerock.i18n.LocalizableMessage;
+import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
import org.opends.messages.Severity;
import org.opends.server.admin.server.ConfigurationChangeListener;
@@ -47,7 +48,6 @@
import org.opends.server.admin.std.server.FileBasedErrorLogPublisherCfg;
import org.opends.server.core.DirectoryServer;
import org.opends.server.core.ServerContext;
-import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.types.DN;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.FilePermission;
@@ -55,9 +55,7 @@
import org.opends.server.util.StaticUtils;
import org.opends.server.util.TimeThread;
-/**
- * This class provides an implementation of an error log publisher.
- */
+/** This class provides an implementation of an error log publisher. */
public class TextErrorLogPublisher
extends ErrorLogPublisher<FileBasedErrorLogPublisherCfg>
implements ConfigurationChangeListener<FileBasedErrorLogPublisherCfg>
@@ -82,8 +80,6 @@
return startupPublisher;
}
-
-
/**
* Returns a new text error log publisher which will print only notices,
* severe warnings and errors, and fatal errors messages to the provided
@@ -96,8 +92,7 @@
* severe warnings and errors, and fatal errors messages to the
* provided writer.
*/
- public static TextErrorLogPublisher getServerStartupTextErrorPublisher(
- TextWriter writer)
+ public static TextErrorLogPublisher getServerStartupTextErrorPublisher(TextWriter writer)
{
TextErrorLogPublisher startupPublisher = new TextErrorLogPublisher();
startupPublisher.writer = writer;
@@ -106,26 +101,18 @@
return startupPublisher;
}
-
-
- /** {@inheritDoc} */
@Override
public void initializeLogPublisher(FileBasedErrorLogPublisherCfg config, ServerContext serverContext)
throws ConfigException, InitializationException
{
- File logFile = getFileForPath(config.getLogFile());
+ File logFile = getLogFile(config);
FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- FilePermission perm =
- FilePermission.decodeUNIXMode(config.getLogFilePermissions());
-
- LogPublisherErrorHandler errorHandler =
- new LogPublisherErrorHandler(config.dn());
-
- boolean writerAutoFlush =
- config.isAutoFlush() && !config.isAsynchronous();
+ FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(config.dn());
+ boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
MultifileTextWriter writer = new MultifileTextWriter("Multifile Text Writer for " + config.dn(),
config.getTimeInterval(),
@@ -142,7 +129,6 @@
{
writer.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
}
-
for(DN dn: config.getRetentionPolicyDNs())
{
writer.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
@@ -150,8 +136,7 @@
if(config.isAsynchronous())
{
- this.writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), writer);
+ this.writer = newAsyncWriter(writer, config);
}
else
{
@@ -224,9 +209,6 @@
config.addFileBasedErrorChangeListener(this);
}
-
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAcceptable(
FileBasedErrorLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
@@ -234,7 +216,6 @@
return isConfigurationChangeAcceptable(config, unacceptableReasons);
}
- /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
FileBasedErrorLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
@@ -290,7 +271,6 @@
return true;
}
- /** {@inheritDoc} */
@Override
public ConfigChangeResult applyConfigurationChange(FileBasedErrorLogPublisherCfg config)
{
@@ -351,18 +331,11 @@
}
}
- File logFile = getFileForPath(config.getLogFile());
- FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
-
- boolean writerAutoFlush =
- config.isAutoFlush() && !config.isAsynchronous();
-
- TextWriter currentWriter;
// Determine the writer we are using. If we were writing asynchronously,
// we need to modify the underlying writer.
+ TextWriter currentWriter;
if(writer instanceof AsynchronousTextWriter)
{
currentWriter = ((AsynchronousTextWriter)writer).getWrappedWriter();
@@ -375,40 +348,25 @@
if(currentWriter instanceof MultifileTextWriter)
{
MultifileTextWriter mfWriter = (MultifileTextWriter)currentWriter;
+ configure(mfWriter, config);
- mfWriter.setNamingPolicy(fnPolicy);
- mfWriter.setFilePermissions(perm);
- mfWriter.setAppend(config.isAppend());
- mfWriter.setAutoFlush(writerAutoFlush);
- mfWriter.setBufferSize((int)config.getBufferSize());
- mfWriter.setInterval(config.getTimeInterval());
-
- mfWriter.removeAllRetentionPolicies();
- mfWriter.removeAllRotationPolicies();
-
- for(DN dn : config.getRotationPolicyDNs())
+ if (config.isAsynchronous())
{
- mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ if (!(writer instanceof AsynchronousTextWriter))
+ {
+ // The asynchronous setting is being turned on.
+ writer = newAsyncWriter(mfWriter, config);
+ }
}
-
- for(DN dn: config.getRetentionPolicyDNs())
+ else
{
- mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
- }
-
- if(writer instanceof AsynchronousTextWriter && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter)writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (!(writer instanceof AsynchronousTextWriter) && config.isAsynchronous())
- {
- // The asynchronous setting is being turned on.
- writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ if (writer instanceof AsynchronousTextWriter)
+ {
+ // The asynchronous setting is being turned off.
+ AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
}
if (currentConfig.isAsynchronous()
@@ -431,6 +389,44 @@
return ccr;
}
+ private void configure(MultifileTextWriter mfWriter, FileBasedErrorLogPublisherCfg config) throws DirectoryException
+ {
+ FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
+
+ File logFile = getLogFile(config);
+ FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
+
+ mfWriter.setNamingPolicy(fnPolicy);
+ mfWriter.setFilePermissions(perm);
+ mfWriter.setAppend(config.isAppend());
+ mfWriter.setAutoFlush(writerAutoFlush);
+ mfWriter.setBufferSize((int) config.getBufferSize());
+ mfWriter.setInterval(config.getTimeInterval());
+
+ mfWriter.removeAllRetentionPolicies();
+ mfWriter.removeAllRotationPolicies();
+ for (DN dn : config.getRotationPolicyDNs())
+ {
+ mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ }
+ for (DN dn : config.getRetentionPolicyDNs())
+ {
+ mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
+ }
+ }
+
+ private File getLogFile(FileBasedErrorLogPublisherCfg config)
+ {
+ return getFileForPath(config.getLogFile());
+ }
+
+ private AsynchronousTextWriter newAsyncWriter(MultifileTextWriter mfWriter, FileBasedErrorLogPublisherCfg config)
+ {
+ String name = "Asynchronous Text Writer for " + config.dn();
+ return new AsynchronousTextWriter(name, config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ }
+
private void setDefaultSeverities(Set<ErrorLogPublisherCfgDefn.DefaultSeverity> defSevs)
{
defaultSeverities.clear();
@@ -451,11 +447,7 @@
defaultSeverities.add(Severity.INFORMATION);
defaultSeverities.add(Severity.NOTICE);
}
- else if (LOG_SEVERITY_NONE.equalsIgnoreCase(defaultSeverity))
- {
- // don't add any severity
- }
- else
+ else if (!LOG_SEVERITY_NONE.equalsIgnoreCase(defaultSeverity))
{
Severity errorSeverity = Severity.parseString(defSev.name());
if (errorSeverity != null)
@@ -467,7 +459,6 @@
}
}
- /** {@inheritDoc} */
@Override
public void close()
{
@@ -479,7 +470,6 @@
}
}
- /** {@inheritDoc} */
@Override
public void log(String category, Severity severity, LocalizableMessage message, Throwable exception)
{
@@ -504,7 +494,6 @@
}
}
- /** {@inheritDoc} */
@Override
public boolean isEnabledFor(String category, Severity severity)
{
@@ -516,7 +505,6 @@
return severities.contains(severity);
}
- /** {@inheritDoc} */
@Override
public DN getDN()
{
@@ -527,4 +515,3 @@
return null;
}
}
-
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextHTTPAccessLogPublisher.java b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextHTTPAccessLogPublisher.java
index e039633..ae244d7 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextHTTPAccessLogPublisher.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/loggers/TextHTTPAccessLogPublisher.java
@@ -41,13 +41,13 @@
import java.util.Set;
import org.forgerock.i18n.LocalizableMessage;
+import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.util.Utils;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.std.server.FileBasedHTTPAccessLogPublisherCfg;
import org.opends.server.core.DirectoryServer;
import org.opends.server.core.ServerContext;
-import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.types.DN;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.FilePermission;
@@ -100,40 +100,26 @@
public static TextHTTPAccessLogPublisher getStartupTextHTTPAccessPublisher(
final TextWriter writer)
{
- final TextHTTPAccessLogPublisher startupPublisher =
- new TextHTTPAccessLogPublisher();
+ final TextHTTPAccessLogPublisher startupPublisher = new TextHTTPAccessLogPublisher();
startupPublisher.writer = writer;
return startupPublisher;
}
-
-
private TextWriter writer;
private FileBasedHTTPAccessLogPublisherCfg cfg;
private List<String> logFormatFields;
private String timeStampFormat = "dd/MMM/yyyy:HH:mm:ss Z";
-
- /** {@inheritDoc} */
@Override
- public ConfigChangeResult applyConfigurationChange(
- final FileBasedHTTPAccessLogPublisherCfg config)
+ public ConfigChangeResult applyConfigurationChange(final FileBasedHTTPAccessLogPublisherCfg config)
{
final ConfigChangeResult ccr = new ConfigChangeResult();
- final File logFile = getFileForPath(config.getLogFile());
- final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- final FilePermission perm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
-
- final boolean writerAutoFlush = config.isAutoFlush()
- && !config.isAsynchronous();
-
+ // Determine the writer we are using. If we were writing asynchronously,
+ // we need to modify the underlying writer.
TextWriter currentWriter;
- // Determine the writer we are using. If we were writing
- // asynchronously, we need to modify the underlying writer.
if (writer instanceof AsynchronousTextWriter)
{
currentWriter = ((AsynchronousTextWriter) writer).getWrappedWriter();
@@ -149,64 +135,40 @@
if (currentWriter instanceof MultifileTextWriter)
{
- final MultifileTextWriter mfWriter =
- (MultifileTextWriter) currentWriter;
+ final MultifileTextWriter mfWriter = (MultifileTextWriter) currentWriter;
+ configure(mfWriter, config);
- mfWriter.setNamingPolicy(fnPolicy);
- mfWriter.setFilePermissions(perm);
- mfWriter.setAppend(config.isAppend());
- mfWriter.setAutoFlush(writerAutoFlush);
- mfWriter.setBufferSize((int) config.getBufferSize());
- mfWriter.setInterval(config.getTimeInterval());
-
- mfWriter.removeAllRetentionPolicies();
- mfWriter.removeAllRotationPolicies();
-
- for (final DN dn : config.getRotationPolicyDNs())
+ if (config.isAsynchronous())
{
- mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ if (!(writer instanceof AsynchronousTextWriter))
+ {
+ // The asynchronous setting is being turned on.
+ final AsynchronousTextWriter asyncWriter = newAsyncWriter(mfWriter, config);
+ writer = asyncWriter;
+ }
+ if (!(writer instanceof ParallelTextWriter))
+ {
+ // The asynchronous setting is being turned on.
+ final ParallelTextWriter asyncWriter = newParallelWriter(mfWriter, config);
+ writer = asyncWriter;
+ }
}
-
- for (final DN dn : config.getRetentionPolicyDNs())
+ else
{
- mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
- }
-
- if (writer instanceof AsynchronousTextWriter
- && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- final AsynchronousTextWriter asyncWriter =
- (AsynchronousTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (writer instanceof ParallelTextWriter && !config.isAsynchronous())
- {
- // The asynchronous setting is being turned off.
- final ParallelTextWriter asyncWriter = (ParallelTextWriter) writer;
- writer = mfWriter;
- asyncWriter.shutdown(false);
- }
-
- if (!(writer instanceof AsynchronousTextWriter)
- && config.isAsynchronous())
- {
- // The asynchronous setting is being turned on.
- final AsynchronousTextWriter asyncWriter = new AsynchronousTextWriter(
- "Asynchronous Text Writer for " + config.dn(),
- config.getQueueSize(), config.isAutoFlush(), mfWriter);
- writer = asyncWriter;
- }
-
- if (!(writer instanceof ParallelTextWriter) && config.isAsynchronous())
- {
- // The asynchronous setting is being turned on.
- final ParallelTextWriter asyncWriter = new ParallelTextWriter(
- "Parallel Text Writer for " + config.dn(),
- config.isAutoFlush(), mfWriter);
- writer = asyncWriter;
+ if (writer instanceof AsynchronousTextWriter)
+ {
+ // The asynchronous setting is being turned off.
+ final AsynchronousTextWriter asyncWriter = (AsynchronousTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
+ if (writer instanceof ParallelTextWriter)
+ {
+ // The asynchronous setting is being turned off.
+ final ParallelTextWriter asyncWriter = (ParallelTextWriter) writer;
+ writer = mfWriter;
+ asyncWriter.shutdown(false);
+ }
}
if (cfg.isAsynchronous() && config.isAsynchronous()
@@ -242,6 +204,50 @@
return ccr;
}
+ private void configure(MultifileTextWriter mfWriter, FileBasedHTTPAccessLogPublisherCfg config)
+ throws DirectoryException
+ {
+ final FilePermission perm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
+ final boolean writerAutoFlush = config.isAutoFlush() && !config.isAsynchronous();
+
+ final File logFile = getLogFile(config);
+ final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
+
+ mfWriter.setNamingPolicy(fnPolicy);
+ mfWriter.setFilePermissions(perm);
+ mfWriter.setAppend(config.isAppend());
+ mfWriter.setAutoFlush(writerAutoFlush);
+ mfWriter.setBufferSize((int) config.getBufferSize());
+ mfWriter.setInterval(config.getTimeInterval());
+
+ mfWriter.removeAllRetentionPolicies();
+ mfWriter.removeAllRotationPolicies();
+ for (final DN dn : config.getRotationPolicyDNs())
+ {
+ mfWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
+ }
+ for (final DN dn : config.getRetentionPolicyDNs())
+ {
+ mfWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
+ }
+ }
+
+ private File getLogFile(final FileBasedHTTPAccessLogPublisherCfg config)
+ {
+ return getFileForPath(config.getLogFile());
+ }
+
+ private ParallelTextWriter newParallelWriter(MultifileTextWriter mfWriter, FileBasedHTTPAccessLogPublisherCfg config)
+ {
+ String name = "Parallel Text Writer for " + config.dn();
+ return new ParallelTextWriter(name, config.isAutoFlush(), mfWriter);
+ }
+
+ private AsynchronousTextWriter newAsyncWriter(MultifileTextWriter mfWriter, FileBasedHTTPAccessLogPublisherCfg config)
+ {
+ String name = "Asynchronous Text Writer for " + config.dn();
+ return new AsynchronousTextWriter(name, config.getQueueSize(), config.isAutoFlush(), mfWriter);
+ }
private List<String> extractFieldsOrder(String logFormat)
{
@@ -296,25 +302,19 @@
return result;
}
- /** {@inheritDoc} */
@Override
public void initializeLogPublisher(
final FileBasedHTTPAccessLogPublisherCfg cfg, ServerContext serverContext)
throws ConfigException, InitializationException
{
- final File logFile = getFileForPath(cfg.getLogFile());
+ final File logFile = getLogFile(cfg);
final FileNamingPolicy fnPolicy = new TimeStampNaming(logFile);
try
{
- final FilePermission perm = FilePermission.decodeUNIXMode(cfg
- .getLogFilePermissions());
-
- final LogPublisherErrorHandler errorHandler =
- new LogPublisherErrorHandler(cfg.dn());
-
- final boolean writerAutoFlush = cfg.isAutoFlush()
- && !cfg.isAsynchronous();
+ final FilePermission perm = FilePermission.decodeUNIXMode(cfg.getLogFilePermissions());
+ final LogPublisherErrorHandler errorHandler = new LogPublisherErrorHandler(cfg.dn());
+ final boolean writerAutoFlush = cfg.isAutoFlush() && !cfg.isAsynchronous();
final MultifileTextWriter theWriter = new MultifileTextWriter(
"Multifile Text Writer for " + cfg.dn(),
@@ -326,7 +326,6 @@
{
theWriter.addRotationPolicy(DirectoryServer.getRotationPolicy(dn));
}
-
for (final DN dn : cfg.getRetentionPolicyDNs())
{
theWriter.addRetentionPolicy(DirectoryServer.getRetentionPolicy(dn));
@@ -336,13 +335,11 @@
{
if (cfg.getQueueSize() > 0)
{
- this.writer = new AsynchronousTextWriter("Asynchronous Text Writer for " + cfg.dn(),
- cfg.getQueueSize(), cfg.isAutoFlush(), theWriter);
+ this.writer = newAsyncWriter(theWriter, cfg);
}
else
{
- this.writer = new ParallelTextWriter("Parallel Text Writer for " + cfg.dn(),
- cfg.isAutoFlush(), theWriter);
+ this.writer = newParallelWriter(theWriter, cfg);
}
}
else
@@ -373,8 +370,6 @@
cfg.addFileBasedHTTPAccessChangeListener(this);
}
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationAcceptable(
final FileBasedHTTPAccessLogPublisherCfg configuration,
@@ -383,8 +378,6 @@
return isConfigurationChangeAcceptable(configuration, unacceptableReasons);
}
-
- /** {@inheritDoc} */
@Override
public boolean isConfigurationChangeAcceptable(
final FileBasedHTTPAccessLogPublisherCfg config,
@@ -405,12 +398,10 @@
// Make sure the permission is valid.
try
{
- final FilePermission filePerm = FilePermission.decodeUNIXMode(config
- .getLogFilePermissions());
+ final FilePermission filePerm = FilePermission.decodeUNIXMode(config.getLogFilePermissions());
if (!filePerm.isOwnerWritable())
{
- final LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config
- .getLogFilePermissions());
+ final LocalizableMessage message = ERR_CONFIG_LOGGING_INSANE_MODE.get(config.getLogFilePermissions());
unacceptableReasons.add(message);
return false;
}
@@ -424,8 +415,6 @@
return true;
}
-
- /** {@inheritDoc} */
@Override
public final void close()
{
@@ -437,14 +426,12 @@
}
}
- /** {@inheritDoc} */
@Override
public final DN getDN()
{
return cfg != null ? cfg.dn() : null;
}
- /** {@inheritDoc} */
@Override
public void logRequestInfo(HTTPRequestInfo ri)
{
@@ -484,8 +471,7 @@
}
/**
- * Appends the value to the string builder using the default separator if
- * needed.
+ * Appends the value to the string builder using the default separator if needed.
*
* @param sb
* the StringBuilder where to append.
@@ -518,5 +504,4 @@
sb.append('-');
}
}
-
}
--
Gitblit v1.10.0