From ba05c50c7fe29c955dfbd88d84b8879719a939dd Mon Sep 17 00:00:00 2001 From: Bernd Ahlers Date: Tue, 21 Oct 2014 16:57:48 +0200 Subject: [PATCH] Reformat code. --- .../java/org/graylog2/syslog4j/Syslog.java | 552 ++--- .../graylog2/syslog4j/Syslog4jVersion.java | 22 +- .../syslog4j/SyslogBackLogHandlerIF.java | 88 +- .../graylog2/syslog4j/SyslogCharSetIF.java | 25 +- .../org/graylog2/syslog4j/SyslogConfigIF.java | 137 +- .../graylog2/syslog4j/SyslogConstants.java | 288 +-- .../java/org/graylog2/syslog4j/SyslogIF.java | 107 +- .../org/graylog2/syslog4j/SyslogMain.java | 390 ++-- .../graylog2/syslog4j/SyslogMessageIF.java | 20 +- .../SyslogMessageModifierConfigIF.java | 30 +- .../syslog4j/SyslogMessageModifierIF.java | 25 +- .../syslog4j/SyslogMessageProcessorIF.java | 26 +- .../graylog2/syslog4j/SyslogPoolConfigIF.java | 102 +- .../syslog4j/SyslogRuntimeException.java | 34 +- .../syslog4j/impl/AbstractSyslog.java | 684 +++--- .../syslog4j/impl/AbstractSyslogConfig.java | 622 +++--- .../syslog4j/impl/AbstractSyslogConfigIF.java | 99 +- .../syslog4j/impl/AbstractSyslogWriter.java | 180 +- .../backlog/AbstractSyslogBackLogHandler.java | 52 +- .../backlog/NullSyslogBackLogHandler.java | 48 +- .../impl/backlog/Syslog4jBackLogHandler.java | 106 +- .../log4j/Log4jSyslogBackLogHandler.java | 250 ++- .../PrintStreamSyslogBackLogHandler.java | 104 +- .../SystemErrSyslogBackLogHandler.java | 41 +- .../SystemOutSyslogBackLogHandler.java | 41 +- .../syslog4j/impl/log4j/Syslog4jAppender.java | 106 +- .../impl/log4j/Syslog4jAppenderSkeleton.java | 542 ++--- .../impl/message/AbstractSyslogMessage.java | 154 +- .../AbstractSyslogMessageModifier.java | 110 +- .../AbstractSyslogMessageModifierConfig.java | 88 +- .../ChecksumSyslogMessageModifier.java | 179 +- .../ChecksumSyslogMessageModifierConfig.java | 82 +- ...HTMLEntityEscapeSyslogMessageModifier.java | 136 +- .../hash/HashSyslogMessageModifier.java | 224 +- .../hash/HashSyslogMessageModifierConfig.java | 116 +- .../mac/MacSyslogMessageModifier.java | 180 +- .../mac/MacSyslogMessageModifierConfig.java | 166 +- .../SequentialSyslogMessageModifier.java | 178 +- ...SequentialSyslogMessageModifierConfig.java | 128 +- .../text/PrefixSyslogMessageModifier.java | 88 +- .../text/StringCaseSyslogMessageModifier.java | 94 +- .../text/SuffixSyslogMessageModifier.java | 86 +- .../impl/message/pci/PCISyslogMessage.java | 470 ++-- .../impl/message/pci/PCISyslogMessageIF.java | 56 +- .../AbstractSyslogMessageProcessor.java | 196 +- .../processor/SyslogMessageProcessor.java | 58 +- .../StructuredSyslogMessageProcessor.java | 126 +- .../structured/StructuredSyslogMessage.java | 620 +++--- .../structured/StructuredSyslogMessageIF.java | 22 +- .../impl/multiple/MultipleSyslog.java | 264 +-- .../impl/multiple/MultipleSyslogConfig.java | 362 +-- .../syslog4j/impl/net/AbstractNetSyslog.java | 100 +- .../impl/net/AbstractNetSyslogConfig.java | 140 +- .../impl/net/AbstractNetSyslogConfigIF.java | 25 +- .../syslog4j/impl/net/tcp/TCPNetSyslog.java | 148 +- .../impl/net/tcp/TCPNetSyslogConfig.java | 248 +-- .../impl/net/tcp/TCPNetSyslogConfigIF.java | 70 +- .../impl/net/tcp/TCPNetSyslogWriter.java | 408 ++-- .../impl/net/tcp/pool/PooledTCPNetSyslog.java | 120 +- .../tcp/pool/PooledTCPNetSyslogConfig.java | 268 +-- .../impl/net/tcp/ssl/SSLTCPNetSyslog.java | 74 +- .../net/tcp/ssl/SSLTCPNetSyslogConfig.java | 134 +- .../net/tcp/ssl/SSLTCPNetSyslogConfigIF.java | 44 +- .../net/tcp/ssl/SSLTCPNetSyslogWriter.java | 34 +- .../ssl/pool/PooledSSLTCPNetSyslogConfig.java | 134 +- .../syslog4j/impl/net/udp/UDPNetSyslog.java | 160 +- .../impl/net/udp/UDPNetSyslogConfig.java | 66 +- .../impl/pool/AbstractSyslogPoolFactory.java | 130 +- .../generic/GenericSyslogPoolFactory.java | 82 +- .../syslog4j/impl/unix/UnixSyslog.java | 192 +- .../syslog4j/impl/unix/UnixSyslogConfig.java | 102 +- .../impl/unix/socket/UnixSocketSyslog.java | 232 +- .../unix/socket/UnixSocketSyslogConfig.java | 228 +- .../syslog4j/server/SyslogServer.java | 402 ++-- .../syslog4j/server/SyslogServerConfigIF.java | 84 +- .../server/SyslogServerEventHandlerIF.java | 5 +- .../syslog4j/server/SyslogServerEventIF.java | 68 +- .../syslog4j/server/SyslogServerIF.java | 38 +- .../syslog4j/server/SyslogServerMain.java | 324 +-- .../SyslogServerSessionEventHandlerIF.java | 11 +- ...SyslogServerSessionlessEventHandlerIF.java | 25 +- .../server/impl/AbstractSyslogServer.java | 578 ++--- .../impl/AbstractSyslogServerConfig.java | 154 +- .../server/impl/event/SyslogServerEvent.java | 367 +-- .../FileSyslogServerEventHandler.java | 36 +- .../PrintStreamSyslogServerEventHandler.java | 78 +- .../SystemErrSyslogServerEventHandler.java | 16 +- .../SystemOutSyslogServerEventHandler.java | 16 +- .../StructuredSyslogServerEvent.java | 210 +- .../net/AbstractNetSyslogServerConfig.java | 54 +- .../impl/net/tcp/TCPNetSyslogServer.java | 438 ++-- .../net/tcp/TCPNetSyslogServerConfig.java | 130 +- .../net/tcp/TCPNetSyslogServerConfigIF.java | 50 +- .../net/tcp/ssl/SSLTCPNetSyslogServer.java | 82 +- .../tcp/ssl/SSLTCPNetSyslogServerConfig.java | 88 +- .../ssl/SSLTCPNetSyslogServerConfigIF.java | 42 +- .../impl/net/udp/UDPNetSyslogServer.java | 164 +- .../net/udp/UDPNetSyslogServerConfig.java | 52 +- .../org/graylog2/syslog4j/util/Base64.java | 1963 ++++++++--------- .../syslog4j/util/OSDetectUtility.java | 138 +- .../graylog2/syslog4j/util/SyslogUtility.java | 435 ++-- 101 files changed, 9165 insertions(+), 8926 deletions(-) diff --git a/src/main/java/org/graylog2/syslog4j/Syslog.java b/src/main/java/org/graylog2/syslog4j/Syslog.java index cf5269f..38a706d 100644 --- a/src/main/java/org/graylog2/syslog4j/Syslog.java +++ b/src/main/java/org/graylog2/syslog4j/Syslog.java @@ -14,305 +14,305 @@ import org.graylog2.syslog4j.util.SyslogUtility; /** * This class provides a Singleton interface for Syslog4j client implementations. - * + *

*

Usage examples:

- * + *

* Direct * 

  * Syslog.getInstance("udp").info("log message");
  *
- * + *

* Via Instance * 

  * SyslogIF syslog = Syslog.getInstance("udp");
  * syslog.info();
  *
- * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: Syslog.java,v 1.23 2011/01/23 20:49:12 cvs Exp $ */ public final class Syslog implements SyslogConstants { - private static final long serialVersionUID = -4662318148650646144L; - - private static boolean SUPPRESS_RUNTIME_EXCEPTIONS = false; - - protected static final Map instances = new Hashtable(); - - static { - initialize(); - } - - /** - * Syslog is a singleton. - */ - private Syslog() { - // - } - - /** - * @return Returns the current version identifier for Syslog4j. - */ - public static final String getVersion() { - return Syslog4jVersion.VERSION; - } - - /** - * @param suppress - true to suppress throwing SyslogRuntimeException in many methods of this class, false to throw exceptions (default) - */ - public static void setSuppressRuntimeExceptions(boolean suppress) { - SUPPRESS_RUNTIME_EXCEPTIONS = suppress; - } - - /** - * @return Returns whether or not to suppress throwing SyslogRuntimeException in many methods of this class. - */ - public static boolean getSuppressRuntimeExceptions() { - return SUPPRESS_RUNTIME_EXCEPTIONS; - } - - /** - * Throws SyslogRuntimeException unless it has been suppressed via setSuppressRuntimeException(boolean). - * - * @param message - * @throws SyslogRuntimeException - */ - private static void throwRuntimeException(String message) throws SyslogRuntimeException { - if (SUPPRESS_RUNTIME_EXCEPTIONS) { - return; - - } else { - throw new SyslogRuntimeException(message.toString()); - } - } + private static final long serialVersionUID = -4662318148650646144L; - /** - * Use getInstance(protocol) as the starting point for Syslog4j. - * - * @param protocol - the Syslog protocol to use, e.g. "udp", "tcp", "unix_syslog", "unix_socket", or a custom protocol - * @return Returns an instance of SyslogIF. - * @throws SyslogRuntimeException - */ - public static final SyslogIF getInstance(String protocol) throws SyslogRuntimeException { - String _protocol = protocol.toLowerCase(); - - if (instances.containsKey(_protocol)) { - return (SyslogIF) instances.get(_protocol); - - } else { - StringBuffer message = new StringBuffer("Syslog protocol \"" + protocol + "\" not defined; call Syslogger.createSyslogInstance(protocol,config) first"); - - if (instances.size() > 0) { - message.append(" or use one of the following instances: "); - - Iterator i = instances.keySet().iterator(); - while (i.hasNext()) { - String k = (String) i.next(); - - message.append(k); - if (i.hasNext()) { - message.append(' '); - } - } - } - - throwRuntimeException(message.toString()); - return null; - } - } - - /** - * Use createInstance(protocol,config) to create your own Syslog instance. - * - *

First, create an implementation of SyslogConfigIF, such as UdpNetSyslogConfig.

- * - *

Second, configure that configuration instance.

- * - *

Third, call createInstance(protocol,config) using a short & simple - * String for the protocol argument.

- * - *

Fourth, either use the returned instance of SyslogIF, or in later code - * call getInstance(protocol) with the protocol chosen in the previous step.

- * - * @param protocol - * @param config - * @return Returns an instance of SyslogIF. - * @throws SyslogRuntimeException - */ - public static final SyslogIF createInstance(String protocol, SyslogConfigIF config) throws SyslogRuntimeException { - if (protocol == null || "".equals(protocol.trim())) { - throwRuntimeException("Instance protocol cannot be null or empty"); - return null; - } - - if (config == null) { - throwRuntimeException("SyslogConfig cannot be null"); - return null; - } - - String syslogProtocol = protocol.toLowerCase(); - - SyslogIF syslog = null; - - synchronized(instances) { - if (instances.containsKey(syslogProtocol)) { - throwRuntimeException("Syslog protocol \"" + protocol + "\" already defined"); - return null; - } - - try { - Class syslogClass = config.getSyslogClass(); - - syslog = (SyslogIF) syslogClass.newInstance(); - - } catch (ClassCastException cse) { - if (!config.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(cse); - - } else { - return null; - } - - } catch (IllegalAccessException iae) { - if (!config.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(iae); - - } else { - return null; - } - - } catch (InstantiationException ie) { - if (!config.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(ie); - - } else { - return null; - } - } - - syslog.initialize(syslogProtocol,config); - - instances.put(syslogProtocol,syslog); - } + private static boolean SUPPRESS_RUNTIME_EXCEPTIONS = false; - return syslog; - } + protected static final Map instances = new Hashtable(); - /** - * initialize() sets up the default TCP and UDP Syslog protocols, as - * well as UNIX_SYSLOG and UNIX_SOCKET (if running on a Unix-based system). - */ - public synchronized static final void initialize() { - createInstance(UDP,new UDPNetSyslogConfig()); - createInstance(TCP,new TCPNetSyslogConfig()); - - if (OSDetectUtility.isUnix() && SyslogUtility.isClassExists(JNA_NATIVE_CLASS)) { - createInstance(UNIX_SYSLOG,new UnixSyslogConfig()); - createInstance(UNIX_SOCKET,new UnixSocketSyslogConfig()); - } - } - - /** - * @param protocol - Syslog protocol - * @return Returns whether the protocol has been previously defined. - */ - public static final boolean exists(String protocol) { - if (protocol == null || "".equals(protocol.trim())) { - return false; - } - - return instances.containsKey(protocol.toLowerCase()); - } - - /** - * shutdown() gracefully shuts down all defined Syslog protocols, - * which includes flushing all queues and connections and finally - * clearing all instances (including those initialized by default). - */ - public synchronized static final void shutdown() { - Set protocols = instances.keySet(); - - if (protocols.size() > 0) { - Iterator i = protocols.iterator(); - - SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); - - while(i.hasNext()) { - String protocol = (String) i.next(); - - SyslogIF syslog = (SyslogIF) instances.get(protocol); - - syslog.shutdown(); - } + static { + initialize(); + } - instances.clear(); - } - } + /** + * Syslog is a singleton. + */ + private Syslog() { + // + } - /** - * destroyInstance() gracefully shuts down the specified Syslog protocol and - * removes the instance from Syslog4j. - * - * @param protocol - the Syslog protocol to destroy - * @throws SyslogRuntimeException - */ - public synchronized static final void destroyInstance(String protocol) throws SyslogRuntimeException { - if (protocol == null || "".equals(protocol.trim())) { - return; - } - - String _protocol = protocol.toLowerCase(); - - if (instances.containsKey(_protocol)) { - SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); - - SyslogIF syslog = (SyslogIF) instances.get(_protocol); + /** + * @return Returns the current version identifier for Syslog4j. + */ + public static final String getVersion() { + return Syslog4jVersion.VERSION; + } - try { - syslog.shutdown(); - - } finally { - instances.remove(_protocol); - } - - } else { - throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead"); - return; - } - } + /** + * @param suppress - true to suppress throwing SyslogRuntimeException in many methods of this class, false to throw exceptions (default) + */ + public static void setSuppressRuntimeExceptions(boolean suppress) { + SUPPRESS_RUNTIME_EXCEPTIONS = suppress; + } - /** - * destroyInstance() gracefully shuts down the specified Syslog instance and - * removes it from Syslog4j. - * - * @param syslog - the Syslog instance to destroy - * @throws SyslogRuntimeException - */ - public synchronized static final void destroyInstance(SyslogIF syslog) throws SyslogRuntimeException { - if (syslog == null) { - return; - } - - String protocol = syslog.getProtocol().toLowerCase(); - - if (instances.containsKey(protocol)) { - try { - syslog.shutdown(); - - } finally { - instances.remove(protocol); - } - - } else { - throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead"); - return; - } - } + /** + * @return Returns whether or not to suppress throwing SyslogRuntimeException in many methods of this class. + */ + public static boolean getSuppressRuntimeExceptions() { + return SUPPRESS_RUNTIME_EXCEPTIONS; + } - public static void main(String[] args) throws Exception { - SyslogMain.main(args); - } + /** + * Throws SyslogRuntimeException unless it has been suppressed via setSuppressRuntimeException(boolean). + * + * @param message + * @throws SyslogRuntimeException + */ + private static void throwRuntimeException(String message) throws SyslogRuntimeException { + if (SUPPRESS_RUNTIME_EXCEPTIONS) { + return; + + } else { + throw new SyslogRuntimeException(message.toString()); + } + } + + /** + * Use getInstance(protocol) as the starting point for Syslog4j. + * + * @param protocol - the Syslog protocol to use, e.g. "udp", "tcp", "unix_syslog", "unix_socket", or a custom protocol + * @return Returns an instance of SyslogIF. + * @throws SyslogRuntimeException + */ + public static final SyslogIF getInstance(String protocol) throws SyslogRuntimeException { + String _protocol = protocol.toLowerCase(); + + if (instances.containsKey(_protocol)) { + return (SyslogIF) instances.get(_protocol); + + } else { + StringBuffer message = new StringBuffer("Syslog protocol \"" + protocol + "\" not defined; call Syslogger.createSyslogInstance(protocol,config) first"); + + if (instances.size() > 0) { + message.append(" or use one of the following instances: "); + + Iterator i = instances.keySet().iterator(); + while (i.hasNext()) { + String k = (String) i.next(); + + message.append(k); + if (i.hasNext()) { + message.append(' '); + } + } + } + + throwRuntimeException(message.toString()); + return null; + } + } + + /** + * Use createInstance(protocol,config) to create your own Syslog instance. + *

+ *

First, create an implementation of SyslogConfigIF, such as UdpNetSyslogConfig.

+ *

+ *

Second, configure that configuration instance.

+ *

+ *

Third, call createInstance(protocol,config) using a short & simple + * String for the protocol argument.

+ *

+ *

Fourth, either use the returned instance of SyslogIF, or in later code + * call getInstance(protocol) with the protocol chosen in the previous step.

+ * + * @param protocol + * @param config + * @return Returns an instance of SyslogIF. + * @throws SyslogRuntimeException + */ + public static final SyslogIF createInstance(String protocol, SyslogConfigIF config) throws SyslogRuntimeException { + if (protocol == null || "".equals(protocol.trim())) { + throwRuntimeException("Instance protocol cannot be null or empty"); + return null; + } + + if (config == null) { + throwRuntimeException("SyslogConfig cannot be null"); + return null; + } + + String syslogProtocol = protocol.toLowerCase(); + + SyslogIF syslog = null; + + synchronized (instances) { + if (instances.containsKey(syslogProtocol)) { + throwRuntimeException("Syslog protocol \"" + protocol + "\" already defined"); + return null; + } + + try { + Class syslogClass = config.getSyslogClass(); + + syslog = (SyslogIF) syslogClass.newInstance(); + + } catch (ClassCastException cse) { + if (!config.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(cse); + + } else { + return null; + } + + } catch (IllegalAccessException iae) { + if (!config.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(iae); + + } else { + return null; + } + + } catch (InstantiationException ie) { + if (!config.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(ie); + + } else { + return null; + } + } + + syslog.initialize(syslogProtocol, config); + + instances.put(syslogProtocol, syslog); + } + + return syslog; + } + + /** + * initialize() sets up the default TCP and UDP Syslog protocols, as + * well as UNIX_SYSLOG and UNIX_SOCKET (if running on a Unix-based system). + */ + public synchronized static final void initialize() { + createInstance(UDP, new UDPNetSyslogConfig()); + createInstance(TCP, new TCPNetSyslogConfig()); + + if (OSDetectUtility.isUnix() && SyslogUtility.isClassExists(JNA_NATIVE_CLASS)) { + createInstance(UNIX_SYSLOG, new UnixSyslogConfig()); + createInstance(UNIX_SOCKET, new UnixSocketSyslogConfig()); + } + } + + /** + * @param protocol - Syslog protocol + * @return Returns whether the protocol has been previously defined. + */ + public static final boolean exists(String protocol) { + if (protocol == null || "".equals(protocol.trim())) { + return false; + } + + return instances.containsKey(protocol.toLowerCase()); + } + + /** + * shutdown() gracefully shuts down all defined Syslog protocols, + * which includes flushing all queues and connections and finally + * clearing all instances (including those initialized by default). + */ + public synchronized static final void shutdown() { + Set protocols = instances.keySet(); + + if (protocols.size() > 0) { + Iterator i = protocols.iterator(); + + SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); + + while (i.hasNext()) { + String protocol = (String) i.next(); + + SyslogIF syslog = (SyslogIF) instances.get(protocol); + + syslog.shutdown(); + } + + instances.clear(); + } + } + + /** + * destroyInstance() gracefully shuts down the specified Syslog protocol and + * removes the instance from Syslog4j. + * + * @param protocol - the Syslog protocol to destroy + * @throws SyslogRuntimeException + */ + public synchronized static final void destroyInstance(String protocol) throws SyslogRuntimeException { + if (protocol == null || "".equals(protocol.trim())) { + return; + } + + String _protocol = protocol.toLowerCase(); + + if (instances.containsKey(_protocol)) { + SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); + + SyslogIF syslog = (SyslogIF) instances.get(_protocol); + + try { + syslog.shutdown(); + + } finally { + instances.remove(_protocol); + } + + } else { + throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead"); + return; + } + } + + /** + * destroyInstance() gracefully shuts down the specified Syslog instance and + * removes it from Syslog4j. + * + * @param syslog - the Syslog instance to destroy + * @throws SyslogRuntimeException + */ + public synchronized static final void destroyInstance(SyslogIF syslog) throws SyslogRuntimeException { + if (syslog == null) { + return; + } + + String protocol = syslog.getProtocol().toLowerCase(); + + if (instances.containsKey(protocol)) { + try { + syslog.shutdown(); + + } finally { + instances.remove(protocol); + } + + } else { + throwRuntimeException("Cannot destroy protocol \"" + protocol + "\" instance; call shutdown instead"); + return; + } + } + + public static void main(String[] args) throws Exception { + SyslogMain.main(args); + } } diff --git a/src/main/java/org/graylog2/syslog4j/Syslog4jVersion.java b/src/main/java/org/graylog2/syslog4j/Syslog4jVersion.java index ff1a977..02ea66a 100644 --- a/src/main/java/org/graylog2/syslog4j/Syslog4jVersion.java +++ b/src/main/java/org/graylog2/syslog4j/Syslog4jVersion.java @@ -1,16 +1,16 @@ package org.graylog2.syslog4j; /** -* Syslog4jVersion provides a unique version identifier that is created during -* the build process. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: Syslog4jVersion.java,v 1.2 2008/10/28 01:07:06 cvs Exp $ -*/ + * Syslog4jVersion provides a unique version identifier that is created during + * the build process. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: Syslog4jVersion.java,v 1.2 2008/10/28 01:07:06 cvs Exp $ + */ public final class Syslog4jVersion { - public static final String VERSION = "Syslog4j-graylog2 0.9.48 kroepke"; + public static final String VERSION = "Syslog4j-graylog2 0.9.48 kroepke"; } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogBackLogHandlerIF.java b/src/main/java/org/graylog2/syslog4j/SyslogBackLogHandlerIF.java index 95f9864..287f360 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogBackLogHandlerIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogBackLogHandlerIF.java @@ -1,51 +1,51 @@ package org.graylog2.syslog4j; /** -* SyslogBackLogHandlerIF provides a last-chance mechanism to log messages that fail -* (for whatever reason) within the rest of Syslog. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -*

Implementing the down(SyslogIF) method is an excellent way to add some sort of notification to -* your application when a Syslog service is unavailable.

-* -*

Implementing the up(SyslogIF) method can be used to notify your application when a Syslog -* service has returned.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogBackLogHandlerIF.java,v 1.2 2009/01/28 15:13:52 cvs Exp $ -*/ + * SyslogBackLogHandlerIF provides a last-chance mechanism to log messages that fail + * (for whatever reason) within the rest of Syslog. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ *

+ *

Implementing the down(SyslogIF) method is an excellent way to add some sort of notification to + * your application when a Syslog service is unavailable.

+ *

+ *

Implementing the up(SyslogIF) method can be used to notify your application when a Syslog + * service has returned.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogBackLogHandlerIF.java,v 1.2 2009/01/28 15:13:52 cvs Exp $ + */ public interface SyslogBackLogHandlerIF { - /** - * Implement initialize() to handle one-time set-up for this backLog handler. - * - * @throws SyslogRuntimeException - */ - public void initialize() throws SyslogRuntimeException; - - /** - * Implement down(syslog,reason) to notify/log when the syslog protocol is unavailable. - * - * @param syslog - SyslogIF instance causing this down condition - * @param reason - reason given for the down condition - */ - public void down(SyslogIF syslog, String reason); + /** + * Implement initialize() to handle one-time set-up for this backLog handler. + * + * @throws SyslogRuntimeException + */ + public void initialize() throws SyslogRuntimeException; - /** - * Implement up(syslog) to notify/log when the syslog protocol becomes available after a down condition. - * - * @param syslog - SyslogIF instance which is now available - */ - public void up(SyslogIF syslog); + /** + * Implement down(syslog,reason) to notify/log when the syslog protocol is unavailable. + * + * @param syslog - SyslogIF instance causing this down condition + * @param reason - reason given for the down condition + */ + public void down(SyslogIF syslog, String reason); - /** - * @param syslog - SyslogIF instance which cannot handle this log event - * @param level - message level - * @param message - message (in String form) - * @param reason - reason given for why this message could not be handled - * @throws SyslogRuntimeException - throwing this Exception activates the next backlogHandler in the chain - */ - public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException; + /** + * Implement up(syslog) to notify/log when the syslog protocol becomes available after a down condition. + * + * @param syslog - SyslogIF instance which is now available + */ + public void up(SyslogIF syslog); + + /** + * @param syslog - SyslogIF instance which cannot handle this log event + * @param level - message level + * @param message - message (in String form) + * @param reason - reason given for why this message could not be handled + * @throws SyslogRuntimeException - throwing this Exception activates the next backlogHandler in the chain + */ + public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException; } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogCharSetIF.java b/src/main/java/org/graylog2/syslog4j/SyslogCharSetIF.java index 77a5900..cf684a3 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogCharSetIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogCharSetIF.java @@ -3,17 +3,18 @@ package org.graylog2.syslog4j; import java.io.Serializable; /** -* SyslogCharSetIF provides control of the encoding character set within -* several class of Syslog4j. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogCharSetIF.java,v 1.3 2008/11/07 15:15:41 cvs Exp $ -*/ + * SyslogCharSetIF provides control of the encoding character set within + * several class of Syslog4j. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogCharSetIF.java,v 1.3 2008/11/07 15:15:41 cvs Exp $ + */ public interface SyslogCharSetIF extends Serializable { - public String getCharSet(); - public void setCharSet(String charSet); + public String getCharSet(); + + public void setCharSet(String charSet); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogConfigIF.java b/src/main/java/org/graylog2/syslog4j/SyslogConfigIF.java index 1fd8152..71c3aa8 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogConfigIF.java @@ -1,69 +1,90 @@ package org.graylog2.syslog4j; /** -* SyslogConfigIF provides a common, extensible configuration interface for all -* implementations of SyslogIF. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogConfigIF.java,v 1.19 2010/11/28 04:15:18 cvs Exp $ -*/ + * SyslogConfigIF provides a common, extensible configuration interface for all + * implementations of SyslogIF. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogConfigIF.java,v 1.19 2010/11/28 04:15:18 cvs Exp $ + */ public interface SyslogConfigIF extends SyslogConstants, SyslogCharSetIF { - public Class getSyslogClass(); - - public int getFacility(); - public void setFacility(int facility); - public void setFacility(String facilityName); - - public int getPort(); - public void setPort(int port) throws SyslogRuntimeException; + public Class getSyslogClass(); - public String getLocalName(); - public void setLocalName(String localName) throws SyslogRuntimeException; + public int getFacility(); - public String getHost(); - public void setHost(String host) throws SyslogRuntimeException; - - public String getIdent(); - public void setIdent(String ident); - - public String getCharSet(); - public void setCharSet(String charSet); - - public boolean isIncludeIdentInMessageModifier(); - public void setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize); + public void setFacility(int facility); - public boolean isThrowExceptionOnInitialize(); - public void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize); + public void setFacility(String facilityName); - public boolean isThrowExceptionOnWrite(); - public void setThrowExceptionOnWrite(boolean throwExceptionOnWrite); + public int getPort(); - public boolean isSendLocalTimestamp(); - public void setSendLocalTimestamp(boolean sendLocalTimestamp); - - public boolean isSendLocalName(); - public void setSendLocalName(boolean sendLocalName); - - public boolean isTruncateMessage(); - public void setTruncateMessage(boolean truncateMessage); - - public boolean isUseStructuredData(); - public void setUseStructuredData(boolean useStructuredData); - - public int getMaxMessageLength(); - public void setMaxMessageLength(int maxMessageLength); - - public void addMessageModifier(SyslogMessageModifierIF messageModifier); - public void insertMessageModifier(int index, SyslogMessageModifierIF messageModifier); - public void removeMessageModifier(SyslogMessageModifierIF messageModifier); - public void removeAllMessageModifiers(); + public void setPort(int port) throws SyslogRuntimeException; - public void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler); - public void insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler); - public void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler); - public void removeAllBackLogHandlers(); + public String getLocalName(); + + public void setLocalName(String localName) throws SyslogRuntimeException; + + public String getHost(); + + public void setHost(String host) throws SyslogRuntimeException; + + public String getIdent(); + + public void setIdent(String ident); + + public String getCharSet(); + + public void setCharSet(String charSet); + + public boolean isIncludeIdentInMessageModifier(); + + public void setIncludeIdentInMessageModifier(boolean throwExceptionOnInitialize); + + public boolean isThrowExceptionOnInitialize(); + + public void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize); + + public boolean isThrowExceptionOnWrite(); + + public void setThrowExceptionOnWrite(boolean throwExceptionOnWrite); + + public boolean isSendLocalTimestamp(); + + public void setSendLocalTimestamp(boolean sendLocalTimestamp); + + public boolean isSendLocalName(); + + public void setSendLocalName(boolean sendLocalName); + + public boolean isTruncateMessage(); + + public void setTruncateMessage(boolean truncateMessage); + + public boolean isUseStructuredData(); + + public void setUseStructuredData(boolean useStructuredData); + + public int getMaxMessageLength(); + + public void setMaxMessageLength(int maxMessageLength); + + public void addMessageModifier(SyslogMessageModifierIF messageModifier); + + public void insertMessageModifier(int index, SyslogMessageModifierIF messageModifier); + + public void removeMessageModifier(SyslogMessageModifierIF messageModifier); + + public void removeAllMessageModifiers(); + + public void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler); + + public void insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler); + + public void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler); + + public void removeAllBackLogHandlers(); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogConstants.java b/src/main/java/org/graylog2/syslog4j/SyslogConstants.java index ac95c68..014bf16 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogConstants.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogConstants.java @@ -3,162 +3,162 @@ package org.graylog2.syslog4j; import java.io.Serializable; /** -* SyslogConstants provides several global constant values for several -* classes within Syslog4j. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogConstants.java,v 1.33 2011/01/11 05:11:13 cvs Exp $ -*/ + * SyslogConstants provides several global constant values for several + * classes within Syslog4j. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogConstants.java,v 1.33 2011/01/11 05:11:13 cvs Exp $ + */ public interface SyslogConstants extends Serializable { - public static final String SYSLOG_PATH_DEFAULT = "/dev/log"; - public static final String SYSLOG_HOST_DEFAULT = "localhost"; - public static final int SYSLOG_PORT_DEFAULT = 514; - public static final int SYSLOG_BUFFER_SIZE = 1024; - public static final int SERVER_SOCKET_BACKLOG_DEFAULT = 50; - - public static final String SYSLOG_DATEFORMAT = "MMM dd HH:mm:ss "; - - public static final String STRUCTURED_DATA_NILVALUE = "-"; - public static final String STRUCTURED_DATA_EMPTY_VALUE = "[0@0]"; + public static final String SYSLOG_PATH_DEFAULT = "/dev/log"; + public static final String SYSLOG_HOST_DEFAULT = "localhost"; + public static final int SYSLOG_PORT_DEFAULT = 514; + public static final int SYSLOG_BUFFER_SIZE = 1024; + public static final int SERVER_SOCKET_BACKLOG_DEFAULT = 50; - public static final String CHAR_SET_DEFAULT = "UTF-8"; + public static final String SYSLOG_DATEFORMAT = "MMM dd HH:mm:ss "; - public static final byte[] LF = "\n".getBytes(); - public static final byte[] CRLF = "\r\n".getBytes(); - - public static final byte[] TCP_DELIMITER_SEQUENCE_DEFAULT = LF; - - public static final boolean THREADED_DEFAULT = true; - public static final long THREAD_LOOP_INTERVAL_DEFAULT = 500; + public static final String STRUCTURED_DATA_NILVALUE = "-"; + public static final String STRUCTURED_DATA_EMPTY_VALUE = "[0@0]"; - public static final boolean SEND_LOCAL_NAME_DEFAULT = true; - public static final boolean SEND_LOCAL_TIMESTAMP_DEFAULT = true; - public static final boolean CACHE_HOST_ADDRESS_DEFAULT = true; - - public static final int MAX_MESSAGE_LENGTH_DEFAULT = 1024; - - public static final boolean INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT = false; - public static final boolean THROW_EXCEPTION_ON_INITIALIZE_DEFAULT = true; - public static final boolean THROW_EXCEPTION_ON_WRITE_DEFAULT = false; - public static final boolean USE_STRUCTURED_DATA_DEFAULT = false; - public static final String STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE = "unknown"; - public static final String STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE = STRUCTURED_DATA_NILVALUE; - - public static final boolean USE_DAEMON_THREAD_DEFAULT = true; - public static final int THREAD_PRIORITY_DEFAULT = -1; - - public static final boolean TRUNCATE_MESSAGE_DEFAULT = false; - - public static final String SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT = "..."; - public static final String SPLIT_MESSAGE_END_TEXT_DEFAULT = "..."; + public static final String CHAR_SET_DEFAULT = "UTF-8"; - public static final String SEND_LOCAL_NAME_DEFAULT_VALUE = "unknown"; + public static final byte[] LF = "\n".getBytes(); + public static final byte[] CRLF = "\r\n".getBytes(); - public static final String TCP = "tcp"; - public static final String UDP = "udp"; - public static final String UNIX_SYSLOG = "unix_syslog"; - public static final String UNIX_SOCKET = "unix_socket"; - - public static final boolean TCP_PERSISTENT_CONNECTION_DEFAULT = true; - public static final boolean TCP_SO_LINGER_DEFAULT = true; - public static final int TCP_SO_LINGER_SECONDS_DEFAULT = 1; - public static final boolean TCP_KEEP_ALIVE_DEFAULT = true; - public static final boolean TCP_REUSE_ADDRESS_DEFAULT = true; - public static final boolean TCP_SET_BUFFER_SIZE_DEFAULT = true; - public static final int TCP_FRESH_CONNECTION_INTERVAL_DEFAULT = -1; - - public static final int TCP_MAX_ACTIVE_SOCKETS_DEFAULT = 0; - public static final byte TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT = 0; + public static final byte[] TCP_DELIMITER_SEQUENCE_DEFAULT = LF; - public static final int FACILITY_KERN = 0; - public static final int FACILITY_USER = 1<<3; - public static final int FACILITY_MAIL = 2<<3; - public static final int FACILITY_DAEMON = 3<<3; - public static final int FACILITY_AUTH = 4<<3; - public static final int FACILITY_SYSLOG = 5<<3; + public static final boolean THREADED_DEFAULT = true; + public static final long THREAD_LOOP_INTERVAL_DEFAULT = 500; - public static final int FACILITY_LPR = 6<<3; - public static final int FACILITY_NEWS = 7<<3; - public static final int FACILITY_UUCP = 8<<3; - public static final int FACILITY_CRON = 9<<3; - public static final int FACILITY_AUTHPRIV = 10<<3; - public static final int FACILITY_FTP = 11<<3; + public static final boolean SEND_LOCAL_NAME_DEFAULT = true; + public static final boolean SEND_LOCAL_TIMESTAMP_DEFAULT = true; + public static final boolean CACHE_HOST_ADDRESS_DEFAULT = true; - public static final int FACILITY_LOCAL0 = 16<<3; - public static final int FACILITY_LOCAL1 = 17<<3; - public static final int FACILITY_LOCAL2 = 18<<3; - public static final int FACILITY_LOCAL3 = 19<<3; - public static final int FACILITY_LOCAL4 = 20<<3; - public static final int FACILITY_LOCAL5 = 21<<3; - public static final int FACILITY_LOCAL6 = 22<<3; - public static final int FACILITY_LOCAL7 = 23<<3; + public static final int MAX_MESSAGE_LENGTH_DEFAULT = 1024; - public static final int SYSLOG_FACILITY_DEFAULT = FACILITY_USER; + public static final boolean INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT = false; + public static final boolean THROW_EXCEPTION_ON_INITIALIZE_DEFAULT = true; + public static final boolean THROW_EXCEPTION_ON_WRITE_DEFAULT = false; + public static final boolean USE_STRUCTURED_DATA_DEFAULT = false; + public static final String STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE = "unknown"; + public static final String STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE = STRUCTURED_DATA_NILVALUE; - public static final int LEVEL_DEBUG = 7; - public static final int LEVEL_INFO = 6; - public static final int LEVEL_NOTICE = 5; - public static final int LEVEL_WARN = 4; - public static final int LEVEL_ERROR = 3; - public static final int LEVEL_CRITICAL = 2; - public static final int LEVEL_ALERT = 1; - public static final int LEVEL_EMERGENCY = 0; - - public static final int OPTION_NONE = 0; - public static final int OPTION_LOG_CONS = 1; - public static final int OPTION_LOG_NDELAY = 2; - public static final int OPTION_LOG_NOWAIT = 4; - public static final int OPTION_LOG_ODELAY = 8; - public static final int OPTION_LOG_PERROR = 16; - public static final int OPTION_LOG_PID = 32; + public static final boolean USE_DAEMON_THREAD_DEFAULT = true; + public static final int THREAD_PRIORITY_DEFAULT = -1; - public static final int SOCK_STREAM = 1; - public static final int SOCK_DGRAM = 2; + public static final boolean TRUNCATE_MESSAGE_DEFAULT = false; - public static final short AF_UNIX = 1; - - public static final int WRITE_RETRIES_DEFAULT = 2; - public static final int MAX_SHUTDOWN_WAIT_DEFAULT = 30000; - public static final long SHUTDOWN_INTERVAL = 100; - public static final int MAX_QUEUE_SIZE_DEFAULT = -1; - - public static final long SERVER_SHUTDOWN_WAIT_DEFAULT = 500; - - public static final String SYSLOG_LIBRARY_DEFAULT = "c"; - - public static final int SYSLOG_SOCKET_TYPE_DEFAULT = SOCK_DGRAM; - public static final short SYSLOG_SOCKET_FAMILY_DEFAULT = AF_UNIX; - public static final String SYSLOG_SOCKET_LIBRARY_DEFAULT = "c"; - public static final int SYSLOG_SOCKET_PROTOCOL_DEFAULT = 0; - public static final String SYSLOG_SOCKET_PATH_DEFAULT = "/dev/log"; - - public static final String JNA_NATIVE_CLASS = "com.sun.jna.Native"; - - public static final String IDENT_SUFFIX_DEFAULT = ": "; - - public static final String SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT = " {"; - public static final String SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT = "}"; + public static final String SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT = "..."; + public static final String SPLIT_MESSAGE_END_TEXT_DEFAULT = "..."; - public static final String SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT = " #"; - public static final String SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT = ""; - public static final long SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT = 0; - public static final long SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT = 9999; - public static final char SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT = '0'; - public static final boolean SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT = true; - - public static final int SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT = 4; - public static final int SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT = 4; - public static final int SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT = 1000; - public static final int SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT = 0; - public static final int SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT = 4; - public static final int SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT = 0; - public static final int SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT = 0; - public static final int SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT = 0; - public static final boolean SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT = false; - public static final boolean SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT = false; - public static final boolean SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT = false; + public static final String SEND_LOCAL_NAME_DEFAULT_VALUE = "unknown"; + + public static final String TCP = "tcp"; + public static final String UDP = "udp"; + public static final String UNIX_SYSLOG = "unix_syslog"; + public static final String UNIX_SOCKET = "unix_socket"; + + public static final boolean TCP_PERSISTENT_CONNECTION_DEFAULT = true; + public static final boolean TCP_SO_LINGER_DEFAULT = true; + public static final int TCP_SO_LINGER_SECONDS_DEFAULT = 1; + public static final boolean TCP_KEEP_ALIVE_DEFAULT = true; + public static final boolean TCP_REUSE_ADDRESS_DEFAULT = true; + public static final boolean TCP_SET_BUFFER_SIZE_DEFAULT = true; + public static final int TCP_FRESH_CONNECTION_INTERVAL_DEFAULT = -1; + + public static final int TCP_MAX_ACTIVE_SOCKETS_DEFAULT = 0; + public static final byte TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT = 0; + + public static final int FACILITY_KERN = 0; + public static final int FACILITY_USER = 1 << 3; + public static final int FACILITY_MAIL = 2 << 3; + public static final int FACILITY_DAEMON = 3 << 3; + public static final int FACILITY_AUTH = 4 << 3; + public static final int FACILITY_SYSLOG = 5 << 3; + + public static final int FACILITY_LPR = 6 << 3; + public static final int FACILITY_NEWS = 7 << 3; + public static final int FACILITY_UUCP = 8 << 3; + public static final int FACILITY_CRON = 9 << 3; + public static final int FACILITY_AUTHPRIV = 10 << 3; + public static final int FACILITY_FTP = 11 << 3; + + public static final int FACILITY_LOCAL0 = 16 << 3; + public static final int FACILITY_LOCAL1 = 17 << 3; + public static final int FACILITY_LOCAL2 = 18 << 3; + public static final int FACILITY_LOCAL3 = 19 << 3; + public static final int FACILITY_LOCAL4 = 20 << 3; + public static final int FACILITY_LOCAL5 = 21 << 3; + public static final int FACILITY_LOCAL6 = 22 << 3; + public static final int FACILITY_LOCAL7 = 23 << 3; + + public static final int SYSLOG_FACILITY_DEFAULT = FACILITY_USER; + + public static final int LEVEL_DEBUG = 7; + public static final int LEVEL_INFO = 6; + public static final int LEVEL_NOTICE = 5; + public static final int LEVEL_WARN = 4; + public static final int LEVEL_ERROR = 3; + public static final int LEVEL_CRITICAL = 2; + public static final int LEVEL_ALERT = 1; + public static final int LEVEL_EMERGENCY = 0; + + public static final int OPTION_NONE = 0; + public static final int OPTION_LOG_CONS = 1; + public static final int OPTION_LOG_NDELAY = 2; + public static final int OPTION_LOG_NOWAIT = 4; + public static final int OPTION_LOG_ODELAY = 8; + public static final int OPTION_LOG_PERROR = 16; + public static final int OPTION_LOG_PID = 32; + + public static final int SOCK_STREAM = 1; + public static final int SOCK_DGRAM = 2; + + public static final short AF_UNIX = 1; + + public static final int WRITE_RETRIES_DEFAULT = 2; + public static final int MAX_SHUTDOWN_WAIT_DEFAULT = 30000; + public static final long SHUTDOWN_INTERVAL = 100; + public static final int MAX_QUEUE_SIZE_DEFAULT = -1; + + public static final long SERVER_SHUTDOWN_WAIT_DEFAULT = 500; + + public static final String SYSLOG_LIBRARY_DEFAULT = "c"; + + public static final int SYSLOG_SOCKET_TYPE_DEFAULT = SOCK_DGRAM; + public static final short SYSLOG_SOCKET_FAMILY_DEFAULT = AF_UNIX; + public static final String SYSLOG_SOCKET_LIBRARY_DEFAULT = "c"; + public static final int SYSLOG_SOCKET_PROTOCOL_DEFAULT = 0; + public static final String SYSLOG_SOCKET_PATH_DEFAULT = "/dev/log"; + + public static final String JNA_NATIVE_CLASS = "com.sun.jna.Native"; + + public static final String IDENT_SUFFIX_DEFAULT = ": "; + + public static final String SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT = " {"; + public static final String SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT = "}"; + + public static final String SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT = " #"; + public static final String SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT = ""; + public static final long SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT = 0; + public static final long SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT = 9999; + public static final char SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT = '0'; + public static final boolean SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT = true; + + public static final int SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT = 4; + public static final int SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT = 4; + public static final int SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT = 1000; + public static final int SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT = 0; + public static final int SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT = 4; + public static final int SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT = 0; + public static final int SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT = 0; + public static final int SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT = 0; + public static final boolean SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT = false; + public static final boolean SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT = false; + public static final boolean SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT = false; } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogIF.java b/src/main/java/org/graylog2/syslog4j/SyslogIF.java index c5dbf18..35bcf7f 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogIF.java @@ -1,52 +1,71 @@ package org.graylog2.syslog4j; /** -* SyslogIF provides a common interface for all Syslog4j client implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogIF.java,v 1.9 2010/02/11 04:59:22 cvs Exp $ -*/ + * SyslogIF provides a common interface for all Syslog4j client implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogIF.java,v 1.9 2010/02/11 04:59:22 cvs Exp $ + */ public interface SyslogIF extends SyslogConstants { - public void initialize(String protocol, SyslogConfigIF config) throws SyslogRuntimeException; - - public String getProtocol(); - public SyslogConfigIF getConfig(); - - public void backLog(int level, String message, Throwable reasonThrowable); - public void backLog(int level, String message, String reason); - - public void log(int level, String message); - - public void debug(String message); - public void info(String message); - public void notice(String message); - public void warn(String message); - public void error(String message); - public void critical(String message); - public void alert(String message); - public void emergency(String message); + public void initialize(String protocol, SyslogConfigIF config) throws SyslogRuntimeException; - public void log(int level, SyslogMessageIF message); - - public void debug(SyslogMessageIF message); - public void info(SyslogMessageIF message); - public void notice(SyslogMessageIF message); - public void warn(SyslogMessageIF message); - public void error(SyslogMessageIF message); - public void critical(SyslogMessageIF message); - public void alert(SyslogMessageIF message); - public void emergency(SyslogMessageIF message); + public String getProtocol(); - public void flush() throws SyslogRuntimeException; - public void shutdown() throws SyslogRuntimeException; - - public void setMessageProcessor(SyslogMessageProcessorIF messageProcessor); - public SyslogMessageProcessorIF getMessageProcessor(); + public SyslogConfigIF getConfig(); - public void setStructuredMessageProcessor(SyslogMessageProcessorIF messageProcessor); - public SyslogMessageProcessorIF getStructuredMessageProcessor(); + public void backLog(int level, String message, Throwable reasonThrowable); + + public void backLog(int level, String message, String reason); + + public void log(int level, String message); + + public void debug(String message); + + public void info(String message); + + public void notice(String message); + + public void warn(String message); + + public void error(String message); + + public void critical(String message); + + public void alert(String message); + + public void emergency(String message); + + public void log(int level, SyslogMessageIF message); + + public void debug(SyslogMessageIF message); + + public void info(SyslogMessageIF message); + + public void notice(SyslogMessageIF message); + + public void warn(SyslogMessageIF message); + + public void error(SyslogMessageIF message); + + public void critical(SyslogMessageIF message); + + public void alert(SyslogMessageIF message); + + public void emergency(SyslogMessageIF message); + + public void flush() throws SyslogRuntimeException; + + public void shutdown() throws SyslogRuntimeException; + + public void setMessageProcessor(SyslogMessageProcessorIF messageProcessor); + + public SyslogMessageProcessorIF getMessageProcessor(); + + public void setStructuredMessageProcessor(SyslogMessageProcessorIF messageProcessor); + + public SyslogMessageProcessorIF getStructuredMessageProcessor(); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogMain.java b/src/main/java/org/graylog2/syslog4j/SyslogMain.java index fc1a255..dd5a5bf 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogMain.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogMain.java @@ -10,189 +10,235 @@ import java.io.InputStreamReader; /** * This class provides a command-line interface for Syslog4j * server implementations. - * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: SyslogMain.java,v 1.4 2010/11/28 01:38:08 cvs Exp $ */ public class SyslogMain { - public static boolean CALL_SYSTEM_EXIT_ON_FAILURE = true; - - public static class Options { - public String host = null; - public String port = null; - public String level = "INFO"; - public String facility = "USER"; - public String protocol = null; - public String message = null; - public String fileName = null; - - public boolean quiet = false; + public static boolean CALL_SYSTEM_EXIT_ON_FAILURE = true; - public String usage = null; - } - - public static void usage(String problem) { - if (problem != null) { - System.out.println("Error: " + problem); - System.out.println(); - } - - System.out.println("Usage:"); - System.out.println(); - System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); - System.out.println(" "); - System.out.println(); - System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); - System.out.println(" [message...]"); - System.out.println(); - System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); - System.out.println(" -i "); - System.out.println(); - System.out.println("-h host or IP to send message (default: localhost)"); - System.out.println("-p port to send message (default: 514)"); - System.out.println("-l syslog level to use (default: INFO)"); - System.out.println("-f syslog facility to use (default: USER)"); - System.out.println("-i input taken from the specified file"); - System.out.println(); - System.out.println("-q do not write anything to standard out"); - System.out.println(); - System.out.println("protocol Syslog4j protocol implementation"); - System.out.println("message syslog message text"); - System.out.println(); - System.out.println("Notes:"); - System.out.println(); - System.out.println("Additional message arguments will be concatenated into the same"); - System.out.println("syslog message; calling SyslogMain will only send one message per call."); - System.out.println(); - System.out.println("If the message argument is ommited, lines will be taken from the"); - System.out.println("standard input."); - } - - public static Options parseOptions(String[] args) { - Options options = new Options(); - - int i = 0; - while(i < args.length) { - String arg = args[i++]; - boolean match = false; - - if ("-h".equals(arg)) { if (i == args.length) { options.usage = "Must specify host with -h"; return options; } match = true; options.host = args[i++]; } - if ("-p".equals(arg)) { if (i == args.length) { options.usage = "Must specify port with -p"; return options; } match = true; options.port = args[i++]; } - if ("-l".equals(arg)) { if (i == args.length) { options.usage = "Must specify level with -l"; return options; } match = true; options.level = args[i++]; } - if ("-f".equals(arg)) { if (i == args.length) { options.usage = "Must specify facility with -f"; return options; } match = true; options.facility = args[i++]; } - if ("-i".equals(arg)) { if (i == args.length) { options.usage = "Must specify file with -i"; return options; } match = true; options.fileName = args[i++]; } - - if ("-q".equals(arg)) { match = true; options.quiet = true; } - - if (options.protocol == null && !match) { - match = true; - options.protocol = arg; - } + public static class Options { + public String host = null; + public String port = null; + public String level = "INFO"; + public String facility = "USER"; + public String protocol = null; + public String message = null; + public String fileName = null; - if (!match) { - if (options.message == null) { - options.message = arg; - - } else { - options.message += " " + arg; - } - } - } - - if (options.protocol == null) { - options.usage = "Must specify protocol"; - return options; - } - - if (options.message != null && options.fileName != null) { - options.usage = "Must specify either -i or , not both"; - return options; - } + public boolean quiet = false; - return options; - } - - public static void main(String[] args) throws Exception { - main(args,true); - } - - public static void main(String[] args, boolean shutdown) throws Exception { - Options options = parseOptions(args); + public String usage = null; + } - if (options.usage != null) { - usage(options.usage); - if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; } - } - - if (!options.quiet) { - System.out.println("Syslog " + Syslog.getVersion()); - } - - if (!Syslog.exists(options.protocol)) { - usage("Protocol \"" + options.protocol + "\" not supported"); - if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; } - } - - SyslogIF syslog = Syslog.getInstance(options.protocol); - - SyslogConfigIF syslogConfig = syslog.getConfig(); - - if (options.host != null) { - syslogConfig.setHost(options.host); - if (!options.quiet) { - System.out.println("Sending to host: " + options.host); - } - } + public static void usage(String problem) { + if (problem != null) { + System.out.println("Error: " + problem); + System.out.println(); + } - if (options.port != null) { - syslogConfig.setPort(Integer.parseInt(options.port)); - if (!options.quiet) { - System.out.println("Sending to port: " + options.port); - } - } - - int level = SyslogUtility.getLevel(options.level); - - syslogConfig.setFacility(options.facility); - - if (options.message != null) { - if (!options.quiet) { - System.out.println("Sending " + options.facility + "." + options.level + " message \"" + options.message + "\""); - } - - syslog.log(level,options.message); - - } else { - InputStream is = null; - - if (options.fileName != null) { - is = new FileInputStream(options.fileName); - - } else { - is = System.in; - } - - BufferedReader br = new BufferedReader(new InputStreamReader(is)); - - String line = br.readLine(); - - while(line != null && line.length() > 0) { - if (!options.quiet) { - System.out.println("Sending " + options.facility + "." + options.level + " message \"" + line + "\""); - } - - syslog.log(level,line); - - line = br.readLine(); - } - } + System.out.println("Usage:"); + System.out.println(); + System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); + System.out.println(" "); + System.out.println(); + System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); + System.out.println(" [message...]"); + System.out.println(); + System.out.println("Syslog [-h ] [-p ] [-l ] [-f ]"); + System.out.println(" -i "); + System.out.println(); + System.out.println("-h host or IP to send message (default: localhost)"); + System.out.println("-p port to send message (default: 514)"); + System.out.println("-l syslog level to use (default: INFO)"); + System.out.println("-f syslog facility to use (default: USER)"); + System.out.println("-i input taken from the specified file"); + System.out.println(); + System.out.println("-q do not write anything to standard out"); + System.out.println(); + System.out.println("protocol Syslog4j protocol implementation"); + System.out.println("message syslog message text"); + System.out.println(); + System.out.println("Notes:"); + System.out.println(); + System.out.println("Additional message arguments will be concatenated into the same"); + System.out.println("syslog message; calling SyslogMain will only send one message per call."); + System.out.println(); + System.out.println("If the message argument is ommited, lines will be taken from the"); + System.out.println("standard input."); + } - if (shutdown) { - Syslog.shutdown(); - } - } + public static Options parseOptions(String[] args) { + Options options = new Options(); + + int i = 0; + while (i < args.length) { + String arg = args[i++]; + boolean match = false; + + if ("-h".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify host with -h"; + return options; + } + match = true; + options.host = args[i++]; + } + if ("-p".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify port with -p"; + return options; + } + match = true; + options.port = args[i++]; + } + if ("-l".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify level with -l"; + return options; + } + match = true; + options.level = args[i++]; + } + if ("-f".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify facility with -f"; + return options; + } + match = true; + options.facility = args[i++]; + } + if ("-i".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify file with -i"; + return options; + } + match = true; + options.fileName = args[i++]; + } + + if ("-q".equals(arg)) { + match = true; + options.quiet = true; + } + + if (options.protocol == null && !match) { + match = true; + options.protocol = arg; + } + + if (!match) { + if (options.message == null) { + options.message = arg; + + } else { + options.message += " " + arg; + } + } + } + + if (options.protocol == null) { + options.usage = "Must specify protocol"; + return options; + } + + if (options.message != null && options.fileName != null) { + options.usage = "Must specify either -i or , not both"; + return options; + } + + return options; + } + + public static void main(String[] args) throws Exception { + main(args, true); + } + + public static void main(String[] args, boolean shutdown) throws Exception { + Options options = parseOptions(args); + + if (options.usage != null) { + usage(options.usage); + if (CALL_SYSTEM_EXIT_ON_FAILURE) { + System.exit(1); + } else { + return; + } + } + + if (!options.quiet) { + System.out.println("Syslog " + Syslog.getVersion()); + } + + if (!Syslog.exists(options.protocol)) { + usage("Protocol \"" + options.protocol + "\" not supported"); + if (CALL_SYSTEM_EXIT_ON_FAILURE) { + System.exit(1); + } else { + return; + } + } + + SyslogIF syslog = Syslog.getInstance(options.protocol); + + SyslogConfigIF syslogConfig = syslog.getConfig(); + + if (options.host != null) { + syslogConfig.setHost(options.host); + if (!options.quiet) { + System.out.println("Sending to host: " + options.host); + } + } + + if (options.port != null) { + syslogConfig.setPort(Integer.parseInt(options.port)); + if (!options.quiet) { + System.out.println("Sending to port: " + options.port); + } + } + + int level = SyslogUtility.getLevel(options.level); + + syslogConfig.setFacility(options.facility); + + if (options.message != null) { + if (!options.quiet) { + System.out.println("Sending " + options.facility + "." + options.level + " message \"" + options.message + "\""); + } + + syslog.log(level, options.message); + + } else { + InputStream is = null; + + if (options.fileName != null) { + is = new FileInputStream(options.fileName); + + } else { + is = System.in; + } + + BufferedReader br = new BufferedReader(new InputStreamReader(is)); + + String line = br.readLine(); + + while (line != null && line.length() > 0) { + if (!options.quiet) { + System.out.println("Sending " + options.facility + "." + options.level + " message \"" + line + "\""); + } + + syslog.log(level, line); + + line = br.readLine(); + } + } + + if (shutdown) { + Syslog.shutdown(); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogMessageIF.java b/src/main/java/org/graylog2/syslog4j/SyslogMessageIF.java index 25cc467..3b63959 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogMessageIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogMessageIF.java @@ -3,15 +3,15 @@ package org.graylog2.syslog4j; import java.io.Serializable; /** -* SyslogMessageIF provides a common interface for all Syslog4j event implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogMessageIF.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ -*/ + * SyslogMessageIF provides a common interface for all Syslog4j event implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogMessageIF.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ + */ public interface SyslogMessageIF extends Serializable { - public String createMessage(); + public String createMessage(); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierConfigIF.java b/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierConfigIF.java index 86d4361..3ed714b 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierConfigIF.java @@ -1,20 +1,22 @@ package org.graylog2.syslog4j; /** -* SyslogMessageModifierConfigIF provides a common configuration interface for all -* Syslog4j message modifier implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogMessageModifierConfigIF.java,v 1.3 2010/10/28 05:10:57 cvs Exp $ -*/ + * SyslogMessageModifierConfigIF provides a common configuration interface for all + * Syslog4j message modifier implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogMessageModifierConfigIF.java,v 1.3 2010/10/28 05:10:57 cvs Exp $ + */ public interface SyslogMessageModifierConfigIF extends SyslogConstants, SyslogCharSetIF { - public String getPrefix(); - public void setPrefix(String prefix); + public String getPrefix(); - public String getSuffix(); - public void setSuffix(String suffix); + public void setPrefix(String prefix); + + public String getSuffix(); + + public void setSuffix(String suffix); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierIF.java b/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierIF.java index da017bf..8e8ebab 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogMessageModifierIF.java @@ -1,17 +1,18 @@ package org.graylog2.syslog4j; /** -* SyslogMessageModifierIF provides a common interface for all -* Syslog4j message modifier implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogMessageModifierIF.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ -*/ + * SyslogMessageModifierIF provides a common interface for all + * Syslog4j message modifier implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogMessageModifierIF.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ + */ public interface SyslogMessageModifierIF extends SyslogConstants { - public String modify(SyslogIF syslog, int facility, int level, String message); - public boolean verify(String message); + public String modify(SyslogIF syslog, int facility, int level, String message); + + public boolean verify(String message); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogMessageProcessorIF.java b/src/main/java/org/graylog2/syslog4j/SyslogMessageProcessorIF.java index 25c19ae..0122bf2 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogMessageProcessorIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogMessageProcessorIF.java @@ -3,20 +3,20 @@ package org.graylog2.syslog4j; import java.io.Serializable; /** -* SyslogMessageProcessorIF provides an extensible interface for writing custom -* Syslog4j message processors. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogMessageProcessorIF.java,v 1.4 2010/11/28 04:15:18 cvs Exp $ -*/ + * SyslogMessageProcessorIF provides an extensible interface for writing custom + * Syslog4j message processors. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogMessageProcessorIF.java,v 1.4 2010/11/28 04:15:18 cvs Exp $ + */ public interface SyslogMessageProcessorIF extends Serializable { - public String createSyslogHeader(int facility, int level, String localName, boolean sendLocalTimestamp, boolean sendLocalName); + public String createSyslogHeader(int facility, int level, String localName, boolean sendLocalTimestamp, boolean sendLocalName); - public byte[] createPacketData(byte[] header, byte[] message, int start, int length); + public byte[] createPacketData(byte[] header, byte[] message, int start, int length); - public byte[] createPacketData(byte[] header, byte[] message, int start, int length, byte[] splitBeginText, byte[] splitEndText); + public byte[] createPacketData(byte[] header, byte[] message, int start, int length, byte[] splitBeginText, byte[] splitEndText); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogPoolConfigIF.java b/src/main/java/org/graylog2/syslog4j/SyslogPoolConfigIF.java index 1366704..37bb2cd 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogPoolConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogPoolConfigIF.java @@ -3,50 +3,62 @@ package org.graylog2.syslog4j; import java.io.Serializable; /** -* SyslogPoolConfigIF is an interface which provides configuration support -* for the Apache Commons Pool. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogPoolConfigIF.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ -*/ + * SyslogPoolConfigIF is an interface which provides configuration support + * for the Apache Commons Pool. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogPoolConfigIF.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ + */ public interface SyslogPoolConfigIF extends Serializable { - public int getMaxActive(); - public void setMaxActive(int maxActive); - - public int getMaxIdle(); - public void setMaxIdle(int maxIdle); - - public long getMaxWait(); - public void setMaxWait(long maxWait); - - public long getMinEvictableIdleTimeMillis(); - public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis); - - public int getMinIdle(); - public void setMinIdle(int minIdle); - - public int getNumTestsPerEvictionRun(); - public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun); - - public long getSoftMinEvictableIdleTimeMillis(); - public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis); - - public boolean isTestOnBorrow(); - public void setTestOnBorrow(boolean testOnBorrow); - - public boolean isTestOnReturn(); - public void setTestOnReturn(boolean testOnReturn); - - public boolean isTestWhileIdle(); - public void setTestWhileIdle(boolean testWhileIdle); - - public long getTimeBetweenEvictionRunsMillis(); - public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis); - - public byte getWhenExhaustedAction(); - public void setWhenExhaustedAction(byte whenExhaustedAction); + public int getMaxActive(); + + public void setMaxActive(int maxActive); + + public int getMaxIdle(); + + public void setMaxIdle(int maxIdle); + + public long getMaxWait(); + + public void setMaxWait(long maxWait); + + public long getMinEvictableIdleTimeMillis(); + + public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis); + + public int getMinIdle(); + + public void setMinIdle(int minIdle); + + public int getNumTestsPerEvictionRun(); + + public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun); + + public long getSoftMinEvictableIdleTimeMillis(); + + public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis); + + public boolean isTestOnBorrow(); + + public void setTestOnBorrow(boolean testOnBorrow); + + public boolean isTestOnReturn(); + + public void setTestOnReturn(boolean testOnReturn); + + public boolean isTestWhileIdle(); + + public void setTestWhileIdle(boolean testWhileIdle); + + public long getTimeBetweenEvictionRunsMillis(); + + public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis); + + public byte getWhenExhaustedAction(); + + public void setWhenExhaustedAction(byte whenExhaustedAction); } diff --git a/src/main/java/org/graylog2/syslog4j/SyslogRuntimeException.java b/src/main/java/org/graylog2/syslog4j/SyslogRuntimeException.java index 11e13c1..2543ae2 100644 --- a/src/main/java/org/graylog2/syslog4j/SyslogRuntimeException.java +++ b/src/main/java/org/graylog2/syslog4j/SyslogRuntimeException.java @@ -1,24 +1,24 @@ package org.graylog2.syslog4j; /** -* SyslogRuntimeException provides an extension of RuntimeException thrown -* by the majority of the classes within Syslog4j. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogRuntimeException.java,v 1.3 2008/11/13 14:48:36 cvs Exp $ -*/ + * SyslogRuntimeException provides an extension of RuntimeException thrown + * by the majority of the classes within Syslog4j. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogRuntimeException.java,v 1.3 2008/11/13 14:48:36 cvs Exp $ + */ public class SyslogRuntimeException extends RuntimeException { - private static final long serialVersionUID = 7278123987654320379L; + private static final long serialVersionUID = 7278123987654320379L; - public SyslogRuntimeException(String arg0) { - super(arg0); - } + public SyslogRuntimeException(String arg0) { + super(arg0); + } - public SyslogRuntimeException(Throwable arg0) { - super(arg0); - } + public SyslogRuntimeException(Throwable arg0) { + super(arg0); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslog.java index 91e915a..0331430 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslog.java @@ -17,378 +17,378 @@ import org.graylog2.syslog4j.impl.message.structured.StructuredSyslogMessageIF; import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslog provides a base abstract implementation of the SyslogIF. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslog.java,v 1.29 2011/01/11 04:58:52 cvs Exp $ -*/ + * AbstractSyslog provides a base abstract implementation of the SyslogIF. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslog.java,v 1.29 2011/01/11 04:58:52 cvs Exp $ + */ public abstract class AbstractSyslog implements SyslogIF { - private static final long serialVersionUID = 2632017043774808264L; + private static final long serialVersionUID = 2632017043774808264L; - protected String syslogProtocol = null; - - protected AbstractSyslogConfigIF syslogConfig = null; - - protected SyslogMessageProcessorIF syslogMessageProcessor = null; - protected SyslogMessageProcessorIF structuredSyslogMessageProcessor = null; - - protected Object backLogStatusSyncObject = new Object(); - - protected boolean backLogStatus = false; - protected List notifiedBackLogHandlers = new ArrayList(); - - protected boolean getBackLogStatus() { - synchronized(this.backLogStatusSyncObject) { - return this.backLogStatus; - } - } + protected String syslogProtocol = null; - /** - * @param backLogStatus - true if in a "down" backLog state, false if in an "up" (operational) non-backLog state - */ - public void setBackLogStatus(boolean backLogStatus) { - if (this.backLogStatus != backLogStatus) { - synchronized(this.backLogStatusSyncObject) { - if (!backLogStatus) { - for(int i=0; i 0 && mLength > availableLen) { - mLength = availableLen; - } - } + } else { + log(getStructuredMessageProcessor(), level, message.createMessage()); + } - if (mLength <= availableLen) { - byte[] data = messageProcessor.createPacketData(h,m,0,mLength); - - write(level,data); - - } else { - byte[] splitBeginText = this.syslogConfig.getSplitMessageBeginText(); - byte[] splitEndText = this.syslogConfig.getSplitMessageEndText(); - - int pos = 0; - int left = mLength; - - while(left > 0) { - boolean firstTime = (pos == 0); - - boolean doSplitBeginText = splitBeginText != null && !firstTime; - boolean doSplitEndText = splitBeginText != null && (firstTime || (left > (availableLen - splitBeginText.length))); - - int actualAvailableLen = availableLen; - - actualAvailableLen -= (splitBeginText != null && doSplitBeginText) ? splitBeginText.length : 0; - actualAvailableLen -= (splitEndText != null && doSplitEndText) ? splitEndText.length : 0; - - if (actualAvailableLen > left) { - actualAvailableLen = left; - } - - if (actualAvailableLen < 0) { - throw new SyslogRuntimeException("Message length < 0; recommendation: increase the size of maxMessageLength"); - } - - byte[] data = messageProcessor.createPacketData(h,m,pos,actualAvailableLen,doSplitBeginText ? splitBeginText : null,doSplitEndText ? splitEndText : null); - - write(level,data); - - pos += actualAvailableLen; - left -= actualAvailableLen; - } - } - } + } else { + log(getMessageProcessor(), level, message.createMessage()); + } + } - protected abstract void initialize() throws SyslogRuntimeException; - - protected abstract void write(int level, byte[] message) throws SyslogRuntimeException; - - protected String modifyMessage(int level, String message) { - List _messageModifiers = this.syslogConfig.getMessageModifiers(); - - if (_messageModifiers == null || _messageModifiers.size() < 1) { - return message; - } - - String _message = message; - - int facility = this.syslogConfig.getFacility(); - - for(int i=0; i<_messageModifiers.size(); i++) { - SyslogMessageModifierIF messageModifier = (SyslogMessageModifierIF) _messageModifiers.get(i); - - _message = messageModifier.modify(this, facility, level, _message); - } - - return _message; - } - - public void backLog(int level, String message, Throwable reasonThrowable) { - backLog(level,message,reasonThrowable != null ? reasonThrowable.toString() : "UNKNOWN"); - } - - public void backLog(int level, String message, String reason) { - boolean status = getBackLogStatus(); - - if (!status) { - setBackLogStatus(true); - } - - List backLogHandlers = this.syslogConfig.getBackLogHandlers(); - - for(int i=0; i -1) { - newWriterThread.setPriority(syslogConfig.getThreadPriority()); - } - syslogWriter.setThread(newWriterThread); - newWriterThread.start(); - - return newWriterThread; - } - + public void debug(String message) { + log(LEVEL_DEBUG, message); + } - public AbstractSyslogWriter createWriter(){ - Class clazz = this.syslogConfig.getSyslogWriterClass(); - - AbstractSyslogWriter newWriter = null; - - try { - newWriter = (AbstractSyslogWriter) clazz.newInstance(); - newWriter.initialize(this); - - } catch (InstantiationException ie) { - if (this.syslogConfig.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(ie); - } - - } catch (IllegalAccessException iae) { - if (this.syslogConfig.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(iae); - } - } + public void notice(String message) { + log(LEVEL_NOTICE, message); + } - return newWriter; - } + public void info(String message) { + log(LEVEL_INFO, message); + } + + public void warn(String message) { + log(LEVEL_WARN, message); + } + + public void error(String message) { + log(LEVEL_ERROR, message); + } + + public void critical(String message) { + log(LEVEL_CRITICAL, message); + } + + public void alert(String message) { + log(LEVEL_ALERT, message); + } + + public void emergency(String message) { + log(LEVEL_EMERGENCY, message); + } + + public void debug(SyslogMessageIF message) { + log(LEVEL_DEBUG, message); + } + + public void notice(SyslogMessageIF message) { + log(LEVEL_NOTICE, message); + } + + public void info(SyslogMessageIF message) { + log(LEVEL_INFO, message); + } + + public void warn(SyslogMessageIF message) { + log(LEVEL_WARN, message); + } + + public void error(SyslogMessageIF message) { + log(LEVEL_ERROR, message); + } + + public void critical(SyslogMessageIF message) { + log(LEVEL_CRITICAL, message); + } + + public void alert(SyslogMessageIF message) { + log(LEVEL_ALERT, message); + } + + public void emergency(SyslogMessageIF message) { + log(LEVEL_EMERGENCY, message); + } + + protected String prefixMessage(String message, String suffix) { + String ident = this.syslogConfig.getIdent(); + + String _message = ((ident == null || "".equals(ident.trim())) ? "" : (ident + suffix)) + message; + + return _message; + } + + public void log(SyslogMessageProcessorIF messageProcessor, int level, String message) { + String _message = null; + + if (this.syslogConfig.isIncludeIdentInMessageModifier()) { + _message = prefixMessage(message, IDENT_SUFFIX_DEFAULT); + _message = modifyMessage(level, _message); + + } else { + _message = modifyMessage(level, message); + _message = prefixMessage(_message, IDENT_SUFFIX_DEFAULT); + } + + try { + write(messageProcessor, level, _message); + + } catch (SyslogRuntimeException sre) { + if (sre.getCause() != null) { + backLog(level, _message, sre.getCause()); + + } else { + backLog(level, _message, sre); + } + + if (this.syslogConfig.isThrowExceptionOnWrite()) { + throw sre; + } + } + } + + protected void write(SyslogMessageProcessorIF messageProcessor, int level, String message) throws SyslogRuntimeException { + String header = messageProcessor.createSyslogHeader(this.syslogConfig.getFacility(), level, this.syslogConfig.getLocalName(), this.syslogConfig.isSendLocalTimestamp(), this.syslogConfig.isSendLocalName()); + + byte[] h = SyslogUtility.getBytes(this.syslogConfig, header); + byte[] m = SyslogUtility.getBytes(this.syslogConfig, message); + + int mLength = m.length; + + int availableLen = this.syslogConfig.getMaxMessageLength() - h.length; + + if (this.syslogConfig.isTruncateMessage()) { + if (availableLen > 0 && mLength > availableLen) { + mLength = availableLen; + } + } + + if (mLength <= availableLen) { + byte[] data = messageProcessor.createPacketData(h, m, 0, mLength); + + write(level, data); + + } else { + byte[] splitBeginText = this.syslogConfig.getSplitMessageBeginText(); + byte[] splitEndText = this.syslogConfig.getSplitMessageEndText(); + + int pos = 0; + int left = mLength; + + while (left > 0) { + boolean firstTime = (pos == 0); + + boolean doSplitBeginText = splitBeginText != null && !firstTime; + boolean doSplitEndText = splitBeginText != null && (firstTime || (left > (availableLen - splitBeginText.length))); + + int actualAvailableLen = availableLen; + + actualAvailableLen -= (splitBeginText != null && doSplitBeginText) ? splitBeginText.length : 0; + actualAvailableLen -= (splitEndText != null && doSplitEndText) ? splitEndText.length : 0; + + if (actualAvailableLen > left) { + actualAvailableLen = left; + } + + if (actualAvailableLen < 0) { + throw new SyslogRuntimeException("Message length < 0; recommendation: increase the size of maxMessageLength"); + } + + byte[] data = messageProcessor.createPacketData(h, m, pos, actualAvailableLen, doSplitBeginText ? splitBeginText : null, doSplitEndText ? splitEndText : null); + + write(level, data); + + pos += actualAvailableLen; + left -= actualAvailableLen; + } + } + } + + protected abstract void initialize() throws SyslogRuntimeException; + + protected abstract void write(int level, byte[] message) throws SyslogRuntimeException; + + protected String modifyMessage(int level, String message) { + List _messageModifiers = this.syslogConfig.getMessageModifiers(); + + if (_messageModifiers == null || _messageModifiers.size() < 1) { + return message; + } + + String _message = message; + + int facility = this.syslogConfig.getFacility(); + + for (int i = 0; i < _messageModifiers.size(); i++) { + SyslogMessageModifierIF messageModifier = (SyslogMessageModifierIF) _messageModifiers.get(i); + + _message = messageModifier.modify(this, facility, level, _message); + } + + return _message; + } + + public void backLog(int level, String message, Throwable reasonThrowable) { + backLog(level, message, reasonThrowable != null ? reasonThrowable.toString() : "UNKNOWN"); + } + + public void backLog(int level, String message, String reason) { + boolean status = getBackLogStatus(); + + if (!status) { + setBackLogStatus(true); + } + + List backLogHandlers = this.syslogConfig.getBackLogHandlers(); + + for (int i = 0; i < backLogHandlers.size(); i++) { + SyslogBackLogHandlerIF backLogHandler = (SyslogBackLogHandlerIF) backLogHandlers.get(i); + + try { + if (!status) { + backLogHandler.down(this, reason); + this.notifiedBackLogHandlers.add(backLogHandler); + } + + backLogHandler.log(this, level, message, reason); + break; + + } catch (Exception e) { + // Ignore this Exception and go onto next backLogHandler + } + } + } + + public abstract AbstractSyslogWriter getWriter(); + + public abstract void returnWriter(AbstractSyslogWriter syslogWriter); + + public Thread createWriterThread(AbstractSyslogWriter syslogWriter) { + Thread newWriterThread = new Thread(syslogWriter); + newWriterThread.setName("SyslogWriter: " + getProtocol()); + newWriterThread.setDaemon(syslogConfig.isUseDaemonThread()); + if (syslogConfig.getThreadPriority() > -1) { + newWriterThread.setPriority(syslogConfig.getThreadPriority()); + } + syslogWriter.setThread(newWriterThread); + newWriterThread.start(); + + return newWriterThread; + } + + + public AbstractSyslogWriter createWriter() { + Class clazz = this.syslogConfig.getSyslogWriterClass(); + + AbstractSyslogWriter newWriter = null; + + try { + newWriter = (AbstractSyslogWriter) clazz.newInstance(); + newWriter.initialize(this); + + } catch (InstantiationException ie) { + if (this.syslogConfig.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(ie); + } + + } catch (IllegalAccessException iae) { + if (this.syslogConfig.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(iae); + } + } + + return newWriter; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfig.java index 3cc0820..c4d4628 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfig.java @@ -10,369 +10,369 @@ import org.graylog2.syslog4j.impl.backlog.printstream.SystemErrSyslogBackLogHand import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslog provides a base abstract implementation of the SyslogConfigIF -* configuration interface. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogConfig.java,v 1.24 2010/11/28 04:43:31 cvs Exp $ -*/ + * AbstractSyslog provides a base abstract implementation of the SyslogConfigIF + * configuration interface. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogConfig.java,v 1.24 2010/11/28 04:43:31 cvs Exp $ + */ public abstract class AbstractSyslogConfig implements AbstractSyslogConfigIF { - private static final long serialVersionUID = -3728308557871358111L; - - protected final static List defaultBackLogHandlers = new ArrayList(); - - static { - defaultBackLogHandlers.add(new SystemErrSyslogBackLogHandler()); - } - - protected int facility = SYSLOG_FACILITY_DEFAULT; - - protected String charSet = CHAR_SET_DEFAULT; - - protected String ident = ""; + private static final long serialVersionUID = -3728308557871358111L; - protected String localName = null; + protected final static List defaultBackLogHandlers = new ArrayList(); - protected boolean sendLocalTimestamp = SEND_LOCAL_TIMESTAMP_DEFAULT; - protected boolean sendLocalName = SEND_LOCAL_NAME_DEFAULT; - - protected boolean includeIdentInMessageModifier = INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT; - protected boolean throwExceptionOnWrite = THROW_EXCEPTION_ON_WRITE_DEFAULT; - protected boolean throwExceptionOnInitialize = THROW_EXCEPTION_ON_INITIALIZE_DEFAULT; - - protected int maxMessageLength = MAX_MESSAGE_LENGTH_DEFAULT; - protected byte[] splitMessageBeginText = SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT.getBytes(); - protected byte[] splitMessageEndText = SPLIT_MESSAGE_END_TEXT_DEFAULT.getBytes(); - - protected List messageModifiers = null; - protected List backLogHandlers = null; + static { + defaultBackLogHandlers.add(new SystemErrSyslogBackLogHandler()); + } - protected boolean threaded = THREADED_DEFAULT; - protected boolean useDaemonThread = USE_DAEMON_THREAD_DEFAULT; - protected int threadPriority = THREAD_PRIORITY_DEFAULT; - protected long threadLoopInterval = THREAD_LOOP_INTERVAL_DEFAULT; - - protected int writeRetries = WRITE_RETRIES_DEFAULT; - protected long maxShutdownWait = MAX_SHUTDOWN_WAIT_DEFAULT; - - protected boolean truncateMessage = TRUNCATE_MESSAGE_DEFAULT; - protected boolean useStructuredData = USE_STRUCTURED_DATA_DEFAULT; + protected int facility = SYSLOG_FACILITY_DEFAULT; - public abstract Class getSyslogClass(); - - public String getCharSet() { - return this.charSet; - } + protected String charSet = CHAR_SET_DEFAULT; - public void setCharSet(String charSet) { - this.charSet = charSet; - } + protected String ident = ""; - public String getLocalName() { - return localName; - } + protected String localName = null; - public void setLocalName(String localName) { - this.localName = localName; - } + protected boolean sendLocalTimestamp = SEND_LOCAL_TIMESTAMP_DEFAULT; + protected boolean sendLocalName = SEND_LOCAL_NAME_DEFAULT; - public boolean isThrowExceptionOnWrite() { - return this.throwExceptionOnWrite; - } + protected boolean includeIdentInMessageModifier = INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT; + protected boolean throwExceptionOnWrite = THROW_EXCEPTION_ON_WRITE_DEFAULT; + protected boolean throwExceptionOnInitialize = THROW_EXCEPTION_ON_INITIALIZE_DEFAULT; - public void setThrowExceptionOnWrite(boolean throwExceptionOnWrite) { - this.throwExceptionOnWrite = throwExceptionOnWrite; - } + protected int maxMessageLength = MAX_MESSAGE_LENGTH_DEFAULT; + protected byte[] splitMessageBeginText = SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT.getBytes(); + protected byte[] splitMessageEndText = SPLIT_MESSAGE_END_TEXT_DEFAULT.getBytes(); - public boolean isThrowExceptionOnInitialize() { - return this.throwExceptionOnInitialize; - } + protected List messageModifiers = null; + protected List backLogHandlers = null; - public void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize) { - this.throwExceptionOnInitialize = throwExceptionOnInitialize; - } + protected boolean threaded = THREADED_DEFAULT; + protected boolean useDaemonThread = USE_DAEMON_THREAD_DEFAULT; + protected int threadPriority = THREAD_PRIORITY_DEFAULT; + protected long threadLoopInterval = THREAD_LOOP_INTERVAL_DEFAULT; - public byte[] getSplitMessageBeginText() { - return this.splitMessageBeginText; - } + protected int writeRetries = WRITE_RETRIES_DEFAULT; + protected long maxShutdownWait = MAX_SHUTDOWN_WAIT_DEFAULT; - public void setSplitMessageBeginText(byte[] splitMessageBeginText) { - this.splitMessageBeginText = splitMessageBeginText; - } + protected boolean truncateMessage = TRUNCATE_MESSAGE_DEFAULT; + protected boolean useStructuredData = USE_STRUCTURED_DATA_DEFAULT; - public void setSplitMessageBeginText(String splitMessageBeginText) throws SyslogRuntimeException { - this.splitMessageBeginText = SyslogUtility.getBytes(this,splitMessageBeginText); - } + public abstract Class getSyslogClass(); - public byte[] getSplitMessageEndText() { - return this.splitMessageEndText; - } + public String getCharSet() { + return this.charSet; + } - public void setSplitMessageEndText(byte[] splitMessageEndText) { - this.splitMessageEndText = splitMessageEndText; - } + public void setCharSet(String charSet) { + this.charSet = charSet; + } - public void setSplitMessageEndText(String splitMessageEndText) throws SyslogRuntimeException { - this.splitMessageEndText = SyslogUtility.getBytes(this,splitMessageEndText); - } + public String getLocalName() { + return localName; + } - public int getMaxMessageLength() { - return this.maxMessageLength; - } + public void setLocalName(String localName) { + this.localName = localName; + } - public void setMaxMessageLength(int maxMessageLength) { - this.maxMessageLength = maxMessageLength; - } + public boolean isThrowExceptionOnWrite() { + return this.throwExceptionOnWrite; + } - public boolean isSendLocalTimestamp() { - return this.sendLocalTimestamp; - } + public void setThrowExceptionOnWrite(boolean throwExceptionOnWrite) { + this.throwExceptionOnWrite = throwExceptionOnWrite; + } - public void setSendLocalTimestamp(boolean sendLocalTimestamp) { - this.sendLocalTimestamp = sendLocalTimestamp; - } + public boolean isThrowExceptionOnInitialize() { + return this.throwExceptionOnInitialize; + } - public boolean isSendLocalName() { - return this.sendLocalName; - } + public void setThrowExceptionOnInitialize(boolean throwExceptionOnInitialize) { + this.throwExceptionOnInitialize = throwExceptionOnInitialize; + } - public void setSendLocalName(boolean sendLocalName) { - this.sendLocalName = sendLocalName; - } - - public int getFacility() { - return this.facility; - } + public byte[] getSplitMessageBeginText() { + return this.splitMessageBeginText; + } - public void setFacility(int facility) { - this.facility = facility; - } + public void setSplitMessageBeginText(byte[] splitMessageBeginText) { + this.splitMessageBeginText = splitMessageBeginText; + } - public void setFacility(String facilityName) { - this.facility = SyslogUtility.getFacility(facilityName); - } - - public String getIdent() { - return this.ident; - } - - public void setIdent(String ident) { - this.ident = ident; - } + public void setSplitMessageBeginText(String splitMessageBeginText) throws SyslogRuntimeException { + this.splitMessageBeginText = SyslogUtility.getBytes(this, splitMessageBeginText); + } - protected synchronized List _getMessageModifiers() { - if (this.messageModifiers == null) { - this.messageModifiers = new ArrayList(); - } - - return this.messageModifiers; - } - - public void addMessageModifier(SyslogMessageModifierIF messageModifier) { - if (messageModifier == null) { - return; - } - - List _messageModifiers = _getMessageModifiers(); - - synchronized(_messageModifiers) { - _messageModifiers.add(messageModifier); - } - } + public byte[] getSplitMessageEndText() { + return this.splitMessageEndText; + } - public void insertMessageModifier(int index, SyslogMessageModifierIF messageModifier) { - if (messageModifier == null) { - return; - } - - List _messageModifiers = _getMessageModifiers(); - - synchronized(_messageModifiers) { - try { - _messageModifiers.add(index,messageModifier); - - } catch (IndexOutOfBoundsException ioobe) { - throw new SyslogRuntimeException(ioobe); - } - } - } + public void setSplitMessageEndText(byte[] splitMessageEndText) { + this.splitMessageEndText = splitMessageEndText; + } - public void removeMessageModifier(SyslogMessageModifierIF messageModifier) { - if (messageModifier == null) { - return; - } - - List _messageModifiers = _getMessageModifiers(); - - synchronized(_messageModifiers) { - _messageModifiers.remove(messageModifier); - } - } + public void setSplitMessageEndText(String splitMessageEndText) throws SyslogRuntimeException { + this.splitMessageEndText = SyslogUtility.getBytes(this, splitMessageEndText); + } - public List getMessageModifiers() { - return this.messageModifiers; - } + public int getMaxMessageLength() { + return this.maxMessageLength; + } - public void setMessageModifiers(List messageModifiers) { - this.messageModifiers = messageModifiers; - } - - public void removeAllMessageModifiers() { - if (this.messageModifiers == null || this.messageModifiers.isEmpty()) { - return; - } - - this.messageModifiers.clear(); - } + public void setMaxMessageLength(int maxMessageLength) { + this.maxMessageLength = maxMessageLength; + } - protected synchronized List _getBackLogHandlers() { - if (this.backLogHandlers == null) { - this.backLogHandlers = new ArrayList(); - } - - return this.backLogHandlers; - } - - public void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler) { - if (backLogHandler == null) { - return; - } - - List _backLogHandlers = _getBackLogHandlers(); - - synchronized(_backLogHandlers) { - backLogHandler.initialize(); - _backLogHandlers.add(backLogHandler); - } - } + public boolean isSendLocalTimestamp() { + return this.sendLocalTimestamp; + } - public void insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler) { - if (backLogHandler == null) { - return; - } - - List _backLogHandlers = _getBackLogHandlers(); - - synchronized(_backLogHandlers) { - try { - backLogHandler.initialize(); - _backLogHandlers.add(index,backLogHandler); - - } catch (IndexOutOfBoundsException ioobe) { - throw new SyslogRuntimeException(ioobe); - } - } - } + public void setSendLocalTimestamp(boolean sendLocalTimestamp) { + this.sendLocalTimestamp = sendLocalTimestamp; + } - public void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler) { - if (backLogHandler == null) { - return; - } - - List _backLogHandlers = _getBackLogHandlers(); - - synchronized(_backLogHandlers) { - _backLogHandlers.remove(backLogHandler); - } - } + public boolean isSendLocalName() { + return this.sendLocalName; + } - public List getBackLogHandlers() { - if (this.backLogHandlers == null || this.backLogHandlers.size() < 1) { - return defaultBackLogHandlers; - } - - return this.backLogHandlers; - } + public void setSendLocalName(boolean sendLocalName) { + this.sendLocalName = sendLocalName; + } - public void setBackLogHandlers(List backLogHandlers) { - this.backLogHandlers = backLogHandlers; - } - - public void removeAllBackLogHandlers() { - if (this.backLogHandlers == null || this.backLogHandlers.isEmpty()) { - return; - } - - this.backLogHandlers.clear(); - } + public int getFacility() { + return this.facility; + } - public boolean isIncludeIdentInMessageModifier() { - return this.includeIdentInMessageModifier; - } + public void setFacility(int facility) { + this.facility = facility; + } - public void setIncludeIdentInMessageModifier(boolean includeIdentInMessageModifier) { - this.includeIdentInMessageModifier = includeIdentInMessageModifier; - } + public void setFacility(String facilityName) { + this.facility = SyslogUtility.getFacility(facilityName); + } - public boolean isThreaded() { - return this.threaded; - } + public String getIdent() { + return this.ident; + } - public void setThreaded(boolean threaded) { - this.threaded = threaded; - } + public void setIdent(String ident) { + this.ident = ident; + } - public boolean isUseDaemonThread() { - return useDaemonThread; - } + protected synchronized List _getMessageModifiers() { + if (this.messageModifiers == null) { + this.messageModifiers = new ArrayList(); + } - public void setUseDaemonThread(boolean useDaemonThread) { - this.useDaemonThread = useDaemonThread; - } + return this.messageModifiers; + } - public int getThreadPriority() { - return threadPriority; - } + public void addMessageModifier(SyslogMessageModifierIF messageModifier) { + if (messageModifier == null) { + return; + } - public void setThreadPriority(int threadPriority) { - this.threadPriority = threadPriority; - } + List _messageModifiers = _getMessageModifiers(); - public long getThreadLoopInterval() { - return this.threadLoopInterval; - } + synchronized (_messageModifiers) { + _messageModifiers.add(messageModifier); + } + } - public void setThreadLoopInterval(long threadLoopInterval) { - this.threadLoopInterval = threadLoopInterval; - } - - public long getMaxShutdownWait() { - return this.maxShutdownWait; - } + public void insertMessageModifier(int index, SyslogMessageModifierIF messageModifier) { + if (messageModifier == null) { + return; + } - public void setMaxShutdownWait(long maxShutdownWait) { - this.maxShutdownWait = maxShutdownWait; - } + List _messageModifiers = _getMessageModifiers(); - public int getWriteRetries() { - return this.writeRetries; - } + synchronized (_messageModifiers) { + try { + _messageModifiers.add(index, messageModifier); - public void setWriteRetries(int writeRetries) { - this.writeRetries = writeRetries; - } + } catch (IndexOutOfBoundsException ioobe) { + throw new SyslogRuntimeException(ioobe); + } + } + } - public boolean isTruncateMessage() { - return this.truncateMessage; - } + public void removeMessageModifier(SyslogMessageModifierIF messageModifier) { + if (messageModifier == null) { + return; + } - public void setTruncateMessage(boolean truncateMessage) { - this.truncateMessage = truncateMessage; - } + List _messageModifiers = _getMessageModifiers(); - public boolean isUseStructuredData() { - return this.useStructuredData; - } + synchronized (_messageModifiers) { + _messageModifiers.remove(messageModifier); + } + } - public void setUseStructuredData(boolean useStructuredData) { - this.useStructuredData = useStructuredData; - } + public List getMessageModifiers() { + return this.messageModifiers; + } - public Class getSyslogWriterClass() { - return null; - } + public void setMessageModifiers(List messageModifiers) { + this.messageModifiers = messageModifiers; + } + + public void removeAllMessageModifiers() { + if (this.messageModifiers == null || this.messageModifiers.isEmpty()) { + return; + } + + this.messageModifiers.clear(); + } + + protected synchronized List _getBackLogHandlers() { + if (this.backLogHandlers == null) { + this.backLogHandlers = new ArrayList(); + } + + return this.backLogHandlers; + } + + public void addBackLogHandler(SyslogBackLogHandlerIF backLogHandler) { + if (backLogHandler == null) { + return; + } + + List _backLogHandlers = _getBackLogHandlers(); + + synchronized (_backLogHandlers) { + backLogHandler.initialize(); + _backLogHandlers.add(backLogHandler); + } + } + + public void insertBackLogHandler(int index, SyslogBackLogHandlerIF backLogHandler) { + if (backLogHandler == null) { + return; + } + + List _backLogHandlers = _getBackLogHandlers(); + + synchronized (_backLogHandlers) { + try { + backLogHandler.initialize(); + _backLogHandlers.add(index, backLogHandler); + + } catch (IndexOutOfBoundsException ioobe) { + throw new SyslogRuntimeException(ioobe); + } + } + } + + public void removeBackLogHandler(SyslogBackLogHandlerIF backLogHandler) { + if (backLogHandler == null) { + return; + } + + List _backLogHandlers = _getBackLogHandlers(); + + synchronized (_backLogHandlers) { + _backLogHandlers.remove(backLogHandler); + } + } + + public List getBackLogHandlers() { + if (this.backLogHandlers == null || this.backLogHandlers.size() < 1) { + return defaultBackLogHandlers; + } + + return this.backLogHandlers; + } + + public void setBackLogHandlers(List backLogHandlers) { + this.backLogHandlers = backLogHandlers; + } + + public void removeAllBackLogHandlers() { + if (this.backLogHandlers == null || this.backLogHandlers.isEmpty()) { + return; + } + + this.backLogHandlers.clear(); + } + + public boolean isIncludeIdentInMessageModifier() { + return this.includeIdentInMessageModifier; + } + + public void setIncludeIdentInMessageModifier(boolean includeIdentInMessageModifier) { + this.includeIdentInMessageModifier = includeIdentInMessageModifier; + } + + public boolean isThreaded() { + return this.threaded; + } + + public void setThreaded(boolean threaded) { + this.threaded = threaded; + } + + public boolean isUseDaemonThread() { + return useDaemonThread; + } + + public void setUseDaemonThread(boolean useDaemonThread) { + this.useDaemonThread = useDaemonThread; + } + + public int getThreadPriority() { + return threadPriority; + } + + public void setThreadPriority(int threadPriority) { + this.threadPriority = threadPriority; + } + + public long getThreadLoopInterval() { + return this.threadLoopInterval; + } + + public void setThreadLoopInterval(long threadLoopInterval) { + this.threadLoopInterval = threadLoopInterval; + } + + public long getMaxShutdownWait() { + return this.maxShutdownWait; + } + + public void setMaxShutdownWait(long maxShutdownWait) { + this.maxShutdownWait = maxShutdownWait; + } + + public int getWriteRetries() { + return this.writeRetries; + } + + public void setWriteRetries(int writeRetries) { + this.writeRetries = writeRetries; + } + + public boolean isTruncateMessage() { + return this.truncateMessage; + } + + public void setTruncateMessage(boolean truncateMessage) { + this.truncateMessage = truncateMessage; + } + + public boolean isUseStructuredData() { + return this.useStructuredData; + } + + public void setUseStructuredData(boolean useStructuredData) { + this.useStructuredData = useStructuredData; + } + + public Class getSyslogWriterClass() { + return null; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfigIF.java b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfigIF.java index bae1e2d..07a17f9 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogConfigIF.java @@ -5,52 +5,61 @@ import java.util.List; import org.graylog2.syslog4j.SyslogConfigIF; /** -* AbstractSyslogConfigIF provides an interface for all Abstract Syslog -* configuration implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogConfigIF.java,v 1.7 2010/10/29 03:14:20 cvs Exp $ -*/ + * AbstractSyslogConfigIF provides an interface for all Abstract Syslog + * configuration implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogConfigIF.java,v 1.7 2010/10/29 03:14:20 cvs Exp $ + */ public interface AbstractSyslogConfigIF extends SyslogConfigIF { - public Class getSyslogWriterClass(); - - public List getBackLogHandlers(); - - public List getMessageModifiers(); + public Class getSyslogWriterClass(); - public byte[] getSplitMessageBeginText(); - public void setSplitMessageBeginText(byte[] beginText); - - public byte[] getSplitMessageEndText(); - public void setSplitMessageEndText(byte[] endText); + public List getBackLogHandlers(); - public boolean isThreaded(); - public void setThreaded(boolean threaded); - - public boolean isUseDaemonThread(); - public void setUseDaemonThread(boolean useDaemonThread); - - public int getThreadPriority(); - public void setThreadPriority(int threadPriority); - - public long getThreadLoopInterval(); - public void setThreadLoopInterval(long threadLoopInterval); - - public long getMaxShutdownWait(); - public void setMaxShutdownWait(long maxShutdownWait); - - public int getWriteRetries(); - public void setWriteRetries(int writeRetries); - - public int getMaxQueueSize(); - /** - * Use the (default) value of -1 to allow for a queue of indefinite depth (size). - * - * @param maxQueueSize - */ - public void setMaxQueueSize(int maxQueueSize); + public List getMessageModifiers(); + + public byte[] getSplitMessageBeginText(); + + public void setSplitMessageBeginText(byte[] beginText); + + public byte[] getSplitMessageEndText(); + + public void setSplitMessageEndText(byte[] endText); + + public boolean isThreaded(); + + public void setThreaded(boolean threaded); + + public boolean isUseDaemonThread(); + + public void setUseDaemonThread(boolean useDaemonThread); + + public int getThreadPriority(); + + public void setThreadPriority(int threadPriority); + + public long getThreadLoopInterval(); + + public void setThreadLoopInterval(long threadLoopInterval); + + public long getMaxShutdownWait(); + + public void setMaxShutdownWait(long maxShutdownWait); + + public int getWriteRetries(); + + public void setWriteRetries(int writeRetries); + + public int getMaxQueueSize(); + + /** + * Use the (default) value of -1 to allow for a queue of indefinite depth (size). + * + * @param maxQueueSize + */ + public void setMaxQueueSize(int maxQueueSize); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogWriter.java b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogWriter.java index 6457805..1344b19 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogWriter.java +++ b/src/main/java/org/graylog2/syslog4j/impl/AbstractSyslogWriter.java @@ -9,101 +9,101 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslogWriter is an implementation of Runnable that supports sending -* syslog messages within a separate Thread or an object pool. -* -*

When used in "threaded" mode (see TCPNetSyslogConfig for the option), -* a queuing mechanism is used (via LinkedList).

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogWriter.java,v 1.9 2010/10/25 03:50:25 cvs Exp $ -*/ + * AbstractSyslogWriter is an implementation of Runnable that supports sending + * syslog messages within a separate Thread or an object pool. + *

+ *

When used in "threaded" mode (see TCPNetSyslogConfig for the option), + * a queuing mechanism is used (via LinkedList).

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogWriter.java,v 1.9 2010/10/25 03:50:25 cvs Exp $ + */ public abstract class AbstractSyslogWriter implements Runnable, Serializable { - private static final long serialVersionUID = 836468466009035847L; - - protected AbstractSyslog syslog = null; + private static final long serialVersionUID = 836468466009035847L; - protected List queuedMessages = null; - - protected Thread thread = null; + protected AbstractSyslog syslog = null; - protected AbstractSyslogConfigIF syslogConfig = null; + protected List queuedMessages = null; - protected boolean shutdown = false; - - public void initialize(AbstractSyslog abstractSyslog) { - this.syslog = abstractSyslog; + protected Thread thread = null; - try { - this.syslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must implement interface AbstractSyslogConfigIF"); - } - - if (this.syslogConfig.isThreaded()) { - this.queuedMessages = new LinkedList(); - } - } - - public void queue(int level, byte[] message) { - synchronized(this.queuedMessages) { - if (this.syslogConfig.getMaxQueueSize() == -1 || this.queuedMessages.size() < this.syslogConfig.getMaxQueueSize()) { - this.queuedMessages.add(message); - - } else { - this.syslog.backLog(level,SyslogUtility.newString(syslogConfig,message),"MaxQueueSize (" + this.syslogConfig.getMaxQueueSize() + ") reached"); - } - } - } - - public void setThread(Thread thread) { - this.thread = thread; - } - - public boolean hasThread() { - return this.thread != null && this.thread.isAlive(); - } + protected AbstractSyslogConfigIF syslogConfig = null; - public abstract void write(byte[] message); - - public abstract void flush(); - - public abstract void shutdown(); - - protected abstract void runCompleted(); + protected boolean shutdown = false; - public void run() { - while(!this.shutdown || !this.queuedMessages.isEmpty()) { - List queuedMessagesCopy = null; - - synchronized(this.queuedMessages) { - queuedMessagesCopy = new LinkedList(this.queuedMessages); - this.queuedMessages.clear(); - } - - if (queuedMessagesCopy != null) { - while(!queuedMessagesCopy.isEmpty()) { - byte[] message = (byte[]) queuedMessagesCopy.remove(0); - - try { - write(message); - - this.syslog.setBackLogStatus(false); - - } catch (SyslogRuntimeException sre) { - this.syslog.backLog(SyslogConstants.LEVEL_INFO,SyslogUtility.newString(this.syslog.getConfig(),message),sre); - } - } - } - - SyslogUtility.sleep(this.syslogConfig.getThreadLoopInterval()); - } - - runCompleted(); - } + public void initialize(AbstractSyslog abstractSyslog) { + this.syslog = abstractSyslog; + + try { + this.syslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); + + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must implement interface AbstractSyslogConfigIF"); + } + + if (this.syslogConfig.isThreaded()) { + this.queuedMessages = new LinkedList(); + } + } + + public void queue(int level, byte[] message) { + synchronized (this.queuedMessages) { + if (this.syslogConfig.getMaxQueueSize() == -1 || this.queuedMessages.size() < this.syslogConfig.getMaxQueueSize()) { + this.queuedMessages.add(message); + + } else { + this.syslog.backLog(level, SyslogUtility.newString(syslogConfig, message), "MaxQueueSize (" + this.syslogConfig.getMaxQueueSize() + ") reached"); + } + } + } + + public void setThread(Thread thread) { + this.thread = thread; + } + + public boolean hasThread() { + return this.thread != null && this.thread.isAlive(); + } + + public abstract void write(byte[] message); + + public abstract void flush(); + + public abstract void shutdown(); + + protected abstract void runCompleted(); + + public void run() { + while (!this.shutdown || !this.queuedMessages.isEmpty()) { + List queuedMessagesCopy = null; + + synchronized (this.queuedMessages) { + queuedMessagesCopy = new LinkedList(this.queuedMessages); + this.queuedMessages.clear(); + } + + if (queuedMessagesCopy != null) { + while (!queuedMessagesCopy.isEmpty()) { + byte[] message = (byte[]) queuedMessagesCopy.remove(0); + + try { + write(message); + + this.syslog.setBackLogStatus(false); + + } catch (SyslogRuntimeException sre) { + this.syslog.backLog(SyslogConstants.LEVEL_INFO, SyslogUtility.newString(this.syslog.getConfig(), message), sre); + } + } + } + + SyslogUtility.sleep(this.syslogConfig.getThreadLoopInterval()); + } + + runCompleted(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/AbstractSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/AbstractSyslogBackLogHandler.java index aebb4fc..2506c9d 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/AbstractSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/AbstractSyslogBackLogHandler.java @@ -5,32 +5,32 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslogBackLogHandler is an implementation of SyslogBackLogHandlerIF -* that mainly provides the helpful "combine" method for handling the "reason" -* why a BackLog has occurred. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogBackLogHandler.java,v 1.1 2009/01/24 22:00:18 cvs Exp $ -*/ + * AbstractSyslogBackLogHandler is an implementation of SyslogBackLogHandlerIF + * that mainly provides the helpful "combine" method for handling the "reason" + * why a BackLog has occurred. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogBackLogHandler.java,v 1.1 2009/01/24 22:00:18 cvs Exp $ + */ public abstract class AbstractSyslogBackLogHandler implements SyslogBackLogHandlerIF { - protected boolean appendReason = true; + protected boolean appendReason = true; - protected String combine(SyslogIF syslog, int level, String message, String reason) { - // Note: syslog is explicitly ignored by default - - String _message = message != null ? message : "UNKNOWN"; - String _reason = reason != null ? reason : "UNKNOWN"; - - String combinedMessage = SyslogUtility.getLevelString(level) + " " + _message; - - if (this.appendReason) { - combinedMessage += " [" + _reason + "]"; - } - - return combinedMessage; - } + protected String combine(SyslogIF syslog, int level, String message, String reason) { + // Note: syslog is explicitly ignored by default + + String _message = message != null ? message : "UNKNOWN"; + String _reason = reason != null ? reason : "UNKNOWN"; + + String combinedMessage = SyslogUtility.getLevelString(level) + " " + _message; + + if (this.appendReason) { + combinedMessage += " [" + _reason + "]"; + } + + return combinedMessage; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/NullSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/NullSyslogBackLogHandler.java index d4f4911..9f78182 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/NullSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/NullSyslogBackLogHandler.java @@ -4,32 +4,32 @@ import org.graylog2.syslog4j.SyslogBackLogHandlerIF; import org.graylog2.syslog4j.SyslogIF; /** -* NullSyslogBackLogHandler can be used if there's no need for a last-chance -* logging mechanism whenever the Syslog protocol fails. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: NullSyslogBackLogHandler.java,v 1.2 2010/10/25 03:50:25 cvs Exp $ -*/ + * NullSyslogBackLogHandler can be used if there's no need for a last-chance + * logging mechanism whenever the Syslog protocol fails. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: NullSyslogBackLogHandler.java,v 1.2 2010/10/25 03:50:25 cvs Exp $ + */ public class NullSyslogBackLogHandler implements SyslogBackLogHandlerIF { - public static final NullSyslogBackLogHandler INSTANCE = new NullSyslogBackLogHandler(); - - public void initialize() { - // - } + public static final NullSyslogBackLogHandler INSTANCE = new NullSyslogBackLogHandler(); - public void down(SyslogIF syslog, String reason) { - // - } + public void initialize() { + // + } - public void up(SyslogIF syslog) { - // - } + public void down(SyslogIF syslog, String reason) { + // + } - public void log(SyslogIF syslog, int level, String message, String reason) { - // - } + public void up(SyslogIF syslog) { + // + } + + public void log(SyslogIF syslog, int level, String message, String reason) { + // + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/Syslog4jBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/Syslog4jBackLogHandler.java index abf467d..f59373c 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/Syslog4jBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/Syslog4jBackLogHandler.java @@ -6,62 +6,62 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* Syslog4jBackLogHandler is used to send Syslog backLog messages to -* another Syslog4j protocol whenever the main Syslog protocol fails. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: Syslog4jBackLogHandler.java,v 1.1 2009/07/25 18:42:47 cvs Exp $ -*/ + * Syslog4jBackLogHandler is used to send Syslog backLog messages to + * another Syslog4j protocol whenever the main Syslog protocol fails. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: Syslog4jBackLogHandler.java,v 1.1 2009/07/25 18:42:47 cvs Exp $ + */ public class Syslog4jBackLogHandler extends AbstractSyslogBackLogHandler { - protected SyslogIF syslog = null; - protected int downLevel = SyslogConstants.LEVEL_WARN; - protected int upLevel = SyslogConstants.LEVEL_WARN; + protected SyslogIF syslog = null; + protected int downLevel = SyslogConstants.LEVEL_WARN; + protected int upLevel = SyslogConstants.LEVEL_WARN; - public Syslog4jBackLogHandler(String protocol) { - this.syslog = Syslog.getInstance(protocol); - } - - public Syslog4jBackLogHandler(String protocol, boolean appendReason) { - this.syslog = Syslog.getInstance(protocol); - this.appendReason = appendReason; - } - - public Syslog4jBackLogHandler(SyslogIF syslog) { - this.syslog = syslog; - } - - public Syslog4jBackLogHandler(SyslogIF syslog, boolean appendReason) { - this.syslog = syslog; - this.appendReason = appendReason; - } - - public void initialize() throws SyslogRuntimeException { - // NO-OP - } + public Syslog4jBackLogHandler(String protocol) { + this.syslog = Syslog.getInstance(protocol); + } - public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException { - if (this.syslog.getProtocol().equals(syslog.getProtocol())) { - throw new SyslogRuntimeException("Ignoring this log entry since the backLog protocol \"" + this.syslog.getProtocol() + "\" is the same as the main protocol"); - } - - String combinedMessage = combine(syslog,level,message,reason); - - this.syslog.log(level,combinedMessage); - } + public Syslog4jBackLogHandler(String protocol, boolean appendReason) { + this.syslog = Syslog.getInstance(protocol); + this.appendReason = appendReason; + } - public void down(SyslogIF syslog, String reason) { - if (!this.syslog.getProtocol().equals(syslog.getProtocol())) { - this.syslog.log(this.downLevel,"Syslog protocol \"" + syslog.getProtocol() + "\" is down: " + reason); - } - } + public Syslog4jBackLogHandler(SyslogIF syslog) { + this.syslog = syslog; + } - public void up(SyslogIF syslog) { - if (!this.syslog.getProtocol().equals(syslog.getProtocol())) { - this.syslog.log(this.downLevel,"Syslog protocol \"" + syslog.getProtocol() + "\" is up"); - } - } + public Syslog4jBackLogHandler(SyslogIF syslog, boolean appendReason) { + this.syslog = syslog; + this.appendReason = appendReason; + } + + public void initialize() throws SyslogRuntimeException { + // NO-OP + } + + public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException { + if (this.syslog.getProtocol().equals(syslog.getProtocol())) { + throw new SyslogRuntimeException("Ignoring this log entry since the backLog protocol \"" + this.syslog.getProtocol() + "\" is the same as the main protocol"); + } + + String combinedMessage = combine(syslog, level, message, reason); + + this.syslog.log(level, combinedMessage); + } + + public void down(SyslogIF syslog, String reason) { + if (!this.syslog.getProtocol().equals(syslog.getProtocol())) { + this.syslog.log(this.downLevel, "Syslog protocol \"" + syslog.getProtocol() + "\" is down: " + reason); + } + } + + public void up(SyslogIF syslog) { + if (!this.syslog.getProtocol().equals(syslog.getProtocol())) { + this.syslog.log(this.downLevel, "Syslog protocol \"" + syslog.getProtocol() + "\" is up"); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/log4j/Log4jSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/log4j/Log4jSyslogBackLogHandler.java index 99319aa..5e91b92 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/log4j/Log4jSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/log4j/Log4jSyslogBackLogHandler.java @@ -9,140 +9,148 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.backlog.AbstractSyslogBackLogHandler; /** -* Log4jSyslogBackLogHandler is used to send Syslog backLog messages to -* Log4j whenever the Syslog protocol fails. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: Log4jSyslogBackLogHandler.java,v 1.2 2009/07/22 15:54:23 cvs Exp $ -*/ + * Log4jSyslogBackLogHandler is used to send Syslog backLog messages to + * Log4j whenever the Syslog protocol fails. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: Log4jSyslogBackLogHandler.java,v 1.2 2009/07/22 15:54:23 cvs Exp $ + */ public class Log4jSyslogBackLogHandler extends AbstractSyslogBackLogHandler { - protected Logger logger = null; - protected Level downLevel = Level.WARN; - protected Level upLevel = Level.WARN; - - public Log4jSyslogBackLogHandler(Logger logger) throws SyslogRuntimeException { - this.logger = logger; - - initialize(); - } + protected Logger logger = null; + protected Level downLevel = Level.WARN; + protected Level upLevel = Level.WARN; - public Log4jSyslogBackLogHandler(Logger logger, boolean appendReason) { - this.logger = logger; - this.appendReason = appendReason; + public Log4jSyslogBackLogHandler(Logger logger) throws SyslogRuntimeException { + this.logger = logger; - initialize(); - } + initialize(); + } - public Log4jSyslogBackLogHandler(Class loggerClass) { - if (loggerClass == null) { - throw new SyslogRuntimeException("loggerClass cannot be null"); - } - - this.logger = Logger.getLogger(loggerClass); - - initialize(); - } + public Log4jSyslogBackLogHandler(Logger logger, boolean appendReason) { + this.logger = logger; + this.appendReason = appendReason; - public Log4jSyslogBackLogHandler(Class loggerClass, boolean appendReason) { - if (loggerClass == null) { - throw new SyslogRuntimeException("loggerClass cannot be null"); - } - - this.logger = Logger.getLogger(loggerClass); - this.appendReason = appendReason; - - initialize(); - } + initialize(); + } - public Log4jSyslogBackLogHandler(String loggerName) { - if (loggerName == null) { - throw new SyslogRuntimeException("loggerName cannot be null"); - } - - this.logger = Logger.getLogger(loggerName); + public Log4jSyslogBackLogHandler(Class loggerClass) { + if (loggerClass == null) { + throw new SyslogRuntimeException("loggerClass cannot be null"); + } - initialize(); - } + this.logger = Logger.getLogger(loggerClass); - public Log4jSyslogBackLogHandler(String loggerName, boolean appendReason) { - if (loggerName == null) { - throw new SyslogRuntimeException("loggerName cannot be null"); - } - - this.logger = Logger.getLogger(loggerName); - this.appendReason = appendReason; + initialize(); + } - initialize(); - } + public Log4jSyslogBackLogHandler(Class loggerClass, boolean appendReason) { + if (loggerClass == null) { + throw new SyslogRuntimeException("loggerClass cannot be null"); + } - public Log4jSyslogBackLogHandler(String loggerName, LoggerFactory loggerFactory) { - if (loggerName == null) { - throw new SyslogRuntimeException("loggerName cannot be null"); - } - - if (loggerFactory == null) { - throw new SyslogRuntimeException("loggerFactory cannot be null"); - } - - this.logger = Logger.getLogger(loggerName,loggerFactory); + this.logger = Logger.getLogger(loggerClass); + this.appendReason = appendReason; - initialize(); - } - - public Log4jSyslogBackLogHandler(String loggerName, LoggerFactory loggerFactory, boolean appendReason) { - if (loggerName == null) { - throw new SyslogRuntimeException("loggerName cannot be null"); - } - - if (loggerFactory == null) { - throw new SyslogRuntimeException("loggerFactory cannot be null"); - } - - this.logger = Logger.getLogger(loggerName,loggerFactory); - this.appendReason = appendReason; + initialize(); + } - initialize(); - } + public Log4jSyslogBackLogHandler(String loggerName) { + if (loggerName == null) { + throw new SyslogRuntimeException("loggerName cannot be null"); + } - public void initialize() throws SyslogRuntimeException { - if (this.logger == null) { - throw new SyslogRuntimeException("logger cannot be null"); - } - } - - protected static Level getLog4jLevel(int level) { - switch(level) { - case SyslogConstants.LEVEL_DEBUG: return Level.DEBUG; - case SyslogConstants.LEVEL_INFO: return Level.INFO; - case SyslogConstants.LEVEL_NOTICE: return Level.INFO; - case SyslogConstants.LEVEL_WARN: return Level.WARN; - case SyslogConstants.LEVEL_ERROR: return Level.ERROR; - case SyslogConstants.LEVEL_CRITICAL: return Level.ERROR; - case SyslogConstants.LEVEL_ALERT: return Level.ERROR; - case SyslogConstants.LEVEL_EMERGENCY: return Level.FATAL; - - default: - return Level.WARN; - } - } - - public void down(SyslogIF syslog, String reason) { - this.logger.log(this.downLevel,"Syslog protocol \"" + syslog.getProtocol() + "\" is down: " + reason); - } + this.logger = Logger.getLogger(loggerName); - public void up(SyslogIF syslog) { - this.logger.log(this.upLevel,"Syslog protocol \"" + syslog.getProtocol() + "\" is up"); - } + initialize(); + } - public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException { - Level log4jLevel = getLog4jLevel(level); - - String combinedMessage = combine(syslog,level,message,reason); - - this.logger.log(log4jLevel,combinedMessage); - } + public Log4jSyslogBackLogHandler(String loggerName, boolean appendReason) { + if (loggerName == null) { + throw new SyslogRuntimeException("loggerName cannot be null"); + } + + this.logger = Logger.getLogger(loggerName); + this.appendReason = appendReason; + + initialize(); + } + + public Log4jSyslogBackLogHandler(String loggerName, LoggerFactory loggerFactory) { + if (loggerName == null) { + throw new SyslogRuntimeException("loggerName cannot be null"); + } + + if (loggerFactory == null) { + throw new SyslogRuntimeException("loggerFactory cannot be null"); + } + + this.logger = Logger.getLogger(loggerName, loggerFactory); + + initialize(); + } + + public Log4jSyslogBackLogHandler(String loggerName, LoggerFactory loggerFactory, boolean appendReason) { + if (loggerName == null) { + throw new SyslogRuntimeException("loggerName cannot be null"); + } + + if (loggerFactory == null) { + throw new SyslogRuntimeException("loggerFactory cannot be null"); + } + + this.logger = Logger.getLogger(loggerName, loggerFactory); + this.appendReason = appendReason; + + initialize(); + } + + public void initialize() throws SyslogRuntimeException { + if (this.logger == null) { + throw new SyslogRuntimeException("logger cannot be null"); + } + } + + protected static Level getLog4jLevel(int level) { + switch (level) { + case SyslogConstants.LEVEL_DEBUG: + return Level.DEBUG; + case SyslogConstants.LEVEL_INFO: + return Level.INFO; + case SyslogConstants.LEVEL_NOTICE: + return Level.INFO; + case SyslogConstants.LEVEL_WARN: + return Level.WARN; + case SyslogConstants.LEVEL_ERROR: + return Level.ERROR; + case SyslogConstants.LEVEL_CRITICAL: + return Level.ERROR; + case SyslogConstants.LEVEL_ALERT: + return Level.ERROR; + case SyslogConstants.LEVEL_EMERGENCY: + return Level.FATAL; + + default: + return Level.WARN; + } + } + + public void down(SyslogIF syslog, String reason) { + this.logger.log(this.downLevel, "Syslog protocol \"" + syslog.getProtocol() + "\" is down: " + reason); + } + + public void up(SyslogIF syslog) { + this.logger.log(this.upLevel, "Syslog protocol \"" + syslog.getProtocol() + "\" is up"); + } + + public void log(SyslogIF syslog, int level, String message, String reason) throws SyslogRuntimeException { + Level log4jLevel = getLog4jLevel(level); + + String combinedMessage = combine(syslog, level, message, reason); + + this.logger.log(log4jLevel, combinedMessage); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/PrintStreamSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/PrintStreamSyslogBackLogHandler.java index ee65a4e..cfec9f3 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/PrintStreamSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/PrintStreamSyslogBackLogHandler.java @@ -7,63 +7,63 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.backlog.AbstractSyslogBackLogHandler; /** -* PrintStreamSyslogBackLogHandler provides a last-chance mechanism to log messages that fail -* (for whatever reason) within the rest of Syslog to a PrintStream. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PrintStreamSyslogBackLogHandler.java,v 1.1 2009/01/24 22:00:18 cvs Exp $ -*/ + * PrintStreamSyslogBackLogHandler provides a last-chance mechanism to log messages that fail + * (for whatever reason) within the rest of Syslog to a PrintStream. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PrintStreamSyslogBackLogHandler.java,v 1.1 2009/01/24 22:00:18 cvs Exp $ + */ public class PrintStreamSyslogBackLogHandler extends AbstractSyslogBackLogHandler { - protected PrintStream printStream = null; - protected boolean appendLinefeed = false; - - public PrintStreamSyslogBackLogHandler(PrintStream printStream) { - this.printStream = printStream; - - initialize(); - } + protected PrintStream printStream = null; + protected boolean appendLinefeed = false; - public PrintStreamSyslogBackLogHandler(PrintStream printStream, boolean appendLinefeed) { - this.printStream = printStream; - this.appendLinefeed = appendLinefeed; - - initialize(); - } + public PrintStreamSyslogBackLogHandler(PrintStream printStream) { + this.printStream = printStream; - public PrintStreamSyslogBackLogHandler(PrintStream printStream, boolean appendLinefeed, boolean appendReason) { - this.printStream = printStream; - this.appendLinefeed = appendLinefeed; - this.appendReason = appendReason; - - initialize(); - } + initialize(); + } - public void initialize() throws SyslogRuntimeException { - if (this.printStream == null) { - throw new SyslogRuntimeException("PrintStream cannot be null"); - } - } + public PrintStreamSyslogBackLogHandler(PrintStream printStream, boolean appendLinefeed) { + this.printStream = printStream; + this.appendLinefeed = appendLinefeed; - public void down(SyslogIF syslog, String reason) { - this.printStream.println(syslog.getProtocol() + ": DOWN" + (reason != null && !"".equals(reason.trim()) ? " (" + reason + ")" : "")); - } + initialize(); + } - public void up(SyslogIF syslog) { - this.printStream.println(syslog.getProtocol() + ": UP"); - } + public PrintStreamSyslogBackLogHandler(PrintStream printStream, boolean appendLinefeed, boolean appendReason) { + this.printStream = printStream; + this.appendLinefeed = appendLinefeed; + this.appendReason = appendReason; - public void log(SyslogIF syslog, int level, String message, String reason) { - String combinedMessage = combine(syslog,level,message,reason); - - if (this.appendLinefeed) { - this.printStream.println(combinedMessage); - - } else { - this.printStream.print(combinedMessage); - } - } + initialize(); + } + + public void initialize() throws SyslogRuntimeException { + if (this.printStream == null) { + throw new SyslogRuntimeException("PrintStream cannot be null"); + } + } + + public void down(SyslogIF syslog, String reason) { + this.printStream.println(syslog.getProtocol() + ": DOWN" + (reason != null && !"".equals(reason.trim()) ? " (" + reason + ")" : "")); + } + + public void up(SyslogIF syslog) { + this.printStream.println(syslog.getProtocol() + ": UP"); + } + + public void log(SyslogIF syslog, int level, String message, String reason) { + String combinedMessage = combine(syslog, level, message, reason); + + if (this.appendLinefeed) { + this.printStream.println(combinedMessage); + + } else { + this.printStream.print(combinedMessage); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemErrSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemErrSyslogBackLogHandler.java index 56edb78..9b67445 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemErrSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemErrSyslogBackLogHandler.java @@ -3,25 +3,26 @@ package org.graylog2.syslog4j.impl.backlog.printstream; import org.graylog2.syslog4j.SyslogBackLogHandlerIF; /** -* SystemErrSyslogBackLogHandler provides a last-chance mechanism to log messages that fail -* (for whatever reason) within the rest of Syslog to System.err. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SystemErrSyslogBackLogHandler.java,v 1.2 2009/03/29 17:38:59 cvs Exp $ -*/ + * SystemErrSyslogBackLogHandler provides a last-chance mechanism to log messages that fail + * (for whatever reason) within the rest of Syslog to System.err. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SystemErrSyslogBackLogHandler.java,v 1.2 2009/03/29 17:38:59 cvs Exp $ + */ public class SystemErrSyslogBackLogHandler extends PrintStreamSyslogBackLogHandler { - public static final SyslogBackLogHandlerIF create() { - return new SystemErrSyslogBackLogHandler(); - } - - public SystemErrSyslogBackLogHandler() { - super(System.err,true); - } - public SystemErrSyslogBackLogHandler(boolean appendReason) { - super(System.err,true,appendReason); - } + public static final SyslogBackLogHandlerIF create() { + return new SystemErrSyslogBackLogHandler(); + } + + public SystemErrSyslogBackLogHandler() { + super(System.err, true); + } + + public SystemErrSyslogBackLogHandler(boolean appendReason) { + super(System.err, true, appendReason); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemOutSyslogBackLogHandler.java b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemOutSyslogBackLogHandler.java index 7634b7e..e6885e3 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemOutSyslogBackLogHandler.java +++ b/src/main/java/org/graylog2/syslog4j/impl/backlog/printstream/SystemOutSyslogBackLogHandler.java @@ -3,25 +3,26 @@ package org.graylog2.syslog4j.impl.backlog.printstream; import org.graylog2.syslog4j.SyslogBackLogHandlerIF; /** -* SystemOutSyslogBackLogHandler provides a last-chance mechanism to log messages that fail -* (for whatever reason) within the rest of Syslog to System.out. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SystemOutSyslogBackLogHandler.java,v 1.2 2009/03/29 17:38:59 cvs Exp $ -*/ + * SystemOutSyslogBackLogHandler provides a last-chance mechanism to log messages that fail + * (for whatever reason) within the rest of Syslog to System.out. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SystemOutSyslogBackLogHandler.java,v 1.2 2009/03/29 17:38:59 cvs Exp $ + */ public class SystemOutSyslogBackLogHandler extends PrintStreamSyslogBackLogHandler { - public static final SyslogBackLogHandlerIF create() { - return new SystemOutSyslogBackLogHandler(); - } - - public SystemOutSyslogBackLogHandler() { - super(System.out,true); - } - public SystemOutSyslogBackLogHandler(boolean appendReason) { - super(System.out,true,appendReason); - } + public static final SyslogBackLogHandlerIF create() { + return new SystemOutSyslogBackLogHandler(); + } + + public SystemOutSyslogBackLogHandler() { + super(System.out, true); + } + + public SystemOutSyslogBackLogHandler(boolean appendReason) { + super(System.out, true, appendReason); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppender.java b/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppender.java index efeae4b..2872112 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppender.java +++ b/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppender.java @@ -4,76 +4,76 @@ import org.apache.log4j.helpers.LogLog; /** * Syslog4jAppender provides a Log4j Appender wrapper for Syslog4j. - * + *

*

Note: Syslog4jAppender does NOT extend Log4j's SyslogAppender.

- * + *

*

Example log4j.xml configuration:

- * + *

* 

  * 
-   <appender name="Syslog4j" class="org.graylog2.syslog4j.impl.log4j.Syslog4jAppender">
-		<param name="Facility" value="user"/>
-		<param name="Protocol" value="tcp"/>
-		<param name="Host" value="192.168.0.1"/>
-		<layout class="org.apache.log4j.PatternLayout">
-			<param name="ConversionPattern" value="%d{ABSOLUTE} %-5p [%c{1}] %m"/>
-		</layout>
-   </appender>
+ * <appender name="Syslog4j" class="org.graylog2.syslog4j.impl.log4j.Syslog4jAppender">
+ * <param name="Facility" value="user"/>
+ * <param name="Protocol" value="tcp"/>
+ * <param name="Host" value="192.168.0.1"/>
+ * <layout class="org.apache.log4j.PatternLayout">
+ * <param name="ConversionPattern" value="%d{ABSOLUTE} %-5p [%c{1}] %m"/>
+ * </layout>
+ * </appender>
  * 
  *
- * + *

*

All available parameters are:

- * + *

*

    - *
  • ident
    • - *
  • localName
    • - *
  • protocol
    • - *
  • facility
    • - *
  • host
    • - *
  • port
    • - *
  • charSet
    • - *
  • threaded
    • - *
  • threadLoopInterval
    • - *
  • splitMessageBeginText
    • - *
  • splitMessageEndText
    • - *
  • maxMessageLength
    • - *
  • maxShutdownWait
    • - *
  • writeRetries
    • - *
  • truncateMessage
    • - *
  • useStructuredData
    • + *
  • ident
    • + *
  • localName
    • + *
  • protocol
    • + *
  • facility
    • + *
  • host
    • + *
  • port
    • + *
  • charSet
    • + *
  • threaded
    • + *
  • threadLoopInterval
    • + *
  • splitMessageBeginText
    • + *
  • splitMessageEndText
    • + *
  • maxMessageLength
    • + *
  • maxShutdownWait
    • + *
  • writeRetries
    • + *
  • truncateMessage
    • + *
  • useStructuredData
    • *
- * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: Syslog4jAppender.java,v 1.2 2011/01/23 20:49:12 cvs Exp $ */ public class Syslog4jAppender extends Syslog4jAppenderSkeleton { - private static final long serialVersionUID = -6072552977605816670L; - - public String initialize() { - if (this.protocol == null) { - this.protocol = UDP; - } - - return this.protocol; - } + private static final long serialVersionUID = -6072552977605816670L; - public boolean getHeader() { - return false; - } - - public void setHeader(boolean header) { - LogLog.warn("Syslog4jAppender ignores the \"Header\" parameter."); - } + public String initialize() { + if (this.protocol == null) { + this.protocol = UDP; + } - public String getSyslogHost() { - return this.host; - } + return this.protocol; + } - public void setSyslogHost(String host) { - this.host = host; - } + public boolean getHeader() { + return false; + } + + public void setHeader(boolean header) { + LogLog.warn("Syslog4jAppender ignores the \"Header\" parameter."); + } + + public String getSyslogHost() { + return this.host; + } + + public void setSyslogHost(String host) { + this.host = host; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppenderSkeleton.java b/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppenderSkeleton.java index 79a3ec9..0b9f0e6 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppenderSkeleton.java +++ b/src/main/java/org/graylog2/syslog4j/impl/log4j/Syslog4jAppenderSkeleton.java @@ -12,320 +12,320 @@ import org.graylog2.syslog4j.util.SyslogUtility; /** * Syslog4jAppenderSkeleton provides an extensible Log4j Appender wrapper for Syslog4j. - * + *

*

Classes which inherit Syslog4jAppenderSkeleton must implement the "initialize()" method, * which sets up Syslog4j for use by the Log4j Appender.

- * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: Syslog4jAppenderSkeleton.java,v 1.8 2011/01/23 20:49:12 cvs Exp $ */ public abstract class Syslog4jAppenderSkeleton extends AppenderSkeleton implements SyslogConstants { - private static final long serialVersionUID = 5520555788232095628L; + private static final long serialVersionUID = 5520555788232095628L; - protected SyslogIF syslog = null; - - protected String ident = null; - protected String localName = null; - protected String protocol = null; - protected String facility = null; - protected String host = null; - protected String port = null; - protected String charSet = null; - protected String threaded = null; - protected String threadLoopInterval = null; - protected String splitMessageBeginText = null; - protected String splitMessageEndText = null; - protected String maxMessageLength = null; - protected String maxShutdownWait = null; - protected String writeRetries = null; - protected String truncateMessage = null; - protected String useStructuredData = null; - - protected boolean initialized = false; - - public abstract String initialize() throws SyslogRuntimeException; - - protected static boolean isTrueOrOn(String value) { - boolean trueOrOn = false; - - if (value != null) { - if ("true".equalsIgnoreCase(value.trim()) || "on".equalsIgnoreCase(value.trim())) { - trueOrOn = true; - - } else if ("false".equalsIgnoreCase(value.trim()) || "off".equalsIgnoreCase(value.trim())) { - trueOrOn = false; - - } else { - LogLog.error("Value \"" + value + "\" not true, on, false, or off -- assuming false"); - } - } - - return trueOrOn; - } - - protected void _initialize() { - String initializedProtocol = initialize(); - - if (initializedProtocol != null && this.protocol == null) { - this.protocol = initializedProtocol; - } - - if (this.protocol != null) { - try { - this.syslog = Syslog.getInstance(this.protocol); - if (this.host != null) { - this.syslog.getConfig().setHost(this.host); - } - if (this.facility != null) { - this.syslog.getConfig().setFacility(SyslogUtility.getFacility(this.facility)); - } - if (this.port != null) { - try { - int i = Integer.parseInt(this.port); - this.syslog.getConfig().setPort(i); - - } catch (NumberFormatException nfe) { - LogLog.error(nfe.toString()); - } - } - if (this.charSet != null) { - this.syslog.getConfig().setCharSet(this.charSet); - } - if (this.ident != null) { - this.syslog.getConfig().setIdent(this.ident); - } - if (this.localName != null) { - this.syslog.getConfig().setLocalName(this.localName); - } - if (this.truncateMessage != null && !"".equals(this.truncateMessage.trim())) { - this.syslog.getConfig().setTruncateMessage(isTrueOrOn(this.truncateMessage)); - } - if (this.maxMessageLength != null && this.maxMessageLength.length() > 0) { - try { - int i = Integer.parseInt(this.maxMessageLength.trim()); - this.syslog.getConfig().setMaxMessageLength(i); - - } catch (NumberFormatException nfe) { - LogLog.error(nfe.toString()); - } - } - if (this.useStructuredData != null) { - this.syslog.getConfig().setUseStructuredData(isTrueOrOn(this.useStructuredData)); - } - if (this.syslog.getConfig() instanceof AbstractSyslogConfigIF) { - AbstractSyslogConfigIF abstractSyslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); - - if (this.threaded != null && !"".equals(this.threaded.trim())) { - abstractSyslogConfig.setThreaded(isTrueOrOn(this.threaded)); - } + protected SyslogIF syslog = null; - if (this.threadLoopInterval != null && this.threadLoopInterval.length() > 0) { - try { - long l = Long.parseLong(this.threadLoopInterval.trim()); - abstractSyslogConfig.setThreadLoopInterval(l); - - } catch (NumberFormatException nfe) { - LogLog.error(nfe.toString()); - } - } - - if (this.splitMessageBeginText != null) { - abstractSyslogConfig.setSplitMessageBeginText(SyslogUtility.getBytes(abstractSyslogConfig,this.splitMessageBeginText)); - } + protected String ident = null; + protected String localName = null; + protected String protocol = null; + protected String facility = null; + protected String host = null; + protected String port = null; + protected String charSet = null; + protected String threaded = null; + protected String threadLoopInterval = null; + protected String splitMessageBeginText = null; + protected String splitMessageEndText = null; + protected String maxMessageLength = null; + protected String maxShutdownWait = null; + protected String writeRetries = null; + protected String truncateMessage = null; + protected String useStructuredData = null; - if (this.splitMessageEndText != null) { - abstractSyslogConfig.setSplitMessageEndText(SyslogUtility.getBytes(abstractSyslogConfig,this.splitMessageEndText)); - } - - if (this.maxShutdownWait != null && this.maxShutdownWait.length() > 0) { - try { - int i = Integer.parseInt(this.maxShutdownWait.trim()); - abstractSyslogConfig.setMaxShutdownWait(i); - - } catch (NumberFormatException nfe) { - LogLog.error(nfe.toString()); - } - } - - if (this.writeRetries != null && this.writeRetries.length() > 0) { - try { - int i = Integer.parseInt(this.writeRetries.trim()); - abstractSyslogConfig.setWriteRetries(i); - - } catch (NumberFormatException nfe) { - LogLog.error(nfe.toString()); - } - } - } - - this.initialized = true; - - } catch (SyslogRuntimeException sre) { - LogLog.error(sre.toString()); - } - } - } - - public String getProtocol() { - return this.protocol; - } + protected boolean initialized = false; - public void setProtocol(String protocol) { - this.protocol = protocol; - } + public abstract String initialize() throws SyslogRuntimeException; - protected void append(LoggingEvent event) { - if (!this.initialized) { - _initialize(); - } - - if (this.initialized) { - int level = event.getLevel().getSyslogEquivalent(); - - if (this.layout != null) { - String message = this.layout.format(event); - - this.syslog.log(level,message); - - } else { - String message = event.getRenderedMessage(); - - this.syslog.log(level,message); - } - } - } + protected static boolean isTrueOrOn(String value) { + boolean trueOrOn = false; - public void close() { - if (this.syslog != null) { - this.syslog.flush(); - } - } + if (value != null) { + if ("true".equalsIgnoreCase(value.trim()) || "on".equalsIgnoreCase(value.trim())) { + trueOrOn = true; - public String getFacility() { - return this.facility; - } + } else if ("false".equalsIgnoreCase(value.trim()) || "off".equalsIgnoreCase(value.trim())) { + trueOrOn = false; - public void setFacility(String facility) { - this.facility = facility; - } + } else { + LogLog.error("Value \"" + value + "\" not true, on, false, or off -- assuming false"); + } + } - public String getHost() { - return this.host; - } + return trueOrOn; + } - public void setHost(String host) { - this.host = host; - } + protected void _initialize() { + String initializedProtocol = initialize(); - public String getLocalName() { - return localName; - } + if (initializedProtocol != null && this.protocol == null) { + this.protocol = initializedProtocol; + } - public void setLocalName(String localName) { - this.localName = localName; - } + if (this.protocol != null) { + try { + this.syslog = Syslog.getInstance(this.protocol); + if (this.host != null) { + this.syslog.getConfig().setHost(this.host); + } + if (this.facility != null) { + this.syslog.getConfig().setFacility(SyslogUtility.getFacility(this.facility)); + } + if (this.port != null) { + try { + int i = Integer.parseInt(this.port); + this.syslog.getConfig().setPort(i); - public String getPort() { - return this.port; - } + } catch (NumberFormatException nfe) { + LogLog.error(nfe.toString()); + } + } + if (this.charSet != null) { + this.syslog.getConfig().setCharSet(this.charSet); + } + if (this.ident != null) { + this.syslog.getConfig().setIdent(this.ident); + } + if (this.localName != null) { + this.syslog.getConfig().setLocalName(this.localName); + } + if (this.truncateMessage != null && !"".equals(this.truncateMessage.trim())) { + this.syslog.getConfig().setTruncateMessage(isTrueOrOn(this.truncateMessage)); + } + if (this.maxMessageLength != null && this.maxMessageLength.length() > 0) { + try { + int i = Integer.parseInt(this.maxMessageLength.trim()); + this.syslog.getConfig().setMaxMessageLength(i); - public void setPort(String port) { - this.port = port; - } - - public String getCharSet() { - return this.charSet; - } + } catch (NumberFormatException nfe) { + LogLog.error(nfe.toString()); + } + } + if (this.useStructuredData != null) { + this.syslog.getConfig().setUseStructuredData(isTrueOrOn(this.useStructuredData)); + } + if (this.syslog.getConfig() instanceof AbstractSyslogConfigIF) { + AbstractSyslogConfigIF abstractSyslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); - public void setCharSet(String charSet) { - this.charSet = charSet; - } + if (this.threaded != null && !"".equals(this.threaded.trim())) { + abstractSyslogConfig.setThreaded(isTrueOrOn(this.threaded)); + } - public String getIdent() { - return this.ident; - } + if (this.threadLoopInterval != null && this.threadLoopInterval.length() > 0) { + try { + long l = Long.parseLong(this.threadLoopInterval.trim()); + abstractSyslogConfig.setThreadLoopInterval(l); - public void setIdent(String ident) { - this.ident = ident; - } + } catch (NumberFormatException nfe) { + LogLog.error(nfe.toString()); + } + } - public String getThreaded() { - return this.threaded; - } + if (this.splitMessageBeginText != null) { + abstractSyslogConfig.setSplitMessageBeginText(SyslogUtility.getBytes(abstractSyslogConfig, this.splitMessageBeginText)); + } - public void setThreaded(String threaded) { - this.threaded = threaded; - } + if (this.splitMessageEndText != null) { + abstractSyslogConfig.setSplitMessageEndText(SyslogUtility.getBytes(abstractSyslogConfig, this.splitMessageEndText)); + } - public boolean requiresLayout() { - return false; - } + if (this.maxShutdownWait != null && this.maxShutdownWait.length() > 0) { + try { + int i = Integer.parseInt(this.maxShutdownWait.trim()); + abstractSyslogConfig.setMaxShutdownWait(i); - public String getThreadLoopInterval() { - return this.threadLoopInterval; - } + } catch (NumberFormatException nfe) { + LogLog.error(nfe.toString()); + } + } - public void setThreadLoopInterval(String threadLoopInterval) { - this.threadLoopInterval = threadLoopInterval; - } + if (this.writeRetries != null && this.writeRetries.length() > 0) { + try { + int i = Integer.parseInt(this.writeRetries.trim()); + abstractSyslogConfig.setWriteRetries(i); - public String getSplitMessageBeginText() { - return this.splitMessageBeginText; - } + } catch (NumberFormatException nfe) { + LogLog.error(nfe.toString()); + } + } + } - public void setSplitMessageBeginText(String splitMessageBeginText) { - this.splitMessageBeginText = splitMessageBeginText; - } + this.initialized = true; - public String getSplitMessageEndText() { - return this.splitMessageEndText; - } + } catch (SyslogRuntimeException sre) { + LogLog.error(sre.toString()); + } + } + } - public void setSplitMessageEndText(String splitMessageEndText) { - this.splitMessageEndText = splitMessageEndText; - } + public String getProtocol() { + return this.protocol; + } - public String getMaxMessageLength() { - return this.maxMessageLength; - } + public void setProtocol(String protocol) { + this.protocol = protocol; + } - public void setMaxMessageLength(String maxMessageLength) { - this.maxMessageLength = maxMessageLength; - } + protected void append(LoggingEvent event) { + if (!this.initialized) { + _initialize(); + } - public String getMaxShutdownWait() { - return this.maxShutdownWait; - } + if (this.initialized) { + int level = event.getLevel().getSyslogEquivalent(); - public void setMaxShutdownWait(String maxShutdownWait) { - this.maxShutdownWait = maxShutdownWait; - } + if (this.layout != null) { + String message = this.layout.format(event); - public String getWriteRetries() { - return this.writeRetries; - } + this.syslog.log(level, message); - public void setWriteRetries(String writeRetries) { - this.writeRetries = writeRetries; - } + } else { + String message = event.getRenderedMessage(); - public String getTruncateMessage() { - return this.truncateMessage; - } + this.syslog.log(level, message); + } + } + } - public void setTruncateMessage(String truncateMessage) { - this.truncateMessage = truncateMessage; - } + public void close() { + if (this.syslog != null) { + this.syslog.flush(); + } + } - public String getUseStructuredData() { - return useStructuredData; - } + public String getFacility() { + return this.facility; + } - public void setUseStructuredData(String useStructuredData) { - this.useStructuredData = useStructuredData; - } + public void setFacility(String facility) { + this.facility = facility; + } + + public String getHost() { + return this.host; + } + + public void setHost(String host) { + this.host = host; + } + + public String getLocalName() { + return localName; + } + + public void setLocalName(String localName) { + this.localName = localName; + } + + public String getPort() { + return this.port; + } + + public void setPort(String port) { + this.port = port; + } + + public String getCharSet() { + return this.charSet; + } + + public void setCharSet(String charSet) { + this.charSet = charSet; + } + + public String getIdent() { + return this.ident; + } + + public void setIdent(String ident) { + this.ident = ident; + } + + public String getThreaded() { + return this.threaded; + } + + public void setThreaded(String threaded) { + this.threaded = threaded; + } + + public boolean requiresLayout() { + return false; + } + + public String getThreadLoopInterval() { + return this.threadLoopInterval; + } + + public void setThreadLoopInterval(String threadLoopInterval) { + this.threadLoopInterval = threadLoopInterval; + } + + public String getSplitMessageBeginText() { + return this.splitMessageBeginText; + } + + public void setSplitMessageBeginText(String splitMessageBeginText) { + this.splitMessageBeginText = splitMessageBeginText; + } + + public String getSplitMessageEndText() { + return this.splitMessageEndText; + } + + public void setSplitMessageEndText(String splitMessageEndText) { + this.splitMessageEndText = splitMessageEndText; + } + + public String getMaxMessageLength() { + return this.maxMessageLength; + } + + public void setMaxMessageLength(String maxMessageLength) { + this.maxMessageLength = maxMessageLength; + } + + public String getMaxShutdownWait() { + return this.maxShutdownWait; + } + + public void setMaxShutdownWait(String maxShutdownWait) { + this.maxShutdownWait = maxShutdownWait; + } + + public String getWriteRetries() { + return this.writeRetries; + } + + public void setWriteRetries(String writeRetries) { + this.writeRetries = writeRetries; + } + + public String getTruncateMessage() { + return this.truncateMessage; + } + + public void setTruncateMessage(String truncateMessage) { + this.truncateMessage = truncateMessage; + } + + public String getUseStructuredData() { + return useStructuredData; + } + + public void setUseStructuredData(String useStructuredData) { + this.useStructuredData = useStructuredData; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/AbstractSyslogMessage.java b/src/main/java/org/graylog2/syslog4j/impl/message/AbstractSyslogMessage.java index d23ef82..a2f290a 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/AbstractSyslogMessage.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/AbstractSyslogMessage.java @@ -8,94 +8,94 @@ import java.util.Date; import org.graylog2.syslog4j.SyslogMessageIF; /** -* AbstractSyslogMessage provides support for turning POJO (Plain Ol' -* Java Objects) into Syslog messages. -* -*

More information on the PCI DSS specification is available here:

-* -*

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogMessage.java,v 1.2 2009/04/17 02:37:04 cvs Exp $ -*/ + * AbstractSyslogMessage provides support for turning POJO (Plain Ol' + * Java Objects) into Syslog messages. + *

+ *

More information on the PCI DSS specification is available here:

+ *

+ *

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogMessage.java,v 1.2 2009/04/17 02:37:04 cvs Exp $ + */ public abstract class AbstractSyslogMessage implements SyslogMessageIF { - private static final long serialVersionUID = 414124277626756491L; + private static final long serialVersionUID = 414124277626756491L; - public static final String UNDEFINED = "undefined"; - - public static final String DEFAULT_DATE_FORMAT = "yyyy/MM/dd"; - public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss"; + public static final String UNDEFINED = "undefined"; - public static final char DEFAULT_DELIMITER = ' '; - public static final String DEFAULT_REPLACE_DELIMITER = "_"; - - protected char getDelimiter() { - return DEFAULT_DELIMITER; - } + public static final String DEFAULT_DATE_FORMAT = "yyyy/MM/dd"; + public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss"; - protected String getReplaceDelimiter() { - return DEFAULT_REPLACE_DELIMITER; - } + public static final char DEFAULT_DELIMITER = ' '; + public static final String DEFAULT_REPLACE_DELIMITER = "_"; - protected String getDateFormat() { - return DEFAULT_DATE_FORMAT; - } + protected char getDelimiter() { + return DEFAULT_DELIMITER; + } - protected String getTimeFormat() { - return DEFAULT_TIME_FORMAT; - } - - protected String generateDate() { - String date = new SimpleDateFormat(getDateFormat()).format(new Date()); - - return date; - } + protected String getReplaceDelimiter() { + return DEFAULT_REPLACE_DELIMITER; + } - protected String generateTime() { - String time = new SimpleDateFormat(getTimeFormat()).format(new Date()); - - return time; - } + protected String getDateFormat() { + return DEFAULT_DATE_FORMAT; + } - protected String[] generateDateAndTime(Date date) { - String[] dateAndTime = new String[2]; - - dateAndTime[0] = new SimpleDateFormat(getDateFormat()).format(date); - dateAndTime[1] = new SimpleDateFormat(getTimeFormat()).format(date); - - return dateAndTime; - } + protected String getTimeFormat() { + return DEFAULT_TIME_FORMAT; + } - protected String generateLocalHostName() { - String localHostName = UNDEFINED; + protected String generateDate() { + String date = new SimpleDateFormat(getDateFormat()).format(new Date()); - try { - localHostName = InetAddress.getLocalHost().getHostName(); - - } catch (UnknownHostException uhe) { - // - } - - return localHostName; - } + return date; + } - protected boolean nullOrEmpty(String value) { - return (value == null || "".equals(value.trim())); - } + protected String generateTime() { + String time = new SimpleDateFormat(getTimeFormat()).format(new Date()); - protected String replaceDelimiter(String fieldName, String fieldValue, char delimiter, String replaceDelimiter) { - if (replaceDelimiter == null || replaceDelimiter.length() < 1 || fieldValue == null || fieldValue.length() < 1) { - return fieldValue; - } - - String newFieldValue = fieldValue.replaceAll("\\" + delimiter, replaceDelimiter); - - return newFieldValue; - } + return time; + } - public abstract String createMessage(); + protected String[] generateDateAndTime(Date date) { + String[] dateAndTime = new String[2]; + + dateAndTime[0] = new SimpleDateFormat(getDateFormat()).format(date); + dateAndTime[1] = new SimpleDateFormat(getTimeFormat()).format(date); + + return dateAndTime; + } + + protected String generateLocalHostName() { + String localHostName = UNDEFINED; + + try { + localHostName = InetAddress.getLocalHost().getHostName(); + + } catch (UnknownHostException uhe) { + // + } + + return localHostName; + } + + protected boolean nullOrEmpty(String value) { + return (value == null || "".equals(value.trim())); + } + + protected String replaceDelimiter(String fieldName, String fieldValue, char delimiter, String replaceDelimiter) { + if (replaceDelimiter == null || replaceDelimiter.length() < 1 || fieldValue == null || fieldValue.length() < 1) { + return fieldValue; + } + + String newFieldValue = fieldValue.replaceAll("\\" + delimiter, replaceDelimiter); + + return newFieldValue; + } + + public abstract String createMessage(); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifier.java index d721691..8b4d123 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifier.java @@ -4,60 +4,60 @@ import org.graylog2.syslog4j.SyslogMessageModifierConfigIF; import org.graylog2.syslog4j.SyslogMessageModifierIF; public abstract class AbstractSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = 7632959170109372003L; - - protected SyslogMessageModifierConfigIF messageModifierConfig = null; - - public AbstractSyslogMessageModifier(SyslogMessageModifierConfigIF messageModifierConfig) { - this.messageModifierConfig = messageModifierConfig; - } + private static final long serialVersionUID = 7632959170109372003L; - public String[] parseInlineModifier(String message) { - return parseInlineModifier(message,this.messageModifierConfig.getPrefix(),this.messageModifierConfig.getSuffix()); - } - - public static String[] parseInlineModifier(String message, String prefix, String suffix) { - String[] messageAndModifier = null; - - if (message == null || "".equals(message.trim())) { - return null; - } - - if (prefix == null || "".equals(prefix)) { - prefix = " "; - } - - if (suffix == null || "".equals(suffix)) { - int pi = message.lastIndexOf(prefix); - - if (pi > -1) { - messageAndModifier = new String[] { message.substring(0,pi), message.substring(pi+prefix.length()) }; - } - - } else { - int si = message.lastIndexOf(suffix); - - if (si > -1) { - int pi = message.lastIndexOf(prefix,si); - - if (pi > -1) { - messageAndModifier = new String[] { message.substring(0,pi), message.substring(pi+prefix.length(),si) }; - } - } - } - - return messageAndModifier; - } - - protected abstract boolean verify(String message, String modifier); - - public boolean verify(String message) { - String[] messageAndModifier = parseInlineModifier(message); - - if (messageAndModifier == null || messageAndModifier.length != 2) { - return false; - } - - return verify(messageAndModifier[0],messageAndModifier[1]); - } + protected SyslogMessageModifierConfigIF messageModifierConfig = null; + + public AbstractSyslogMessageModifier(SyslogMessageModifierConfigIF messageModifierConfig) { + this.messageModifierConfig = messageModifierConfig; + } + + public String[] parseInlineModifier(String message) { + return parseInlineModifier(message, this.messageModifierConfig.getPrefix(), this.messageModifierConfig.getSuffix()); + } + + public static String[] parseInlineModifier(String message, String prefix, String suffix) { + String[] messageAndModifier = null; + + if (message == null || "".equals(message.trim())) { + return null; + } + + if (prefix == null || "".equals(prefix)) { + prefix = " "; + } + + if (suffix == null || "".equals(suffix)) { + int pi = message.lastIndexOf(prefix); + + if (pi > -1) { + messageAndModifier = new String[]{message.substring(0, pi), message.substring(pi + prefix.length())}; + } + + } else { + int si = message.lastIndexOf(suffix); + + if (si > -1) { + int pi = message.lastIndexOf(prefix, si); + + if (pi > -1) { + messageAndModifier = new String[]{message.substring(0, pi), message.substring(pi + prefix.length(), si)}; + } + } + } + + return messageAndModifier; + } + + protected abstract boolean verify(String message, String modifier); + + public boolean verify(String message) { + String[] messageAndModifier = parseInlineModifier(message); + + if (messageAndModifier == null || messageAndModifier.length != 2) { + return false; + } + + return verify(messageAndModifier[0], messageAndModifier[1]); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifierConfig.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifierConfig.java index c508344..9c55d4b 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifierConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/AbstractSyslogMessageModifierConfig.java @@ -5,54 +5,54 @@ import org.graylog2.syslog4j.SyslogConstants; import org.graylog2.syslog4j.SyslogMessageModifierConfigIF; /** -* AbstractSyslogMessageModifierConfig provides a base abstract implementation of the -* SyslogMessageModifierConfigIF. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogMessageModifierConfig.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ -*/ + * AbstractSyslogMessageModifierConfig provides a base abstract implementation of the + * SyslogMessageModifierConfigIF. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogMessageModifierConfig.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ + */ public abstract class AbstractSyslogMessageModifierConfig implements SyslogMessageModifierConfigIF, SyslogCharSetIF { - private static final long serialVersionUID = 5036574188079124884L; - - protected String prefix = SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT; - protected String suffix = SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT; - protected String charSet = SyslogConstants.CHAR_SET_DEFAULT; - - public String getPrefix() { - return this.prefix; - } + private static final long serialVersionUID = 5036574188079124884L; - public String getSuffix() { - return this.suffix; - } + protected String prefix = SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT; + protected String suffix = SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT; + protected String charSet = SyslogConstants.CHAR_SET_DEFAULT; - public void setPrefix(String prefix) { - if (prefix == null) { - this.prefix = ""; - - } else { - this.prefix = prefix; - } - } + public String getPrefix() { + return this.prefix; + } - public void setSuffix(String suffix) { - if (suffix == null) { - this.suffix = ""; - - } else { - this.suffix = suffix; - } - } + public String getSuffix() { + return this.suffix; + } - public String getCharSet() { - return charSet; - } + public void setPrefix(String prefix) { + if (prefix == null) { + this.prefix = ""; - public void setCharSet(String charSet) { - this.charSet = charSet; - } + } else { + this.prefix = prefix; + } + } + + public void setSuffix(String suffix) { + if (suffix == null) { + this.suffix = ""; + + } else { + this.suffix = suffix; + } + } + + public String getCharSet() { + return charSet; + } + + public void setCharSet(String charSet) { + this.charSet = charSet; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifier.java index fefd948..d6a8a11 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifier.java @@ -6,96 +6,97 @@ import org.graylog2.syslog4j.impl.message.modifier.AbstractSyslogMessageModifier import org.graylog2.syslog4j.util.SyslogUtility; /** -* ChecksumSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for Java Checksum algorithms (java.util.zip.Checksum). -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: ChecksumSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ -*/ + * ChecksumSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for Java Checksum algorithms (java.util.zip.Checksum). + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: ChecksumSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ + */ public class ChecksumSyslogMessageModifier extends AbstractSyslogMessageModifier { - private static final long serialVersionUID = -3268914290497005065L; - - protected ChecksumSyslogMessageModifierConfig config = null; - - public static final ChecksumSyslogMessageModifier createCRC32() { - ChecksumSyslogMessageModifier crc32 = new ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig.createCRC32()); - - return crc32; - } - public static final ChecksumSyslogMessageModifier createADLER32() { - ChecksumSyslogMessageModifier adler32 = new ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig.createADLER32()); - - return adler32; - } - - public ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig config) { - super(config); - - this.config = config; - - if (this.config == null) { - throw new SyslogRuntimeException("Checksum config object cannot be null"); - } - - if (this.config.getChecksum() == null) { - throw new SyslogRuntimeException("Checksum object cannot be null"); - } - } - - public ChecksumSyslogMessageModifierConfig getConfig() { - return this.config; - } - - protected void continuousCheckForVerify() { - if (this.config.isContinuous()) { - throw new SyslogRuntimeException(this.getClass().getName() + ".verify(..) does not work with isContinuous() returning true"); - } - - } - - public boolean verify(String message, String hexChecksum) { - continuousCheckForVerify(); + private static final long serialVersionUID = -3268914290497005065L; - long checksum = Long.parseLong(hexChecksum,16); - - return verify(message,checksum); - } - - public boolean verify(String message, long checksum) { - continuousCheckForVerify(); - - synchronized(this.config.getChecksum()) { - this.config.getChecksum().reset(); - - byte[] messageBytes = SyslogUtility.getBytes(this.config,message); - - this.config.getChecksum().update(messageBytes,0,message.length()); - - return this.config.getChecksum().getValue() == checksum; - } - } + protected ChecksumSyslogMessageModifierConfig config = null; - public String modify(SyslogIF syslog, int facility, int level, String message) { - synchronized(this.config.getChecksum()) { - StringBuffer messageBuffer = new StringBuffer(message); - - byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(),message); - - if (!this.config.isContinuous()) { - this.config.getChecksum().reset(); - } - - this.config.getChecksum().update(messageBytes,0,message.length()); - - messageBuffer.append(this.config.getPrefix()); - messageBuffer.append(Long.toHexString(this.config.getChecksum().getValue()).toUpperCase()); - messageBuffer.append(this.config.getSuffix()); - - return messageBuffer.toString(); - } - } + public static final ChecksumSyslogMessageModifier createCRC32() { + ChecksumSyslogMessageModifier crc32 = new ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig.createCRC32()); + + return crc32; + } + + public static final ChecksumSyslogMessageModifier createADLER32() { + ChecksumSyslogMessageModifier adler32 = new ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig.createADLER32()); + + return adler32; + } + + public ChecksumSyslogMessageModifier(ChecksumSyslogMessageModifierConfig config) { + super(config); + + this.config = config; + + if (this.config == null) { + throw new SyslogRuntimeException("Checksum config object cannot be null"); + } + + if (this.config.getChecksum() == null) { + throw new SyslogRuntimeException("Checksum object cannot be null"); + } + } + + public ChecksumSyslogMessageModifierConfig getConfig() { + return this.config; + } + + protected void continuousCheckForVerify() { + if (this.config.isContinuous()) { + throw new SyslogRuntimeException(this.getClass().getName() + ".verify(..) does not work with isContinuous() returning true"); + } + + } + + public boolean verify(String message, String hexChecksum) { + continuousCheckForVerify(); + + long checksum = Long.parseLong(hexChecksum, 16); + + return verify(message, checksum); + } + + public boolean verify(String message, long checksum) { + continuousCheckForVerify(); + + synchronized (this.config.getChecksum()) { + this.config.getChecksum().reset(); + + byte[] messageBytes = SyslogUtility.getBytes(this.config, message); + + this.config.getChecksum().update(messageBytes, 0, message.length()); + + return this.config.getChecksum().getValue() == checksum; + } + } + + public String modify(SyslogIF syslog, int facility, int level, String message) { + synchronized (this.config.getChecksum()) { + StringBuffer messageBuffer = new StringBuffer(message); + + byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(), message); + + if (!this.config.isContinuous()) { + this.config.getChecksum().reset(); + } + + this.config.getChecksum().update(messageBytes, 0, message.length()); + + messageBuffer.append(this.config.getPrefix()); + messageBuffer.append(Long.toHexString(this.config.getChecksum().getValue()).toUpperCase()); + messageBuffer.append(this.config.getSuffix()); + + return messageBuffer.toString(); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifierConfig.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifierConfig.java index ea676fc..507609f 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifierConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/checksum/ChecksumSyslogMessageModifierConfig.java @@ -7,51 +7,51 @@ import java.util.zip.Checksum; import org.graylog2.syslog4j.impl.message.modifier.AbstractSyslogMessageModifierConfig; /** -* ChecksumSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig -* that provides configuration for ChecksumSyslogMessageModifier. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: ChecksumSyslogMessageModifierConfig.java,v 1.2 2010/02/04 03:41:38 cvs Exp $ -*/ + * ChecksumSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig + * that provides configuration for ChecksumSyslogMessageModifier. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: ChecksumSyslogMessageModifierConfig.java,v 1.2 2010/02/04 03:41:38 cvs Exp $ + */ public class ChecksumSyslogMessageModifierConfig extends AbstractSyslogMessageModifierConfig { - private static final long serialVersionUID = -8298600135683882489L; + private static final long serialVersionUID = -8298600135683882489L; - protected Checksum checksum = null; - protected boolean continuous = false; - - public static final ChecksumSyslogMessageModifierConfig createCRC32() { - ChecksumSyslogMessageModifierConfig crc32 = new ChecksumSyslogMessageModifierConfig(new CRC32()); - - return crc32; - } - - public static final ChecksumSyslogMessageModifierConfig createADLER32() { - ChecksumSyslogMessageModifierConfig adler32 = new ChecksumSyslogMessageModifierConfig(new Adler32()); - - return adler32; - } - - public ChecksumSyslogMessageModifierConfig(Checksum checksum) { - this.checksum = checksum; - } + protected Checksum checksum = null; + protected boolean continuous = false; - public Checksum getChecksum() { - return this.checksum; - } + public static final ChecksumSyslogMessageModifierConfig createCRC32() { + ChecksumSyslogMessageModifierConfig crc32 = new ChecksumSyslogMessageModifierConfig(new CRC32()); - public void setChecksum(Checksum checksum) { - this.checksum = checksum; - } + return crc32; + } - public boolean isContinuous() { - return continuous; - } + public static final ChecksumSyslogMessageModifierConfig createADLER32() { + ChecksumSyslogMessageModifierConfig adler32 = new ChecksumSyslogMessageModifierConfig(new Adler32()); - public void setContinuous(boolean continuous) { - this.continuous = continuous; - } + return adler32; + } + + public ChecksumSyslogMessageModifierConfig(Checksum checksum) { + this.checksum = checksum; + } + + public Checksum getChecksum() { + return this.checksum; + } + + public void setChecksum(Checksum checksum) { + this.checksum = checksum; + } + + public boolean isContinuous() { + return continuous; + } + + public void setContinuous(boolean continuous) { + this.continuous = continuous; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/escape/HTMLEntityEscapeSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/escape/HTMLEntityEscapeSyslogMessageModifier.java index 944917c..2f1e495 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/escape/HTMLEntityEscapeSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/escape/HTMLEntityEscapeSyslogMessageModifier.java @@ -4,77 +4,77 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.SyslogMessageModifierIF; /** -* HTMLEntityEscapeSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that safely escapes HTML entity characters. -* -*

This modifier is useful for applications that display log content in browsers without -* properly escaping HTML characters.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: HTMLEntityEscapeSyslogMessageModifier.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ -*/ + * HTMLEntityEscapeSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that safely escapes HTML entity characters. + *

+ *

This modifier is useful for applications that display log content in browsers without + * properly escaping HTML characters.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: HTMLEntityEscapeSyslogMessageModifier.java,v 1.4 2010/10/28 05:10:57 cvs Exp $ + */ public class HTMLEntityEscapeSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = -8481773209240762293L; + private static final long serialVersionUID = -8481773209240762293L; - public static final SyslogMessageModifierIF createDefault() { - return new HTMLEntityEscapeSyslogMessageModifier(); - } + public static final SyslogMessageModifierIF createDefault() { + return new HTMLEntityEscapeSyslogMessageModifier(); + } - public String modify(SyslogIF syslog, int facility, int level, String message) { - if (message != null && !"".equals(message.trim())) { - String escapedMessage = escapeHtml(message); - - return escapedMessage; - } - - return message; - } - - public boolean verify(String message) { - // NO-OP - - return true; - } - - /** - * escapeHtml(String) is based partly on the article posted here: http://www.owasp.org/index.php/How_to_perform_HTML_entity_encoding_in_Java - * with the addition of common characters and modifications for Java 1.4 support. - * - * @param message - * @return Returns a message where any HTML entity characters are escaped. - */ - public static String escapeHtml(String message) { - StringBuffer b = new StringBuffer(message.length()); - - for (int i = 0; i < message.length(); i++) { - char ch = message.charAt(i); + public String modify(SyslogIF syslog, int facility, int level, String message) { + if (message != null && !"".equals(message.trim())) { + String escapedMessage = escapeHtml(message); - if (ch == '<') { - b.append("<"); - } else if (ch == '>') { - b.append(">"); - } else if (ch == '"') { - b.append("""); - } else if (ch == '\'') { - b.append("'"); - } else if (ch == '&') { - b.append("&"); - } else if (ch >= ' ' && ch <= '~') { - b.append(ch); - } else if (Character.isWhitespace(ch)) { - b.append("&#").append((int) ch).append(";"); - } else if (Character.isISOControl(ch)) { - // Ignore character - } else if (Character.isDefined(ch)) { - b.append("&#").append((int) ch).append(";"); - } - } - - return b.toString(); - } + return escapedMessage; + } + + return message; + } + + public boolean verify(String message) { + // NO-OP + + return true; + } + + /** + * escapeHtml(String) is based partly on the article posted here: http://www.owasp.org/index.php/How_to_perform_HTML_entity_encoding_in_Java + * with the addition of common characters and modifications for Java 1.4 support. + * + * @param message + * @return Returns a message where any HTML entity characters are escaped. + */ + public static String escapeHtml(String message) { + StringBuffer b = new StringBuffer(message.length()); + + for (int i = 0; i < message.length(); i++) { + char ch = message.charAt(i); + + if (ch == '<') { + b.append("<"); + } else if (ch == '>') { + b.append(">"); + } else if (ch == '"') { + b.append("""); + } else if (ch == '\'') { + b.append("'"); + } else if (ch == '&') { + b.append("&"); + } else if (ch >= ' ' && ch <= '~') { + b.append(ch); + } else if (Character.isWhitespace(ch)) { + b.append("&#").append((int) ch).append(";"); + } else if (Character.isISOControl(ch)) { + // Ignore character + } else if (Character.isDefined(ch)) { + b.append("&#").append((int) ch).append(";"); + } + } + + return b.toString(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifier.java index 93d82e2..f550f77 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifier.java @@ -11,122 +11,122 @@ import org.graylog2.syslog4j.util.Base64; import org.graylog2.syslog4j.util.SyslogUtility; /** -* HashSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for Java Cryptographic hashes (MD5, SHA1, SHA256, etc.). -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: HashSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ -*/ + * HashSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for Java Cryptographic hashes (MD5, SHA1, SHA256, etc.). + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: HashSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ + */ public class HashSyslogMessageModifier extends AbstractSyslogMessageModifier { - private static final long serialVersionUID = 7335757344826206953L; - - protected HashSyslogMessageModifierConfig config = null; - - public static final HashSyslogMessageModifier createMD5() { - HashSyslogMessageModifier md5 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createMD5()); - - return md5; - } - - public static final HashSyslogMessageModifier createSHA1() { - HashSyslogMessageModifier sha1 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA1()); - - return sha1; - } - - public static final HashSyslogMessageModifier createSHA160() { - return createSHA1(); - } - - public static final HashSyslogMessageModifier createSHA256() { - HashSyslogMessageModifier sha256 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA256()); - - return sha256; - } - - public static final HashSyslogMessageModifier createSHA384() { - HashSyslogMessageModifier sha384 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA384()); - - return sha384; - } - - public static final HashSyslogMessageModifier createSHA512() { - HashSyslogMessageModifier sha512 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA512()); - - return sha512; - } - - public HashSyslogMessageModifier(HashSyslogMessageModifierConfig config) throws SyslogRuntimeException { - super(config); - - this.config = config; - - if (this.config == null) { - throw new SyslogRuntimeException("Hash config object cannot be null"); - } + private static final long serialVersionUID = 7335757344826206953L; - if (this.config.getHashAlgorithm() == null) { - throw new SyslogRuntimeException("Hash algorithm cannot be null"); - } - - try { - MessageDigest.getInstance(config.getHashAlgorithm()); - - } catch (NoSuchAlgorithmException nsae){ - throw new SyslogRuntimeException(nsae); - } - } - - protected MessageDigest obtainMessageDigest() { - MessageDigest digest = null; - - try { - digest = MessageDigest.getInstance(this.config.getHashAlgorithm()); - - } catch (NoSuchAlgorithmException nsae) { - throw new SyslogRuntimeException(nsae); - } - - return digest; - } + protected HashSyslogMessageModifierConfig config = null; - public HashSyslogMessageModifierConfig getConfig() { - return this.config; - } - - public String modify(SyslogIF syslog, int facility, int level, String message) { - byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(),message); - - MessageDigest digest = obtainMessageDigest(); - byte[] digestBytes = digest.digest(messageBytes); + public static final HashSyslogMessageModifier createMD5() { + HashSyslogMessageModifier md5 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createMD5()); - String digestString = Base64.encodeBytes(digestBytes,Base64.DONT_BREAK_LINES); + return md5; + } - StringBuffer buffer = new StringBuffer(message); - - buffer.append(this.config.getPrefix()); - buffer.append(digestString); - buffer.append(this.config.getSuffix()); - - return buffer.toString(); - } + public static final HashSyslogMessageModifier createSHA1() { + HashSyslogMessageModifier sha1 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA1()); - public boolean verify(String message, String base64Hash) { - byte[] hash = Base64.decode(base64Hash); - - return verify(message,hash); - } - - public boolean verify(String message, byte[] hash) { - byte[] messageBytes = SyslogUtility.getBytes(this.config,message); - - MessageDigest digest = obtainMessageDigest(); - byte[] digestBytes = digest.digest(messageBytes); - - return Arrays.equals(digestBytes,hash); - } + return sha1; + } + + public static final HashSyslogMessageModifier createSHA160() { + return createSHA1(); + } + + public static final HashSyslogMessageModifier createSHA256() { + HashSyslogMessageModifier sha256 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA256()); + + return sha256; + } + + public static final HashSyslogMessageModifier createSHA384() { + HashSyslogMessageModifier sha384 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA384()); + + return sha384; + } + + public static final HashSyslogMessageModifier createSHA512() { + HashSyslogMessageModifier sha512 = new HashSyslogMessageModifier(HashSyslogMessageModifierConfig.createSHA512()); + + return sha512; + } + + public HashSyslogMessageModifier(HashSyslogMessageModifierConfig config) throws SyslogRuntimeException { + super(config); + + this.config = config; + + if (this.config == null) { + throw new SyslogRuntimeException("Hash config object cannot be null"); + } + + if (this.config.getHashAlgorithm() == null) { + throw new SyslogRuntimeException("Hash algorithm cannot be null"); + } + + try { + MessageDigest.getInstance(config.getHashAlgorithm()); + + } catch (NoSuchAlgorithmException nsae) { + throw new SyslogRuntimeException(nsae); + } + } + + protected MessageDigest obtainMessageDigest() { + MessageDigest digest = null; + + try { + digest = MessageDigest.getInstance(this.config.getHashAlgorithm()); + + } catch (NoSuchAlgorithmException nsae) { + throw new SyslogRuntimeException(nsae); + } + + return digest; + } + + public HashSyslogMessageModifierConfig getConfig() { + return this.config; + } + + public String modify(SyslogIF syslog, int facility, int level, String message) { + byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(), message); + + MessageDigest digest = obtainMessageDigest(); + byte[] digestBytes = digest.digest(messageBytes); + + String digestString = Base64.encodeBytes(digestBytes, Base64.DONT_BREAK_LINES); + + StringBuffer buffer = new StringBuffer(message); + + buffer.append(this.config.getPrefix()); + buffer.append(digestString); + buffer.append(this.config.getSuffix()); + + return buffer.toString(); + } + + public boolean verify(String message, String base64Hash) { + byte[] hash = Base64.decode(base64Hash); + + return verify(message, hash); + } + + public boolean verify(String message, byte[] hash) { + byte[] messageBytes = SyslogUtility.getBytes(this.config, message); + + MessageDigest digest = obtainMessageDigest(); + byte[] digestBytes = digest.digest(messageBytes); + + return Arrays.equals(digestBytes, hash); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifierConfig.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifierConfig.java index 54a44af..8bbe675 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifierConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/hash/HashSyslogMessageModifierConfig.java @@ -3,64 +3,64 @@ package org.graylog2.syslog4j.impl.message.modifier.hash; import org.graylog2.syslog4j.impl.message.modifier.AbstractSyslogMessageModifierConfig; /** -* HashSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig -* that provides configuration for HashSyslogMessageModifier. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: HashSyslogMessageModifierConfig.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ -*/ + * HashSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig + * that provides configuration for HashSyslogMessageModifier. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: HashSyslogMessageModifierConfig.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ + */ public class HashSyslogMessageModifierConfig extends AbstractSyslogMessageModifierConfig { - private static final long serialVersionUID = -3148300281439874231L; - - protected String hashAlgorithm = null; - - public static final HashSyslogMessageModifierConfig createMD5() { - HashSyslogMessageModifierConfig md5 = new HashSyslogMessageModifierConfig("MD5"); - - return md5; - } - - public static final HashSyslogMessageModifierConfig createSHA1() { - HashSyslogMessageModifierConfig sha1 = new HashSyslogMessageModifierConfig("SHA1"); - - return sha1; - } - - public static final HashSyslogMessageModifierConfig createSHA160() { - return createSHA1(); - } - - public static final HashSyslogMessageModifierConfig createSHA256() { - HashSyslogMessageModifierConfig sha256 = new HashSyslogMessageModifierConfig("SHA-256"); - - return sha256; - } - - public static final HashSyslogMessageModifierConfig createSHA384() { - HashSyslogMessageModifierConfig sha384 = new HashSyslogMessageModifierConfig("SHA-384"); - - return sha384; - } - - public static final HashSyslogMessageModifierConfig createSHA512() { - HashSyslogMessageModifierConfig sha512 = new HashSyslogMessageModifierConfig("SHA-512"); - - return sha512; - } - - public HashSyslogMessageModifierConfig(String hashAlgorithm) { - this.hashAlgorithm = hashAlgorithm; - } + private static final long serialVersionUID = -3148300281439874231L; - public String getHashAlgorithm() { - return this.hashAlgorithm; - } - - public void setHashAlgorithm(String hashAlgorithm) { - this.hashAlgorithm = hashAlgorithm; - } + protected String hashAlgorithm = null; + + public static final HashSyslogMessageModifierConfig createMD5() { + HashSyslogMessageModifierConfig md5 = new HashSyslogMessageModifierConfig("MD5"); + + return md5; + } + + public static final HashSyslogMessageModifierConfig createSHA1() { + HashSyslogMessageModifierConfig sha1 = new HashSyslogMessageModifierConfig("SHA1"); + + return sha1; + } + + public static final HashSyslogMessageModifierConfig createSHA160() { + return createSHA1(); + } + + public static final HashSyslogMessageModifierConfig createSHA256() { + HashSyslogMessageModifierConfig sha256 = new HashSyslogMessageModifierConfig("SHA-256"); + + return sha256; + } + + public static final HashSyslogMessageModifierConfig createSHA384() { + HashSyslogMessageModifierConfig sha384 = new HashSyslogMessageModifierConfig("SHA-384"); + + return sha384; + } + + public static final HashSyslogMessageModifierConfig createSHA512() { + HashSyslogMessageModifierConfig sha512 = new HashSyslogMessageModifierConfig("SHA-512"); + + return sha512; + } + + public HashSyslogMessageModifierConfig(String hashAlgorithm) { + this.hashAlgorithm = hashAlgorithm; + } + + public String getHashAlgorithm() { + return this.hashAlgorithm; + } + + public void setHashAlgorithm(String hashAlgorithm) { + this.hashAlgorithm = hashAlgorithm; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifier.java index 5068cb7..fe55ed5 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifier.java @@ -14,107 +14,107 @@ import org.graylog2.syslog4j.util.Base64; import org.graylog2.syslog4j.util.SyslogUtility; /** -* MacSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for Java Cryptographic signed hashes (HmacSHA1, etc.) -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: MacSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ -*/ + * MacSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for Java Cryptographic signed hashes (HmacSHA1, etc.) + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: MacSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ + */ public class MacSyslogMessageModifier extends AbstractSyslogMessageModifier { - private static final long serialVersionUID = 5054979194802197540L; + private static final long serialVersionUID = 5054979194802197540L; - protected MacSyslogMessageModifierConfig config = null; - - protected Mac mac = null; - - public MacSyslogMessageModifier(MacSyslogMessageModifierConfig config) throws SyslogRuntimeException { - super(config); - - this.config = config; + protected MacSyslogMessageModifierConfig config = null; - try { - this.mac = Mac.getInstance(config.getMacAlgorithm()); - this.mac.init(config.getKey()); - - } catch (NoSuchAlgorithmException nsae) { - throw new SyslogRuntimeException(nsae); - - } catch (InvalidKeyException ike) { - throw new SyslogRuntimeException(ike); - } - } + protected Mac mac = null; - public static MacSyslogMessageModifier createHmacSHA1(Key key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA1(key)); - } + public MacSyslogMessageModifier(MacSyslogMessageModifierConfig config) throws SyslogRuntimeException { + super(config); - public static MacSyslogMessageModifier createHmacSHA1(String base64Key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA1(base64Key)); - } + this.config = config; - public static MacSyslogMessageModifier createHmacSHA256(Key key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA256(key)); - } + try { + this.mac = Mac.getInstance(config.getMacAlgorithm()); + this.mac.init(config.getKey()); - public static MacSyslogMessageModifier createHmacSHA256(String base64Key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA256(base64Key)); - } + } catch (NoSuchAlgorithmException nsae) { + throw new SyslogRuntimeException(nsae); - public static MacSyslogMessageModifier createHmacSHA512(Key key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA512(key)); - } + } catch (InvalidKeyException ike) { + throw new SyslogRuntimeException(ike); + } + } - public static MacSyslogMessageModifier createHmacSHA512(String base64Key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA512(base64Key)); - } + public static MacSyslogMessageModifier createHmacSHA1(Key key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA1(key)); + } - public static MacSyslogMessageModifier createHmacMD5(Key key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacMD5(key)); - } + public static MacSyslogMessageModifier createHmacSHA1(String base64Key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA1(base64Key)); + } - public static MacSyslogMessageModifier createHmacMD5(String base64Key) { - return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacMD5(base64Key)); - } + public static MacSyslogMessageModifier createHmacSHA256(Key key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA256(key)); + } - public MacSyslogMessageModifierConfig getConfig() { - return this.config; - } + public static MacSyslogMessageModifier createHmacSHA256(String base64Key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA256(base64Key)); + } - public String modify(SyslogIF syslog, int facility, int level, String message) { - synchronized(this.mac) { - byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(),message); - - StringBuffer buffer = new StringBuffer(message); - - byte[] macBytes = this.mac.doFinal(messageBytes); - - String macString = Base64.encodeBytes(macBytes,Base64.DONT_BREAK_LINES); - - buffer.append(this.config.getPrefix()); - buffer.append(macString); - buffer.append(this.config.getSuffix()); - - return buffer.toString(); - } - } - - public boolean verify(String message, String base64Signature) { - byte[] signature = Base64.decode(base64Signature); - - return verify(message,signature); - } - - public boolean verify(String message, byte[] signature) { - synchronized(this.mac) { - byte[] messageBytes = SyslogUtility.getBytes(this.config,message); - - byte[] macBytes = this.mac.doFinal(messageBytes); - - return Arrays.equals(macBytes,signature); - } - } + public static MacSyslogMessageModifier createHmacSHA512(Key key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA512(key)); + } + + public static MacSyslogMessageModifier createHmacSHA512(String base64Key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacSHA512(base64Key)); + } + + public static MacSyslogMessageModifier createHmacMD5(Key key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacMD5(key)); + } + + public static MacSyslogMessageModifier createHmacMD5(String base64Key) { + return new MacSyslogMessageModifier(MacSyslogMessageModifierConfig.createHmacMD5(base64Key)); + } + + public MacSyslogMessageModifierConfig getConfig() { + return this.config; + } + + public String modify(SyslogIF syslog, int facility, int level, String message) { + synchronized (this.mac) { + byte[] messageBytes = SyslogUtility.getBytes(syslog.getConfig(), message); + + StringBuffer buffer = new StringBuffer(message); + + byte[] macBytes = this.mac.doFinal(messageBytes); + + String macString = Base64.encodeBytes(macBytes, Base64.DONT_BREAK_LINES); + + buffer.append(this.config.getPrefix()); + buffer.append(macString); + buffer.append(this.config.getSuffix()); + + return buffer.toString(); + } + } + + public boolean verify(String message, String base64Signature) { + byte[] signature = Base64.decode(base64Signature); + + return verify(message, signature); + } + + public boolean verify(String message, byte[] signature) { + synchronized (this.mac) { + byte[] messageBytes = SyslogUtility.getBytes(this.config, message); + + byte[] macBytes = this.mac.doFinal(messageBytes); + + return Arrays.equals(macBytes, signature); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifierConfig.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifierConfig.java index c680d89..f5b6d45 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifierConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/mac/MacSyslogMessageModifierConfig.java @@ -9,100 +9,100 @@ import org.graylog2.syslog4j.impl.message.modifier.AbstractSyslogMessageModifier import org.graylog2.syslog4j.util.Base64; /** -* MacSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig -* that provides configuration for HashSyslogMessageModifier. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: MacSyslogMessageModifierConfig.java,v 1.3 2009/04/17 02:37:04 cvs Exp $ -*/ + * MacSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig + * that provides configuration for HashSyslogMessageModifier. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: MacSyslogMessageModifierConfig.java,v 1.3 2009/04/17 02:37:04 cvs Exp $ + */ public class MacSyslogMessageModifierConfig extends AbstractSyslogMessageModifierConfig { - private static final long serialVersionUID = 4524180892377960695L; - - protected String macAlgorithm = null; - protected String keyAlgorithm = null; - protected Key key = null; - - public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, Key key) { - this.macAlgorithm = macAlgorithm; - this.keyAlgorithm = keyAlgorithm; - this.key = key; - } + private static final long serialVersionUID = 4524180892377960695L; - public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, byte[] keyBytes) { - this.macAlgorithm = macAlgorithm; - this.keyAlgorithm = keyAlgorithm; - - try { - this.key = new SecretKeySpec(keyBytes,keyAlgorithm); - - } catch (IllegalArgumentException iae) { - throw new SyslogRuntimeException(iae); - } - } + protected String macAlgorithm = null; + protected String keyAlgorithm = null; + protected Key key = null; - public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, String base64Key) { - this.macAlgorithm = macAlgorithm; - this.keyAlgorithm = keyAlgorithm; - - byte[] keyBytes = Base64.decode(base64Key); - - try { - this.key = new SecretKeySpec(keyBytes,keyAlgorithm); - - } catch (IllegalArgumentException iae) { - throw new SyslogRuntimeException(iae); - } - } - - public static MacSyslogMessageModifierConfig createHmacSHA1(Key key) { - return new MacSyslogMessageModifierConfig("HmacSHA1","SHA1",key); - } + public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, Key key) { + this.macAlgorithm = macAlgorithm; + this.keyAlgorithm = keyAlgorithm; + this.key = key; + } - public static MacSyslogMessageModifierConfig createHmacSHA1(String base64Key) { - return new MacSyslogMessageModifierConfig("HmacSHA1","SHA1",base64Key); - } + public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, byte[] keyBytes) { + this.macAlgorithm = macAlgorithm; + this.keyAlgorithm = keyAlgorithm; - public static MacSyslogMessageModifierConfig createHmacSHA256(Key key) { - return new MacSyslogMessageModifierConfig("HmacSHA256","SHA-256",key); - } + try { + this.key = new SecretKeySpec(keyBytes, keyAlgorithm); - public static MacSyslogMessageModifierConfig createHmacSHA256(String base64Key) { - return new MacSyslogMessageModifierConfig("HmacSHA256","SHA-256",base64Key); - } + } catch (IllegalArgumentException iae) { + throw new SyslogRuntimeException(iae); + } + } - public static MacSyslogMessageModifierConfig createHmacSHA512(Key key) { - return new MacSyslogMessageModifierConfig("HmacSHA512","SHA-512",key); - } + public MacSyslogMessageModifierConfig(String macAlgorithm, String keyAlgorithm, String base64Key) { + this.macAlgorithm = macAlgorithm; + this.keyAlgorithm = keyAlgorithm; - public static MacSyslogMessageModifierConfig createHmacSHA512(String base64Key) { - return new MacSyslogMessageModifierConfig("HmacSHA512","SHA-512",base64Key); - } + byte[] keyBytes = Base64.decode(base64Key); - public static MacSyslogMessageModifierConfig createHmacMD5(Key key) { - return new MacSyslogMessageModifierConfig("HmacMD5","MD5",key); - } + try { + this.key = new SecretKeySpec(keyBytes, keyAlgorithm); - public static MacSyslogMessageModifierConfig createHmacMD5(String base64Key) { - return new MacSyslogMessageModifierConfig("HmacMD5","MD5",base64Key); - } + } catch (IllegalArgumentException iae) { + throw new SyslogRuntimeException(iae); + } + } - public String getMacAlgorithm() { - return this.macAlgorithm; - } - - public String getKeyAlgorithm() { - return this.keyAlgorithm; - } + public static MacSyslogMessageModifierConfig createHmacSHA1(Key key) { + return new MacSyslogMessageModifierConfig("HmacSHA1", "SHA1", key); + } - public Key getKey() { - return this.key; - } + public static MacSyslogMessageModifierConfig createHmacSHA1(String base64Key) { + return new MacSyslogMessageModifierConfig("HmacSHA1", "SHA1", base64Key); + } - public void setKey(Key key) { - this.key = key; - } + public static MacSyslogMessageModifierConfig createHmacSHA256(Key key) { + return new MacSyslogMessageModifierConfig("HmacSHA256", "SHA-256", key); + } + + public static MacSyslogMessageModifierConfig createHmacSHA256(String base64Key) { + return new MacSyslogMessageModifierConfig("HmacSHA256", "SHA-256", base64Key); + } + + public static MacSyslogMessageModifierConfig createHmacSHA512(Key key) { + return new MacSyslogMessageModifierConfig("HmacSHA512", "SHA-512", key); + } + + public static MacSyslogMessageModifierConfig createHmacSHA512(String base64Key) { + return new MacSyslogMessageModifierConfig("HmacSHA512", "SHA-512", base64Key); + } + + public static MacSyslogMessageModifierConfig createHmacMD5(Key key) { + return new MacSyslogMessageModifierConfig("HmacMD5", "MD5", key); + } + + public static MacSyslogMessageModifierConfig createHmacMD5(String base64Key) { + return new MacSyslogMessageModifierConfig("HmacMD5", "MD5", base64Key); + } + + public String getMacAlgorithm() { + return this.macAlgorithm; + } + + public String getKeyAlgorithm() { + return this.keyAlgorithm; + } + + public Key getKey() { + return this.key; + } + + public void setKey(Key key) { + this.key = key; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifier.java index 73cba63..e32c473 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifier.java @@ -4,98 +4,98 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.SyslogMessageModifierIF; /** -* SequentialSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that adds an incremented number at the end. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SequentialSyslogMessageModifier.java,v 1.8 2010/11/28 04:43:31 cvs Exp $ -*/ + * SequentialSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that adds an incremented number at the end. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SequentialSyslogMessageModifier.java,v 1.8 2010/11/28 04:43:31 cvs Exp $ + */ public class SequentialSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = 6107735010240030785L; - - protected SequentialSyslogMessageModifierConfig config = null; - - protected long currentSequence[] = new long[LEVEL_DEBUG + 1]; + private static final long serialVersionUID = 6107735010240030785L; - public static final SequentialSyslogMessageModifier createDefault() { - SequentialSyslogMessageModifier modifier = new SequentialSyslogMessageModifier(SequentialSyslogMessageModifierConfig.createDefault()); - - return modifier; - } + protected SequentialSyslogMessageModifierConfig config = null; - public SequentialSyslogMessageModifier(SequentialSyslogMessageModifierConfig config) { - this.config = config; - - for(int i=0; i<(LEVEL_DEBUG + 1); i++) { - this.currentSequence[i] = config.getFirstNumber(); - } - } - - protected String pad(long number) { - StringBuffer buffer = new StringBuffer(Long.toString(number)); - - while (buffer.length() < this.config.getLastNumberDigits()) { - buffer.insert(0,this.config.getPadChar()); - } - - return buffer.toString(); - } - - public void setNextSequence(int level, long nextSequence) { - if (nextSequence >= this.config.getFirstNumber() && nextSequence < this.config.getLastNumber()) { - synchronized(this) { - this.currentSequence[level] = nextSequence; - } - } - } - - protected String nextSequence(int level) { - long sequence = -1; - - synchronized(this) { - sequence = this.currentSequence[level]; - - if (this.currentSequence[level] >= this.config.getLastNumber()) { - this.currentSequence[level] = this.config.getFirstNumber(); - - } else { - this.currentSequence[level]++; - } - } - - String _sequence = null; - - if (this.config.isUsePadding()) { - _sequence = pad(sequence); - - } else { - _sequence = Long.toString(sequence); - } - - return _sequence; - } + protected long currentSequence[] = new long[LEVEL_DEBUG + 1]; - public SequentialSyslogMessageModifierConfig getConfig() { - return this.config; - } + public static final SequentialSyslogMessageModifier createDefault() { + SequentialSyslogMessageModifier modifier = new SequentialSyslogMessageModifier(SequentialSyslogMessageModifierConfig.createDefault()); - public String modify(SyslogIF syslog, int facility, int level, String message) { - StringBuffer buffer = new StringBuffer(message); - - buffer.append(this.config.getPrefix()); - buffer.append(nextSequence(level)); - buffer.append(this.config.getSuffix()); - - return buffer.toString(); - } - - public boolean verify(String message) { - // NO-OP - - return true; - } + return modifier; + } + + public SequentialSyslogMessageModifier(SequentialSyslogMessageModifierConfig config) { + this.config = config; + + for (int i = 0; i < (LEVEL_DEBUG + 1); i++) { + this.currentSequence[i] = config.getFirstNumber(); + } + } + + protected String pad(long number) { + StringBuffer buffer = new StringBuffer(Long.toString(number)); + + while (buffer.length() < this.config.getLastNumberDigits()) { + buffer.insert(0, this.config.getPadChar()); + } + + return buffer.toString(); + } + + public void setNextSequence(int level, long nextSequence) { + if (nextSequence >= this.config.getFirstNumber() && nextSequence < this.config.getLastNumber()) { + synchronized (this) { + this.currentSequence[level] = nextSequence; + } + } + } + + protected String nextSequence(int level) { + long sequence = -1; + + synchronized (this) { + sequence = this.currentSequence[level]; + + if (this.currentSequence[level] >= this.config.getLastNumber()) { + this.currentSequence[level] = this.config.getFirstNumber(); + + } else { + this.currentSequence[level]++; + } + } + + String _sequence = null; + + if (this.config.isUsePadding()) { + _sequence = pad(sequence); + + } else { + _sequence = Long.toString(sequence); + } + + return _sequence; + } + + public SequentialSyslogMessageModifierConfig getConfig() { + return this.config; + } + + public String modify(SyslogIF syslog, int facility, int level, String message) { + StringBuffer buffer = new StringBuffer(message); + + buffer.append(this.config.getPrefix()); + buffer.append(nextSequence(level)); + buffer.append(this.config.getSuffix()); + + return buffer.toString(); + } + + public boolean verify(String message) { + // NO-OP + + return true; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifierConfig.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifierConfig.java index a60627d..7fef5da 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifierConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/sequential/SequentialSyslogMessageModifierConfig.java @@ -3,72 +3,72 @@ package org.graylog2.syslog4j.impl.message.modifier.sequential; import org.graylog2.syslog4j.impl.message.modifier.AbstractSyslogMessageModifierConfig; /** -* SequentialSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig -* that provides configuration for SequentialSyslogMessageModifier. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SequentialSyslogMessageModifierConfig.java,v 1.4 2009/03/29 17:38:58 cvs Exp $ -*/ + * SequentialSyslogMessageModifierConfig is an implementation of AbstractSyslogMessageModifierConfig + * that provides configuration for SequentialSyslogMessageModifier. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SequentialSyslogMessageModifierConfig.java,v 1.4 2009/03/29 17:38:58 cvs Exp $ + */ public class SequentialSyslogMessageModifierConfig extends AbstractSyslogMessageModifierConfig { - private static final long serialVersionUID = 1570930406228960303L; - - protected long firstNumber = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT; - protected long lastNumber = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT; - protected char padChar = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT; - protected boolean usePadding = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT; - - public static final SequentialSyslogMessageModifierConfig createDefault() { - SequentialSyslogMessageModifierConfig modifierConfig = new SequentialSyslogMessageModifierConfig(); - - return modifierConfig; - } + private static final long serialVersionUID = 1570930406228960303L; - public SequentialSyslogMessageModifierConfig() { - setPrefix(SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT); - setSuffix(SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT); - } - - public long getLastNumberDigits() { - return Long.toString(this.lastNumber).length(); - } - - public long getFirstNumber() { - return this.firstNumber; - } - - public void setFirstNumber(long firstNumber) { - if (firstNumber < this.lastNumber) { - this.firstNumber = firstNumber; - } - } - - public long getLastNumber() { - return this.lastNumber; - } - - public void setLastNumber(long lastNumber) { - if (lastNumber > this.firstNumber) { - this.lastNumber = lastNumber; - } - } - - public boolean isUsePadding() { - return this.usePadding; - } + protected long firstNumber = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT; + protected long lastNumber = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT; + protected char padChar = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT; + protected boolean usePadding = SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT; - public void setUsePadding(boolean usePadding) { - this.usePadding = usePadding; - } + public static final SequentialSyslogMessageModifierConfig createDefault() { + SequentialSyslogMessageModifierConfig modifierConfig = new SequentialSyslogMessageModifierConfig(); - public char getPadChar() { - return this.padChar; - } - - public void setPadChar(char padChar) { - this.padChar = padChar; - } + return modifierConfig; + } + + public SequentialSyslogMessageModifierConfig() { + setPrefix(SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT); + setSuffix(SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT); + } + + public long getLastNumberDigits() { + return Long.toString(this.lastNumber).length(); + } + + public long getFirstNumber() { + return this.firstNumber; + } + + public void setFirstNumber(long firstNumber) { + if (firstNumber < this.lastNumber) { + this.firstNumber = firstNumber; + } + } + + public long getLastNumber() { + return this.lastNumber; + } + + public void setLastNumber(long lastNumber) { + if (lastNumber > this.firstNumber) { + this.lastNumber = lastNumber; + } + } + + public boolean isUsePadding() { + return this.usePadding; + } + + public void setUsePadding(boolean usePadding) { + this.usePadding = usePadding; + } + + public char getPadChar() { + return this.padChar; + } + + public void setPadChar(char padChar) { + this.padChar = padChar; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/PrefixSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/PrefixSyslogMessageModifier.java index 8354477..efe4cec 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/PrefixSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/PrefixSyslogMessageModifier.java @@ -4,56 +4,56 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.SyslogMessageModifierIF; /** -* PrefixSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for adding static text to the beginning of a Syslog message. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PrefixSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ -*/ + * PrefixSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for adding static text to the beginning of a Syslog message. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PrefixSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ + */ public class PrefixSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = 6718826215583513972L; - - protected String prefix = null; - protected String delimiter = " "; + private static final long serialVersionUID = 6718826215583513972L; - public PrefixSyslogMessageModifier() { - // - } - - public PrefixSyslogMessageModifier(String prefix) { - this.prefix = prefix; - } + protected String prefix = null; + protected String delimiter = " "; - public PrefixSyslogMessageModifier(String prefix, String delimiter) { - this.prefix = prefix; - if (delimiter != null) { - this.delimiter = delimiter; - } - } + public PrefixSyslogMessageModifier() { + // + } - public String getPrefix() { - return this.prefix; - } + public PrefixSyslogMessageModifier(String prefix) { + this.prefix = prefix; + } - public void setPrefix(String prefix) { - this.prefix = prefix; - } + public PrefixSyslogMessageModifier(String prefix, String delimiter) { + this.prefix = prefix; + if (delimiter != null) { + this.delimiter = delimiter; + } + } - public String modify(SyslogIF syslog, int facility, int level, String message) { - if (this.prefix == null || "".equals(this.prefix.trim())) { - return message; - } + public String getPrefix() { + return this.prefix; + } - return this.prefix + this.delimiter + message; - } + public void setPrefix(String prefix) { + this.prefix = prefix; + } - public boolean verify(String message) { - // NO-OP - - return true; - } + public String modify(SyslogIF syslog, int facility, int level, String message) { + if (this.prefix == null || "".equals(this.prefix.trim())) { + return message; + } + + return this.prefix + this.delimiter + message; + } + + public boolean verify(String message) { + // NO-OP + + return true; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/StringCaseSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/StringCaseSyslogMessageModifier.java index b96e8d9..0efd1a7 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/StringCaseSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/StringCaseSyslogMessageModifier.java @@ -5,54 +5,54 @@ import org.graylog2.syslog4j.SyslogMessageModifierIF; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* StringCaseSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for shifting a Syslog message to all upper case or all -* lower case. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: StringCaseSyslogMessageModifier.java,v 1.3 2010/10/28 05:10:57 cvs Exp $ -*/ + * StringCaseSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for shifting a Syslog message to all upper case or all + * lower case. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: StringCaseSyslogMessageModifier.java,v 1.3 2010/10/28 05:10:57 cvs Exp $ + */ public class StringCaseSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = 8383234811585957460L; - - public static final byte LOWER_CASE = 0; - public static final byte UPPER_CASE = 1; - - public static final StringCaseSyslogMessageModifier LOWER = new StringCaseSyslogMessageModifier(LOWER_CASE); - public static final StringCaseSyslogMessageModifier UPPER = new StringCaseSyslogMessageModifier(UPPER_CASE); - - protected byte stringCase = LOWER_CASE; - - public StringCaseSyslogMessageModifier(byte stringCase) { - this.stringCase = stringCase; - - if (stringCase < LOWER_CASE || stringCase > UPPER_CASE) { - throw new SyslogRuntimeException("stringCase must be LOWER_CASE (0) or UPPER_CASE (1)"); - } - } + private static final long serialVersionUID = 8383234811585957460L; - public String modify(SyslogIF syslog, int facility, int level, String message) { - String _message = message; - - if (message != null) { - if (this.stringCase == LOWER_CASE) { - _message = _message.toLowerCase(); - - } else if (this.stringCase == UPPER_CASE) { - _message = _message.toUpperCase(); - } - } - - return _message; - } + public static final byte LOWER_CASE = 0; + public static final byte UPPER_CASE = 1; - public boolean verify(String message) { - // NO-OP - - return true; - } + public static final StringCaseSyslogMessageModifier LOWER = new StringCaseSyslogMessageModifier(LOWER_CASE); + public static final StringCaseSyslogMessageModifier UPPER = new StringCaseSyslogMessageModifier(UPPER_CASE); + + protected byte stringCase = LOWER_CASE; + + public StringCaseSyslogMessageModifier(byte stringCase) { + this.stringCase = stringCase; + + if (stringCase < LOWER_CASE || stringCase > UPPER_CASE) { + throw new SyslogRuntimeException("stringCase must be LOWER_CASE (0) or UPPER_CASE (1)"); + } + } + + public String modify(SyslogIF syslog, int facility, int level, String message) { + String _message = message; + + if (message != null) { + if (this.stringCase == LOWER_CASE) { + _message = _message.toLowerCase(); + + } else if (this.stringCase == UPPER_CASE) { + _message = _message.toUpperCase(); + } + } + + return _message; + } + + public boolean verify(String message) { + // NO-OP + + return true; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/SuffixSyslogMessageModifier.java b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/SuffixSyslogMessageModifier.java index e21598e..87cc5c5 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/SuffixSyslogMessageModifier.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/modifier/text/SuffixSyslogMessageModifier.java @@ -4,56 +4,56 @@ import org.graylog2.syslog4j.SyslogIF; import org.graylog2.syslog4j.SyslogMessageModifierIF; /** -* SuffixSyslogMessageModifier is an implementation of SyslogMessageModifierIF -* that provides support for adding static text to the end of a Syslog message. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SuffixSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ -*/ + * SuffixSyslogMessageModifier is an implementation of SyslogMessageModifierIF + * that provides support for adding static text to the end of a Syslog message. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SuffixSyslogMessageModifier.java,v 1.5 2010/10/28 05:10:57 cvs Exp $ + */ public class SuffixSyslogMessageModifier implements SyslogMessageModifierIF { - private static final long serialVersionUID = 7160593302741507576L; - - protected String suffix = null; - protected String delimiter = " "; + private static final long serialVersionUID = 7160593302741507576L; - public SuffixSyslogMessageModifier() { - // - } + protected String suffix = null; + protected String delimiter = " "; - public SuffixSyslogMessageModifier(String suffix) { - this.suffix = suffix; - } + public SuffixSyslogMessageModifier() { + // + } - public SuffixSyslogMessageModifier(String suffix, String delimiter) { - this.suffix = suffix; - if (delimiter != null) { - this.delimiter = delimiter; - } - } + public SuffixSyslogMessageModifier(String suffix) { + this.suffix = suffix; + } - public String getSuffix() { - return this.suffix; - } + public SuffixSyslogMessageModifier(String suffix, String delimiter) { + this.suffix = suffix; + if (delimiter != null) { + this.delimiter = delimiter; + } + } - public void setSuffix(String suffix) { - this.suffix = suffix; - } + public String getSuffix() { + return this.suffix; + } - public String modify(SyslogIF syslog, int facility, int level, String message) { - if (this.suffix == null || "".equals(this.suffix.trim())) { - return message; - } + public void setSuffix(String suffix) { + this.suffix = suffix; + } - return message + this.delimiter + this.suffix; - } + public String modify(SyslogIF syslog, int facility, int level, String message) { + if (this.suffix == null || "".equals(this.suffix.trim())) { + return message; + } - public boolean verify(String message) { - // NO-OP - - return true; - } + return message + this.delimiter + this.suffix; + } + + public boolean verify(String message) { + // NO-OP + + return true; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessage.java b/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessage.java index 79324f4..c7d37d9 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessage.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessage.java @@ -6,251 +6,275 @@ import java.util.Map; import org.graylog2.syslog4j.impl.message.AbstractSyslogMessage; /** -* PCISyslogMessage provides support for audit trails defined by section -* 10.3 of the PCI Data Security Standard (PCI DSS) versions 1.1 and 1.2. -* -*

More information on the PCI DSS specification is available here:

-* -*

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

-* -*

The PCI DSS specification is Copyright 2008 PCI Security Standards -* Council LLC.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PCISyslogMessage.java,v 1.3 2008/11/14 04:32:00 cvs Exp $ -*/ + * PCISyslogMessage provides support for audit trails defined by section + * 10.3 of the PCI Data Security Standard (PCI DSS) versions 1.1 and 1.2. + *

+ *

More information on the PCI DSS specification is available here:

+ *

+ *

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

+ *

+ *

The PCI DSS specification is Copyright 2008 PCI Security Standards + * Council LLC.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PCISyslogMessage.java,v 1.3 2008/11/14 04:32:00 cvs Exp $ + */ public class PCISyslogMessage extends AbstractSyslogMessage implements PCISyslogMessageIF { - private static final long serialVersionUID = 3571696218386879119L; - - public static final String USER_ID = "userId"; - public static final String EVENT_TYPE = "eventType"; - public static final String DATE = "date"; - public static final String TIME = "time"; - public static final String STATUS = "status"; - public static final String ORIGINATION = "origination"; - public static final String AFFECTED_RESOURCE = "affectedResource"; - - protected String userId = UNDEFINED; // 10.3.1 "User Identification" - protected String eventType = UNDEFINED; // 10.3.2 "Type of event" - protected String date = null; // 10.3.3 "Date and time" (date) - protected String time = null; // 10.3.3 "Date and time" (time) - protected String status = UNDEFINED; // 10.3.4 "Success or failure indication" - protected String origination = null; // 10.3.5 "Origination of Event" - protected String affectedResource = UNDEFINED; // 10.3.6 "Identity or name of affected data, system component, or resource" + private static final long serialVersionUID = 3571696218386879119L; - public PCISyslogMessage() { - // - } + public static final String USER_ID = "userId"; + public static final String EVENT_TYPE = "eventType"; + public static final String DATE = "date"; + public static final String TIME = "time"; + public static final String STATUS = "status"; + public static final String ORIGINATION = "origination"; + public static final String AFFECTED_RESOURCE = "affectedResource"; - public PCISyslogMessage(PCISyslogMessageIF message) { - init(message); - } - - public PCISyslogMessage(Map fields) { - init(fields); - } - - protected void init(PCISyslogMessageIF message) { - this.userId = message.getUserId(); - this.eventType = message.getEventType(); - this.date = message.getDate(); - this.time = message.getTime(); - this.status = message.getStatus(); - this.origination = message.getOrigination(); - this.affectedResource = message.getAffectedResource(); - } + protected String userId = UNDEFINED; // 10.3.1 "User Identification" + protected String eventType = UNDEFINED; // 10.3.2 "Type of event" + protected String date = null; // 10.3.3 "Date and time" (date) + protected String time = null; // 10.3.3 "Date and time" (time) + protected String status = UNDEFINED; // 10.3.4 "Success or failure indication" + protected String origination = null; // 10.3.5 "Origination of Event" + protected String affectedResource = UNDEFINED; // 10.3.6 "Identity or name of affected data, system component, or resource" - protected void init(Map fields) { - if (fields.containsKey(USER_ID)) { this.userId = (String) fields.get(USER_ID); }; - if (fields.containsKey(EVENT_TYPE)) { this.eventType = (String) fields.get(EVENT_TYPE); }; - if (fields.containsKey(DATE) && fields.get(DATE) instanceof String) { this.date = (String) fields.get(DATE); }; - if (fields.containsKey(DATE) && fields.get(DATE) instanceof Date) { setDate((Date) fields.get(DATE)); }; - if (fields.containsKey(TIME)) { this.time = (String) fields.get(TIME); }; - if (fields.containsKey(STATUS)) { this.status = (String) fields.get(STATUS); }; - if (fields.containsKey(ORIGINATION)) { this.origination = (String) fields.get(ORIGINATION); }; - if (fields.containsKey(AFFECTED_RESOURCE)) { this.affectedResource = (String) fields.get(AFFECTED_RESOURCE); }; - } + public PCISyslogMessage() { + // + } - public PCISyslogMessage(String userId, String eventType, String status, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - this.status = status; - this.affectedResource = affectedResource; - } + public PCISyslogMessage(PCISyslogMessageIF message) { + init(message); + } - public PCISyslogMessage(String userId, String eventType, String status, String origination, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - this.status = status; - this.origination = origination; - this.affectedResource = affectedResource; - } + public PCISyslogMessage(Map fields) { + init(fields); + } - public PCISyslogMessage(String userId, String eventType, String date, String time, String status, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - this.date = date; - this.time = time; - this.status = status; - this.affectedResource = affectedResource; - } + protected void init(PCISyslogMessageIF message) { + this.userId = message.getUserId(); + this.eventType = message.getEventType(); + this.date = message.getDate(); + this.time = message.getTime(); + this.status = message.getStatus(); + this.origination = message.getOrigination(); + this.affectedResource = message.getAffectedResource(); + } - public PCISyslogMessage(String userId, String eventType, String date, String time, String status, String origination, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - this.date = date; - this.time = time; - this.status = status; - this.origination = origination; - this.affectedResource = affectedResource; - } + protected void init(Map fields) { + if (fields.containsKey(USER_ID)) { + this.userId = (String) fields.get(USER_ID); + } + ; + if (fields.containsKey(EVENT_TYPE)) { + this.eventType = (String) fields.get(EVENT_TYPE); + } + ; + if (fields.containsKey(DATE) && fields.get(DATE) instanceof String) { + this.date = (String) fields.get(DATE); + } + ; + if (fields.containsKey(DATE) && fields.get(DATE) instanceof Date) { + setDate((Date) fields.get(DATE)); + } + ; + if (fields.containsKey(TIME)) { + this.time = (String) fields.get(TIME); + } + ; + if (fields.containsKey(STATUS)) { + this.status = (String) fields.get(STATUS); + } + ; + if (fields.containsKey(ORIGINATION)) { + this.origination = (String) fields.get(ORIGINATION); + } + ; + if (fields.containsKey(AFFECTED_RESOURCE)) { + this.affectedResource = (String) fields.get(AFFECTED_RESOURCE); + } + ; + } - public PCISyslogMessage(String userId, String eventType, Date date, String status, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - - String[] dateAndTime = generateDateAndTime(date); - this.date = dateAndTime[0]; - this.time = dateAndTime[1]; - - this.status = status; - this.affectedResource = affectedResource; - } - - public PCISyslogMessage(String userId, String eventType, Date date, String status, String origination, String affectedResource) { - this.userId = userId; - this.eventType = eventType; - - String[] dateAndTime = generateDateAndTime(date); - this.date = dateAndTime[0]; - this.time = dateAndTime[1]; - - this.status = status; - this.origination = origination; - this.affectedResource = affectedResource; - } + public PCISyslogMessage(String userId, String eventType, String status, String affectedResource) { + this.userId = userId; + this.eventType = eventType; + this.status = status; + this.affectedResource = affectedResource; + } - public String getUserId() { - if (nullOrEmpty(this.userId)) { - return UNDEFINED; - } - - return this.userId; - } + public PCISyslogMessage(String userId, String eventType, String status, String origination, String affectedResource) { + this.userId = userId; + this.eventType = eventType; + this.status = status; + this.origination = origination; + this.affectedResource = affectedResource; + } - public void setUserId(String userId) { - this.userId = userId; - } + public PCISyslogMessage(String userId, String eventType, String date, String time, String status, String affectedResource) { + this.userId = userId; + this.eventType = eventType; + this.date = date; + this.time = time; + this.status = status; + this.affectedResource = affectedResource; + } - public String getEventType() { - if (nullOrEmpty(this.eventType)) { - return UNDEFINED; - } - - return this.eventType; - } + public PCISyslogMessage(String userId, String eventType, String date, String time, String status, String origination, String affectedResource) { + this.userId = userId; + this.eventType = eventType; + this.date = date; + this.time = time; + this.status = status; + this.origination = origination; + this.affectedResource = affectedResource; + } - public void setEventType(String eventType) { - this.eventType = eventType; - } + public PCISyslogMessage(String userId, String eventType, Date date, String status, String affectedResource) { + this.userId = userId; + this.eventType = eventType; - public String getDate() { - if (nullOrEmpty(this.date)) { - String dateNow = generateDate(); - - return dateNow; - } - - return this.date; - } + String[] dateAndTime = generateDateAndTime(date); + this.date = dateAndTime[0]; + this.time = dateAndTime[1]; - public void setDate(String date) { - this.date = date; - } + this.status = status; + this.affectedResource = affectedResource; + } - public void setDate(Date date) { - String[] d = generateDateAndTime(date); - - this.date = d[0]; - this.time = d[1]; - } + public PCISyslogMessage(String userId, String eventType, Date date, String status, String origination, String affectedResource) { + this.userId = userId; + this.eventType = eventType; - public String getTime() { - if (nullOrEmpty(this.time)) { - String timeNow = generateTime(); - - return timeNow; - } - - return this.time; - } + String[] dateAndTime = generateDateAndTime(date); + this.date = dateAndTime[0]; + this.time = dateAndTime[1]; - public void setTime(String time) { - this.time = time; - } + this.status = status; + this.origination = origination; + this.affectedResource = affectedResource; + } - public String getStatus() { - if (nullOrEmpty(this.status)) { - return UNDEFINED; - } - - return this.status; - } + public String getUserId() { + if (nullOrEmpty(this.userId)) { + return UNDEFINED; + } - public void setStatus(String status) { - this.status = status; - } + return this.userId; + } - public String getOrigination() { - if (nullOrEmpty(this.origination)) { - String originationHere = generateLocalHostName(); - - return originationHere; - } - - return this.origination; - } + public void setUserId(String userId) { + this.userId = userId; + } - public void setOrigination(String origination) { - this.origination = origination; - } + public String getEventType() { + if (nullOrEmpty(this.eventType)) { + return UNDEFINED; + } - public String getAffectedResource() { - if (nullOrEmpty(this.affectedResource)) { - return UNDEFINED; - } - - return this.affectedResource; - } + return this.eventType; + } - public void setAffectedResource(String affectedResource) { - this.affectedResource = affectedResource; - } - - public String createMessage() { - StringBuffer buffer = new StringBuffer(); - - char delimiter = getDelimiter(); - String replaceDelimiter = getReplaceDelimiter(); - - buffer.append(replaceDelimiter(USER_ID,getUserId(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(EVENT_TYPE,getEventType(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(DATE,getDate(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(TIME,getTime(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(STATUS,getStatus(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(ORIGINATION,getOrigination(),delimiter,replaceDelimiter)); - buffer.append(delimiter); - buffer.append(replaceDelimiter(AFFECTED_RESOURCE,getAffectedResource(),delimiter,replaceDelimiter)); - - return buffer.toString(); - } + public void setEventType(String eventType) { + this.eventType = eventType; + } + + public String getDate() { + if (nullOrEmpty(this.date)) { + String dateNow = generateDate(); + + return dateNow; + } + + return this.date; + } + + public void setDate(String date) { + this.date = date; + } + + public void setDate(Date date) { + String[] d = generateDateAndTime(date); + + this.date = d[0]; + this.time = d[1]; + } + + public String getTime() { + if (nullOrEmpty(this.time)) { + String timeNow = generateTime(); + + return timeNow; + } + + return this.time; + } + + public void setTime(String time) { + this.time = time; + } + + public String getStatus() { + if (nullOrEmpty(this.status)) { + return UNDEFINED; + } + + return this.status; + } + + public void setStatus(String status) { + this.status = status; + } + + public String getOrigination() { + if (nullOrEmpty(this.origination)) { + String originationHere = generateLocalHostName(); + + return originationHere; + } + + return this.origination; + } + + public void setOrigination(String origination) { + this.origination = origination; + } + + public String getAffectedResource() { + if (nullOrEmpty(this.affectedResource)) { + return UNDEFINED; + } + + return this.affectedResource; + } + + public void setAffectedResource(String affectedResource) { + this.affectedResource = affectedResource; + } + + public String createMessage() { + StringBuffer buffer = new StringBuffer(); + + char delimiter = getDelimiter(); + String replaceDelimiter = getReplaceDelimiter(); + + buffer.append(replaceDelimiter(USER_ID, getUserId(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(EVENT_TYPE, getEventType(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(DATE, getDate(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(TIME, getTime(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(STATUS, getStatus(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(ORIGINATION, getOrigination(), delimiter, replaceDelimiter)); + buffer.append(delimiter); + buffer.append(replaceDelimiter(AFFECTED_RESOURCE, getAffectedResource(), delimiter, replaceDelimiter)); + + return buffer.toString(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessageIF.java b/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessageIF.java index 3483443..b13fe6c 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessageIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/pci/PCISyslogMessageIF.java @@ -1,30 +1,36 @@ package org.graylog2.syslog4j.impl.message.pci; /** -* PCISyslogMessageIF provides a definition of the fields for audit trails -* defined by section 10.3 of the PCI Data Security Standard (PCI DSS) -* versions 1.1 and 1.2. -* -*

More information on the PCI DSS specification is available here:

-* -*

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

-* -*

The PCI DSS specification is Copyright 2008 PCI Security Standards -* Council LLC.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PCISyslogMessageIF.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ -*/ + * PCISyslogMessageIF provides a definition of the fields for audit trails + * defined by section 10.3 of the PCI Data Security Standard (PCI DSS) + * versions 1.1 and 1.2. + *

+ *

More information on the PCI DSS specification is available here:

+ *

+ *

https://www.pcisecuritystandards.org/security_standards/pci_dss.shtml

+ *

+ *

The PCI DSS specification is Copyright 2008 PCI Security Standards + * Council LLC.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PCISyslogMessageIF.java,v 1.1 2008/11/10 04:38:37 cvs Exp $ + */ public interface PCISyslogMessageIF { - public String getUserId(); - public String getEventType(); - public String getDate(); - public String getTime(); - public String getStatus(); - public String getOrigination(); - public String getAffectedResource(); + public String getUserId(); + + public String getEventType(); + + public String getDate(); + + public String getTime(); + + public String getStatus(); + + public String getOrigination(); + + public String getAffectedResource(); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/processor/AbstractSyslogMessageProcessor.java b/src/main/java/org/graylog2/syslog4j/impl/message/processor/AbstractSyslogMessageProcessor.java index 744d31b..c4cf1e9 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/processor/AbstractSyslogMessageProcessor.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/processor/AbstractSyslogMessageProcessor.java @@ -9,110 +9,110 @@ import org.graylog2.syslog4j.SyslogMessageProcessorIF; import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslogMessageProcessor provides the ability to split a syslog message -* into multiple messages when the message is greater than the syslog -* maximum message length (1024 bytes including the header). -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogMessageProcessor.java,v 1.2 2010/11/28 04:15:18 cvs Exp $ -*/ + * AbstractSyslogMessageProcessor provides the ability to split a syslog message + * into multiple messages when the message is greater than the syslog + * maximum message length (1024 bytes including the header). + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogMessageProcessor.java,v 1.2 2010/11/28 04:15:18 cvs Exp $ + */ public abstract class AbstractSyslogMessageProcessor implements SyslogMessageProcessorIF, SyslogConstants { - private static final long serialVersionUID = -5413127301924500938L; - protected String localName = null; - - public AbstractSyslogMessageProcessor() { - this.localName = SyslogUtility.getLocalName(); - } + private static final long serialVersionUID = -5413127301924500938L; + protected String localName = null; - public byte[] createPacketData(byte[] header, byte[] message, int start, int length) { - return createPacketData(header,message,start,length,null,null); - } + public AbstractSyslogMessageProcessor() { + this.localName = SyslogUtility.getLocalName(); + } - public byte[] createPacketData(byte[] header, byte[] message, int start, int length, byte[] splitBeginText, byte[] splitEndText) { - if (header == null || message == null || start < 0 || length < 0) { - return null; - } - - int dataLength = header.length + length; - - if (splitBeginText != null) { - dataLength += splitBeginText.length; - } - if (splitEndText != null) { - dataLength += splitEndText.length; - } - - byte[] data = new byte[dataLength]; + public byte[] createPacketData(byte[] header, byte[] message, int start, int length) { + return createPacketData(header, message, start, length, null, null); + } - System.arraycopy(header,0,data,0,header.length); - int pos = header.length; - - if (splitBeginText != null) { - System.arraycopy(splitBeginText,0,data,pos,splitBeginText.length); - pos += splitBeginText.length; - } - - System.arraycopy(message,start,data,pos,length); - pos += length; + public byte[] createPacketData(byte[] header, byte[] message, int start, int length, byte[] splitBeginText, byte[] splitEndText) { + if (header == null || message == null || start < 0 || length < 0) { + return null; + } - if (splitEndText != null) { - System.arraycopy(splitEndText,0,data,pos,splitEndText.length); - } - - return data; - } + int dataLength = header.length + length; - protected void appendPriority(StringBuffer buffer, int facility, int level) { - int priority = facility | level; + if (splitBeginText != null) { + dataLength += splitBeginText.length; + } + if (splitEndText != null) { + dataLength += splitEndText.length; + } - buffer.append("<"); - buffer.append(priority); - buffer.append(">"); - } - - protected void appendLocalTimestamp(StringBuffer buffer) { - SimpleDateFormat dateFormat = new SimpleDateFormat(SYSLOG_DATEFORMAT,Locale.ENGLISH); - - String datePrefix = dateFormat.format(new Date()); - - int pos = buffer.length() + 4; - - buffer.append(datePrefix); - - // RFC 3164 requires leading space for days 1-9 - if (buffer.charAt(pos) == '0') { - buffer.setCharAt(pos,' '); - } - } - - protected void appendLocalName(StringBuffer buffer, String localName) { - if (localName != null) { - buffer.append(localName); - - } else { - buffer.append(this.localName); - } - - buffer.append(' '); - } + byte[] data = new byte[dataLength]; - public String createSyslogHeader(int facility, int level, String localName, boolean sendLocalTimestamp, boolean sendLocalName) { - StringBuffer buffer = new StringBuffer(); - - appendPriority(buffer,facility,level); - - if (sendLocalTimestamp) { - appendLocalTimestamp(buffer); - } - - if (sendLocalName) { - appendLocalName(buffer,localName); - } - - return buffer.toString(); - } + System.arraycopy(header, 0, data, 0, header.length); + int pos = header.length; + + if (splitBeginText != null) { + System.arraycopy(splitBeginText, 0, data, pos, splitBeginText.length); + pos += splitBeginText.length; + } + + System.arraycopy(message, start, data, pos, length); + pos += length; + + if (splitEndText != null) { + System.arraycopy(splitEndText, 0, data, pos, splitEndText.length); + } + + return data; + } + + protected void appendPriority(StringBuffer buffer, int facility, int level) { + int priority = facility | level; + + buffer.append("<"); + buffer.append(priority); + buffer.append(">"); + } + + protected void appendLocalTimestamp(StringBuffer buffer) { + SimpleDateFormat dateFormat = new SimpleDateFormat(SYSLOG_DATEFORMAT, Locale.ENGLISH); + + String datePrefix = dateFormat.format(new Date()); + + int pos = buffer.length() + 4; + + buffer.append(datePrefix); + + // RFC 3164 requires leading space for days 1-9 + if (buffer.charAt(pos) == '0') { + buffer.setCharAt(pos, ' '); + } + } + + protected void appendLocalName(StringBuffer buffer, String localName) { + if (localName != null) { + buffer.append(localName); + + } else { + buffer.append(this.localName); + } + + buffer.append(' '); + } + + public String createSyslogHeader(int facility, int level, String localName, boolean sendLocalTimestamp, boolean sendLocalName) { + StringBuffer buffer = new StringBuffer(); + + appendPriority(buffer, facility, level); + + if (sendLocalTimestamp) { + appendLocalTimestamp(buffer); + } + + if (sendLocalName) { + appendLocalName(buffer, localName); + } + + return buffer.toString(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/processor/SyslogMessageProcessor.java b/src/main/java/org/graylog2/syslog4j/impl/message/processor/SyslogMessageProcessor.java index ee4e43e..8f56de3 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/processor/SyslogMessageProcessor.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/processor/SyslogMessageProcessor.java @@ -2,34 +2,34 @@ package org.graylog2.syslog4j.impl.message.processor; /** -* SyslogMessageProcessor wraps AbstractSyslogMessageProcessor. -* -*

Those wishing to replace (or improve upon) this implementation -* can write a custom SyslogMessageProcessorIF and set it per -* instance via the SyslogIF.setMessageProcessor(..) method or set it globally -* via the SyslogMessageProcessor.setDefault(..) method.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogMessageProcessor.java,v 1.7 2010/02/04 03:41:37 cvs Exp $ -*/ + * SyslogMessageProcessor wraps AbstractSyslogMessageProcessor. + *

+ *

Those wishing to replace (or improve upon) this implementation + * can write a custom SyslogMessageProcessorIF and set it per + * instance via the SyslogIF.setMessageProcessor(..) method or set it globally + * via the SyslogMessageProcessor.setDefault(..) method.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogMessageProcessor.java,v 1.7 2010/02/04 03:41:37 cvs Exp $ + */ public class SyslogMessageProcessor extends AbstractSyslogMessageProcessor { - private static final long serialVersionUID = -4232803978024990353L; - - private static final SyslogMessageProcessor INSTANCE = new SyslogMessageProcessor(); - - protected static SyslogMessageProcessor defaultInstance = INSTANCE; - - public static void setDefault(SyslogMessageProcessor messageProcessor) { - if (messageProcessor != null) { - defaultInstance = messageProcessor; - } - } - - public static SyslogMessageProcessor getDefault() { - return defaultInstance; - } + private static final long serialVersionUID = -4232803978024990353L; + + private static final SyslogMessageProcessor INSTANCE = new SyslogMessageProcessor(); + + protected static SyslogMessageProcessor defaultInstance = INSTANCE; + + public static void setDefault(SyslogMessageProcessor messageProcessor) { + if (messageProcessor != null) { + defaultInstance = messageProcessor; + } + } + + public static SyslogMessageProcessor getDefault() { + return defaultInstance; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/processor/structured/StructuredSyslogMessageProcessor.java b/src/main/java/org/graylog2/syslog4j/impl/message/processor/structured/StructuredSyslogMessageProcessor.java index cdf452c..bb83ab6 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/processor/structured/StructuredSyslogMessageProcessor.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/processor/structured/StructuredSyslogMessageProcessor.java @@ -11,96 +11,96 @@ import org.graylog2.syslog4j.impl.message.structured.StructuredSyslogMessage; * than the syslog maximum message length (1024 bytes including the header). It * adds support for structured syslog messages as specified by * draft-ietf-syslog-protocol-23. More information here: - * + *

*

http://tools.ietf.org/html/draft-ietf-syslog-protocol-23

- * + *

*

Those wishing to replace (or improve upon) this implementation * can write a custom SyslogMessageProcessorIF and set it per * instance via the SyslogIF.setStructuredMessageProcessor(..) method or set it globally * via the StructuredSyslogMessageProcessor.setDefault(..) method.

- * + *

*

* Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy of the * LGPL license is available in the META-INF folder in all distributions of * Syslog4j and in the base directory of the "doc" ZIP. *

- * + * * @author Manish Motwani * @version $Id: StructuredSyslogMessageProcessor.java,v 1.4 2011/01/11 05:11:13 cvs Exp $ */ public class StructuredSyslogMessageProcessor extends AbstractSyslogMessageProcessor { - private static final long serialVersionUID = -1563777226913475257L; - - public static String VERSION = "1"; + private static final long serialVersionUID = -1563777226913475257L; - private static final StructuredSyslogMessageProcessor INSTANCE = new StructuredSyslogMessageProcessor(); - protected static StructuredSyslogMessageProcessor defaultInstance = INSTANCE; - - private String applicationName = STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE; - private String processId = STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE; - - private DateTimeFormatter dateTimeFormatter = ISODateTimeFormat.dateTime(); + public static String VERSION = "1"; - public static void setDefault(StructuredSyslogMessageProcessor messageProcessor) { - if (messageProcessor != null) { - defaultInstance = messageProcessor; - } - } - - public static StructuredSyslogMessageProcessor getDefault() { - return defaultInstance; - } - - public StructuredSyslogMessageProcessor() { - super(); - } + private static final StructuredSyslogMessageProcessor INSTANCE = new StructuredSyslogMessageProcessor(); + protected static StructuredSyslogMessageProcessor defaultInstance = INSTANCE; - public StructuredSyslogMessageProcessor(final String applicationName) { - super(); - this.applicationName = applicationName; - } + private String applicationName = STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE; + private String processId = STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE; - public DateTimeFormatter getDateTimeFormatter() { - return dateTimeFormatter; - } + private DateTimeFormatter dateTimeFormatter = ISODateTimeFormat.dateTime(); - public void setDateTimeFormatter(DateTimeFormatter dateTimeFormatter) { - this.dateTimeFormatter = dateTimeFormatter; - } + public static void setDefault(StructuredSyslogMessageProcessor messageProcessor) { + if (messageProcessor != null) { + defaultInstance = messageProcessor; + } + } - public String getApplicationName() { - return this.applicationName; - } + public static StructuredSyslogMessageProcessor getDefault() { + return defaultInstance; + } - public void setApplicationName(String applicationName) { - this.applicationName = applicationName; - } + public StructuredSyslogMessageProcessor() { + super(); + } - public String getProcessId() { - return this.processId; - } + public StructuredSyslogMessageProcessor(final String applicationName) { + super(); + this.applicationName = applicationName; + } - public void setProcessId(String processId) { - this.processId = processId; - } + public DateTimeFormatter getDateTimeFormatter() { + return dateTimeFormatter; + } - public String createSyslogHeader(final int facility, final int level, String localName, final boolean sendLocalTimestamp, final boolean sendLocalName) { - final StringBuffer buffer = new StringBuffer(); + public void setDateTimeFormatter(DateTimeFormatter dateTimeFormatter) { + this.dateTimeFormatter = dateTimeFormatter; + } - appendPriority(buffer,facility,level); - buffer.append(VERSION); - buffer.append(' '); + public String getApplicationName() { + return this.applicationName; + } - getDateTimeFormatter().printTo(buffer,System.currentTimeMillis()); - buffer.append(' '); + public void setApplicationName(String applicationName) { + this.applicationName = applicationName; + } - appendLocalName(buffer,localName); + public String getProcessId() { + return this.processId; + } - buffer.append(StructuredSyslogMessage.nilProtect(this.applicationName)) - .append(' '); + public void setProcessId(String processId) { + this.processId = processId; + } - buffer.append(StructuredSyslogMessage.nilProtect(this.processId)).append(' '); - - return buffer.toString(); - } + public String createSyslogHeader(final int facility, final int level, String localName, final boolean sendLocalTimestamp, final boolean sendLocalName) { + final StringBuffer buffer = new StringBuffer(); + + appendPriority(buffer, facility, level); + buffer.append(VERSION); + buffer.append(' '); + + getDateTimeFormatter().printTo(buffer, System.currentTimeMillis()); + buffer.append(' '); + + appendLocalName(buffer, localName); + + buffer.append(StructuredSyslogMessage.nilProtect(this.applicationName)) + .append(' '); + + buffer.append(StructuredSyslogMessage.nilProtect(this.processId)).append(' '); + + return buffer.toString(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessage.java b/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessage.java index cc257fe..5f9f009 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessage.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessage.java @@ -13,379 +13,379 @@ import org.graylog2.syslog4j.impl.message.AbstractSyslogMessage; * support for turning POJO (Plain Ol' Java Objects) into Syslog messages. It * adds support for structured syslog messages as specified by * draft-ietf-syslog-protocol-23. More information here: - * + *

*

* http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 *

- * + *

*

* Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy of the * LGPL license is available in the META-INF folder in all distributions of * Syslog4j and in the base directory of the "doc" ZIP. *

- * + * * @author Manish Motwani * @version $Id: StructuredSyslogMessage.java,v 1.5 2010/09/11 16:49:24 cvs Exp $ */ public class StructuredSyslogMessage extends AbstractSyslogMessage implements StructuredSyslogMessageIF { - private static final long serialVersionUID = 3669887659567965965L; + private static final long serialVersionUID = 3669887659567965965L; - private String messageId; - private Map structuredData; - private String message; + private String messageId; + private Map structuredData; + private String message; - private StructuredSyslogMessage() { - this.messageId = null; - this.message = null; - this.structuredData = null; - } + private StructuredSyslogMessage() { + this.messageId = null; + this.message = null; + this.structuredData = null; + } - /** - * Constructs the {@link StructuredSyslogMessage} using MSGID, - * STRUCTURED-DATA and MSG fields, as described in: - * - *

- * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 - *

- * - * The Map must be a String -> (Map of String -> String), which encompasses - * the STRUCTURED-DATA field described in above document. - * - * @param messageId - * @param structuredData - * @param message - */ - public StructuredSyslogMessage(final String messageId, - final Map structuredData, final String message) { - super(); - this.messageId = messageId; - this.structuredData = structuredData; - this.message = message; + /** + * Constructs the {@link StructuredSyslogMessage} using MSGID, + * STRUCTURED-DATA and MSG fields, as described in: + *

+ *

+ * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 + *

+ *

+ * The Map must be a String -> (Map of String -> String), which encompasses + * the STRUCTURED-DATA field described in above document. + * + * @param messageId + * @param structuredData + * @param message + */ + public StructuredSyslogMessage(final String messageId, + final Map structuredData, final String message) { + super(); + this.messageId = messageId; + this.structuredData = structuredData; + this.message = message; - ensureCorrectMapType(); - } + ensureCorrectMapType(); + } - private void ensureCorrectMapType() { - if (!(getStructuredData() == null)) { - Set sdEntrySet = getStructuredData().entrySet(); - for (Iterator it = sdEntrySet.iterator(); it.hasNext();) { - Map.Entry sdEntry = (Map.Entry) it.next(); - if (!(sdEntry.getKey() instanceof String)) { - throw new IllegalArgumentException( - "Structured data map must be a map of String -> (Map of String,String)"); - } - if (!(sdEntry.getValue() instanceof Map)) { - throw new IllegalArgumentException( - "Structured data map must be a map of String -> (Map of String,String)"); - } + private void ensureCorrectMapType() { + if (!(getStructuredData() == null)) { + Set sdEntrySet = getStructuredData().entrySet(); + for (Iterator it = sdEntrySet.iterator(); it.hasNext(); ) { + Map.Entry sdEntry = (Map.Entry) it.next(); + if (!(sdEntry.getKey() instanceof String)) { + throw new IllegalArgumentException( + "Structured data map must be a map of String -> (Map of String,String)"); + } + if (!(sdEntry.getValue() instanceof Map)) { + throw new IllegalArgumentException( + "Structured data map must be a map of String -> (Map of String,String)"); + } - Set entrySet = ((Map) sdEntry.getValue()).entrySet(); - for (Iterator it2 = entrySet.iterator(); it2.hasNext();) { - Map.Entry entry = (Map.Entry) it2.next(); + Set entrySet = ((Map) sdEntry.getValue()).entrySet(); + for (Iterator it2 = entrySet.iterator(); it2.hasNext(); ) { + Map.Entry entry = (Map.Entry) it2.next(); - if (!(entry.getKey() instanceof String)) { - throw new IllegalArgumentException( - "Structured data map must be a map of String -> (Map of String,String)"); - } - if (!(entry.getValue() instanceof String)) { - throw new IllegalArgumentException( - "Structured data map must be a map of String -> (Map of String,String)"); - } - } - } + if (!(entry.getKey() instanceof String)) { + throw new IllegalArgumentException( + "Structured data map must be a map of String -> (Map of String,String)"); + } + if (!(entry.getValue() instanceof String)) { + throw new IllegalArgumentException( + "Structured data map must be a map of String -> (Map of String,String)"); + } + } + } - } - } + } + } - /** - * Parses and loads a {@link StructuredSyslogMessage} from string. - * - * @param syslogMessageStr - * @return Returns an instance of StructuredSyslogMessage. - */ - public static StructuredSyslogMessage fromString( - final String syslogMessageStr) { - final StructuredSyslogMessage syslogMessage = new StructuredSyslogMessage(); - syslogMessage.deserialize(syslogMessageStr); - return syslogMessage; - } + /** + * Parses and loads a {@link StructuredSyslogMessage} from string. + * + * @param syslogMessageStr + * @return Returns an instance of StructuredSyslogMessage. + */ + public static StructuredSyslogMessage fromString( + final String syslogMessageStr) { + final StructuredSyslogMessage syslogMessage = new StructuredSyslogMessage(); + syslogMessage.deserialize(syslogMessageStr); + return syslogMessage; + } - private void deserialize(final String stringMessage) { - // Check correct format - if (stringMessage.indexOf('[') <= 0) - throw new IllegalArgumentException("Invalid Syslog string format: " - + stringMessage); + private void deserialize(final String stringMessage) { + // Check correct format + if (stringMessage.indexOf('[') <= 0) + throw new IllegalArgumentException("Invalid Syslog string format: " + + stringMessage); - // Divide the string in 2 sections - final String syslogHeader = stringMessage.substring(0, stringMessage - .indexOf('[')); - String structuredDataString = stringMessage.substring(stringMessage - .indexOf('['), stringMessage.lastIndexOf(']') + 1); - - if ((stringMessage.lastIndexOf(']') + 2) <= stringMessage.length()) - this.message = stringMessage.substring(stringMessage.lastIndexOf(']') + 2); - - else { - this.message = ""; - } - - // Split into tokens - final String[] tokens = syslogHeader.split(" "); + // Divide the string in 2 sections + final String syslogHeader = stringMessage.substring(0, stringMessage + .indexOf('[')); + String structuredDataString = stringMessage.substring(stringMessage + .indexOf('['), stringMessage.lastIndexOf(']') + 1); - // Check number of tokens must be 1 -- rest of the header should already - // be stripped - if (tokens.length != 1) { - throw new IllegalArgumentException("Invalid Syslog string format: " - + stringMessage); - } + if ((stringMessage.lastIndexOf(']') + 2) <= stringMessage.length()) + this.message = stringMessage.substring(stringMessage.lastIndexOf(']') + 2); - this.messageId = SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(tokens[0]) ? null - : tokens[0]; + else { + this.message = ""; + } - this.structuredData = new HashMap(); - if (!SyslogConstants.STRUCTURED_DATA_EMPTY_VALUE.equals(structuredDataString)) { - while (!"".equals(structuredDataString)) { - if (!structuredDataString.startsWith("[") - || structuredDataString.indexOf(']') == -1) { - throw new IllegalArgumentException( - "Invalid structured data format in Syslog message: " - + stringMessage); - } + // Split into tokens + final String[] tokens = syslogHeader.split(" "); - final String structuredDataIteration = structuredDataString - .substring(1, structuredDataString.indexOf(']')); + // Check number of tokens must be 1 -- rest of the header should already + // be stripped + if (tokens.length != 1) { + throw new IllegalArgumentException("Invalid Syslog string format: " + + stringMessage); + } - final Map iterMap = new HashMap(); + this.messageId = SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(tokens[0]) ? null + : tokens[0]; - final String[] params = structuredDataIteration.split(" "); + this.structuredData = new HashMap(); + if (!SyslogConstants.STRUCTURED_DATA_EMPTY_VALUE.equals(structuredDataString)) { + while (!"".equals(structuredDataString)) { + if (!structuredDataString.startsWith("[") + || structuredDataString.indexOf(']') == -1) { + throw new IllegalArgumentException( + "Invalid structured data format in Syslog message: " + + stringMessage); + } - for (int i = 1; i < params.length; i++) { - final String[] paramIter = params[i].split("="); - if (paramIter.length != 2) { - throw new IllegalArgumentException( - "Invalid structured data format in Syslog message: " - + stringMessage); - } + final String structuredDataIteration = structuredDataString + .substring(1, structuredDataString.indexOf(']')); - if (!paramIter[1].startsWith("\"") - || !paramIter[1].endsWith("\"")) { - throw new IllegalArgumentException( - "Invalid structured data format in Syslog message: " - + stringMessage); - } + final Map iterMap = new HashMap(); - iterMap.put(paramIter[0], paramIter[1].substring(1, - paramIter[1].length() - 1)); - } + final String[] params = structuredDataIteration.split(" "); - this.structuredData.put(params[0], iterMap); + for (int i = 1; i < params.length; i++) { + final String[] paramIter = params[i].split("="); + if (paramIter.length != 2) { + throw new IllegalArgumentException( + "Invalid structured data format in Syslog message: " + + stringMessage); + } - if (structuredDataString.indexOf(']') != structuredDataString - .lastIndexOf(']')) { - structuredDataString = structuredDataString - .substring(structuredDataString.indexOf(']') + 1); - } else { - structuredDataString = ""; - } - } - } - } + if (!paramIter[1].startsWith("\"") + || !paramIter[1].endsWith("\"")) { + throw new IllegalArgumentException( + "Invalid structured data format in Syslog message: " + + stringMessage); + } - /** - * Returns the MSGID field of the structured message format, as described - * in: - * - *

- * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 - *

- * - * @return Returns the MSG ID field. - */ - public String getMessageId() { - return this.messageId; - } + iterMap.put(paramIter[0], paramIter[1].substring(1, + paramIter[1].length() - 1)); + } - /** - * Returns the structured data map. The Map is a String -> (Map of String -> - * String), which encompasses the STRUCTURED-DATA field, as described in: - * - *

- * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 - *

- * - * @return Returns a Map object containing structured data. - */ - public Map getStructuredData() { - return this.structuredData; - } + this.structuredData.put(params[0], iterMap); - /** - * Returns the MSG field of the structured message format, as described in: - * - *

- * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 - *

- * - * @return Returns the MSG field. - */ - public String getMessage() { - return this.message; - } + if (structuredDataString.indexOf(']') != structuredDataString + .lastIndexOf(']')) { + structuredDataString = structuredDataString + .substring(structuredDataString.indexOf(']') + 1); + } else { + structuredDataString = ""; + } + } + } + } - /* - * (non-Javadoc) - * - * @seeorg.productivity.java.syslog4j.impl.message.AbstractSyslogMessage# - * createMessage() - */ - public String createMessage() { - return serialize(); - } + /** + * Returns the MSGID field of the structured message format, as described + * in: + *

+ *

+ * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 + *

+ * + * @return Returns the MSG ID field. + */ + public String getMessageId() { + return this.messageId; + } - private String serialize() { - if (!StructuredSyslogMessage.checkIsPrintable(getMessageId())) - throw new IllegalArgumentException("Invalid message id: " - + getMessageId()); + /** + * Returns the structured data map. The Map is a String -> (Map of String -> + * String), which encompasses the STRUCTURED-DATA field, as described in: + *

+ *

+ * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 + *

+ * + * @return Returns a Map object containing structured data. + */ + public Map getStructuredData() { + return this.structuredData; + } - final StringBuffer sb = new StringBuffer(); + /** + * Returns the MSG field of the structured message format, as described in: + *

+ *

+ * http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 + *

+ * + * @return Returns the MSG field. + */ + public String getMessage() { + return this.message; + } - sb.append(StructuredSyslogMessage.nilProtect(getMessageId())); - sb.append(' '); + /* + * (non-Javadoc) + * + * @seeorg.productivity.java.syslog4j.impl.message.AbstractSyslogMessage# + * createMessage() + */ + public String createMessage() { + return serialize(); + } - if (getStructuredData() == null || getStructuredData().size() == 0) { - // This is not desired, but rsyslogd does not store version 1 syslog - // message correctly if - // there is no - // structured data present - sb.append(SyslogConstants.STRUCTURED_DATA_EMPTY_VALUE); - } else { - Set sdEntrySet = getStructuredData().entrySet(); - for (Iterator it = sdEntrySet.iterator(); it.hasNext();) { - final Map.Entry sdElement = (Map.Entry) it.next(); - final String sdId = (String) sdElement.getKey(); + private String serialize() { + if (!StructuredSyslogMessage.checkIsPrintable(getMessageId())) + throw new IllegalArgumentException("Invalid message id: " + + getMessageId()); - if (sdId == null || sdId.length() == 0 - || !StructuredSyslogMessage.checkIsPrintable(sdId)) { - throw new IllegalArgumentException( - "Illegal structured data id: " + sdId); - } + final StringBuffer sb = new StringBuffer(); - sb.append('[').append(sdId); + sb.append(StructuredSyslogMessage.nilProtect(getMessageId())); + sb.append(' '); - final Map sdParams = (Map) sdElement.getValue(); + if (getStructuredData() == null || getStructuredData().size() == 0) { + // This is not desired, but rsyslogd does not store version 1 syslog + // message correctly if + // there is no + // structured data present + sb.append(SyslogConstants.STRUCTURED_DATA_EMPTY_VALUE); + } else { + Set sdEntrySet = getStructuredData().entrySet(); + for (Iterator it = sdEntrySet.iterator(); it.hasNext(); ) { + final Map.Entry sdElement = (Map.Entry) it.next(); + final String sdId = (String) sdElement.getKey(); - if (sdParams != null) { - Set entrySet = sdParams.entrySet(); - for (Iterator it2 = entrySet.iterator(); it2.hasNext();) { - Map.Entry entry = (Map.Entry) it2.next(); - final String paramName = (String) entry.getKey(); - final String paramValue = (String) entry.getValue(); + if (sdId == null || sdId.length() == 0 + || !StructuredSyslogMessage.checkIsPrintable(sdId)) { + throw new IllegalArgumentException( + "Illegal structured data id: " + sdId); + } - if (paramName == null - || paramName.length() == 0 - || !StructuredSyslogMessage - .checkIsPrintable(paramName)) - throw new IllegalArgumentException( - "Illegal structured data parameter name: " - + paramName); + sb.append('[').append(sdId); - if (paramValue == null) - throw new IllegalArgumentException( - "Null structured data parameter value for parameter name: " - + paramName); + final Map sdParams = (Map) sdElement.getValue(); - sb.append(' '); - sb.append(paramName); - sb.append('=').append('"'); - StructuredSyslogMessage.sdEscape(sb, paramValue); - sb.append('"'); - } - } + if (sdParams != null) { + Set entrySet = sdParams.entrySet(); + for (Iterator it2 = entrySet.iterator(); it2.hasNext(); ) { + Map.Entry entry = (Map.Entry) it2.next(); + final String paramName = (String) entry.getKey(); + final String paramValue = (String) entry.getValue(); - sb.append(']'); - } - } + if (paramName == null + || paramName.length() == 0 + || !StructuredSyslogMessage + .checkIsPrintable(paramName)) + throw new IllegalArgumentException( + "Illegal structured data parameter name: " + + paramName); - if (getMessage() != null && getMessage().length() != 0) { - sb.append(' '); - sb.append(StructuredSyslogMessage.nilProtect(getMessage())); - } + if (paramValue == null) + throw new IllegalArgumentException( + "Null structured data parameter value for parameter name: " + + paramName); - return sb.toString(); + sb.append(' '); + sb.append(paramName); + sb.append('=').append('"'); + StructuredSyslogMessage.sdEscape(sb, paramValue); + sb.append('"'); + } + } - } + sb.append(']'); + } + } - public static void sdEscape(final StringBuffer sb, final String value) { - for (int i = 0; i < value.length(); i++) { - final char c = value.charAt(i); + if (getMessage() != null && getMessage().length() != 0) { + sb.append(' '); + sb.append(StructuredSyslogMessage.nilProtect(getMessage())); + } - if (c == '"' || c == '\\' || c == ']') { - sb.append('\\'); - } + return sb.toString(); - sb.append(c); - } - } + } - public static boolean checkIsPrintable(final String value) { - if (value == null) - return true; + public static void sdEscape(final StringBuffer sb, final String value) { + for (int i = 0; i < value.length(); i++) { + final char c = value.charAt(i); - for (int i = 0; i < value.length(); i++) { - final char c = value.charAt(i); + if (c == '"' || c == '\\' || c == ']') { + sb.append('\\'); + } - if (c < 33 || c > 126) - return false; - } + sb.append(c); + } + } - return true; - } + public static boolean checkIsPrintable(final String value) { + if (value == null) + return true; - public static String nilProtect(final String value) { - if (value == null || value.trim().length() == 0) { - return SyslogConstants.STRUCTURED_DATA_NILVALUE; - } + for (int i = 0; i < value.length(); i++) { + final char c = value.charAt(i); - return value; - } + if (c < 33 || c > 126) + return false; + } - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result + ((message == null) ? 0 : message.hashCode()); - result = prime * result - + ((messageId == null) ? 0 : messageId.hashCode()); - result = prime * result - + ((structuredData == null) ? 0 : structuredData.hashCode()); - return result; - } + return true; + } - public boolean equals(Object obj) { - if (this == obj) return true; - if (obj == null) return false; - if (getClass() != obj.getClass()) return false; - - StructuredSyslogMessage other = (StructuredSyslogMessage) obj; - - if (message == null) { - if (other.message != null) return false; - - } else if (!message.equals(other.message)) return false; - - if (messageId == null) { - if (other.messageId != null) return false; - - } else if (!messageId.equals(other.messageId)) return false; - - if (structuredData == null) { - if (other.structuredData != null) return false; - - } else if (!structuredData.equals(other.structuredData)) return false; - - return true; - } + public static String nilProtect(final String value) { + if (value == null || value.trim().length() == 0) { + return SyslogConstants.STRUCTURED_DATA_NILVALUE; + } - public String toString() { - return serialize(); - } + return value; + } + + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((message == null) ? 0 : message.hashCode()); + result = prime * result + + ((messageId == null) ? 0 : messageId.hashCode()); + result = prime * result + + ((structuredData == null) ? 0 : structuredData.hashCode()); + return result; + } + + public boolean equals(Object obj) { + if (this == obj) return true; + if (obj == null) return false; + if (getClass() != obj.getClass()) return false; + + StructuredSyslogMessage other = (StructuredSyslogMessage) obj; + + if (message == null) { + if (other.message != null) return false; + + } else if (!message.equals(other.message)) return false; + + if (messageId == null) { + if (other.messageId != null) return false; + + } else if (!messageId.equals(other.messageId)) return false; + + if (structuredData == null) { + if (other.structuredData != null) return false; + + } else if (!structuredData.equals(other.structuredData)) return false; + + return true; + } + + public String toString() { + return serialize(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessageIF.java b/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessageIF.java index 8ece185..57c168c 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessageIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/message/structured/StructuredSyslogMessageIF.java @@ -3,16 +3,16 @@ package org.graylog2.syslog4j.impl.message.structured; import org.graylog2.syslog4j.SyslogMessageIF; /** -* StructuredSyslogMessageIF is a "marker" interface to identify structured -* SyslogMessageIF implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: StructuredSyslogMessageIF.java,v 1.1 2009/07/22 15:54:23 cvs Exp $ -*/ + * StructuredSyslogMessageIF is a "marker" interface to identify structured + * SyslogMessageIF implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: StructuredSyslogMessageIF.java,v 1.1 2009/07/22 15:54:23 cvs Exp $ + */ public interface StructuredSyslogMessageIF extends SyslogMessageIF { - // + // } diff --git a/src/main/java/org/graylog2/syslog4j/impl/multiple/MultipleSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/multiple/MultipleSyslog.java index 9b5f9b4..839a58e 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/multiple/MultipleSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/multiple/MultipleSyslog.java @@ -9,166 +9,166 @@ import org.graylog2.syslog4j.SyslogMessageProcessorIF; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* MultipleSyslog is an aggregator Syslog implementation for allowing a single -* Syslog call to send to multiple Syslog implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: MultipleSyslog.java,v 1.10 2010/02/11 05:00:55 cvs Exp $ -*/ + * MultipleSyslog is an aggregator Syslog implementation for allowing a single + * Syslog call to send to multiple Syslog implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: MultipleSyslog.java,v 1.10 2010/02/11 05:00:55 cvs Exp $ + */ public class MultipleSyslog implements SyslogIF { - private static final long serialVersionUID = 587308197526365108L; + private static final long serialVersionUID = 587308197526365108L; - protected String syslogProtocol = null; - protected MultipleSyslogConfig multipleSyslogConfig = null; + protected String syslogProtocol = null; + protected MultipleSyslogConfig multipleSyslogConfig = null; - public void initialize(String protocol, SyslogConfigIF config) throws SyslogRuntimeException { - this.syslogProtocol = protocol; - - try { - this.multipleSyslogConfig = (MultipleSyslogConfig) config; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must be of type MultipleSyslogConfig"); - } - } + public void initialize(String protocol, SyslogConfigIF config) throws SyslogRuntimeException { + this.syslogProtocol = protocol; - public SyslogConfigIF getConfig() { - return this.multipleSyslogConfig; - } + try { + this.multipleSyslogConfig = (MultipleSyslogConfig) config; - public void debug(String message) { - log(SyslogConstants.LEVEL_DEBUG,message); - } + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must be of type MultipleSyslogConfig"); + } + } - public void debug(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_DEBUG,message); - } + public SyslogConfigIF getConfig() { + return this.multipleSyslogConfig; + } - public void critical(String message) { - log(SyslogConstants.LEVEL_CRITICAL,message); - } + public void debug(String message) { + log(SyslogConstants.LEVEL_DEBUG, message); + } - public void critical(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_CRITICAL,message); - } + public void debug(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_DEBUG, message); + } - public void error(String message) { - log(SyslogConstants.LEVEL_ERROR,message); - } + public void critical(String message) { + log(SyslogConstants.LEVEL_CRITICAL, message); + } - public void error(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_ERROR,message); - } + public void critical(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_CRITICAL, message); + } - public void alert(String message) { - log(SyslogConstants.LEVEL_ALERT,message); - } + public void error(String message) { + log(SyslogConstants.LEVEL_ERROR, message); + } - public void alert(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_ALERT,message); - } + public void error(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_ERROR, message); + } - public void notice(String message) { - log(SyslogConstants.LEVEL_NOTICE,message); - } + public void alert(String message) { + log(SyslogConstants.LEVEL_ALERT, message); + } - public void notice(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_NOTICE,message); - } + public void alert(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_ALERT, message); + } - public void emergency(String message) { - log(SyslogConstants.LEVEL_EMERGENCY,message); - } + public void notice(String message) { + log(SyslogConstants.LEVEL_NOTICE, message); + } - public void emergency(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_EMERGENCY,message); - } + public void notice(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_NOTICE, message); + } - public void info(String message) { - log(SyslogConstants.LEVEL_INFO,message); - } + public void emergency(String message) { + log(SyslogConstants.LEVEL_EMERGENCY, message); + } - public void info(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_INFO,message); - } + public void emergency(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_EMERGENCY, message); + } - public void warn(String message) { - log(SyslogConstants.LEVEL_WARN,message); - } + public void info(String message) { + log(SyslogConstants.LEVEL_INFO, message); + } - public void warn(SyslogMessageIF message) { - log(SyslogConstants.LEVEL_WARN,message); - } + public void info(SyslogMessageIF message) { + log(SyslogConstants.LEVEL_INFO, message); + } - public void log(int level, String message) { - for(int i=0; iSyslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: MultipleSyslogConfig.java,v 1.8 2010/11/28 04:15:18 cvs Exp $ -*/ + * MultipleSyslogConfig is a configuration Object for allowing a single + * Syslog call to send to multiple Syslog implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: MultipleSyslogConfig.java,v 1.8 2010/11/28 04:15:18 cvs Exp $ + */ public class MultipleSyslogConfig implements SyslogConfigIF { - private static final long serialVersionUID = 753704522364959612L; - - protected List syslogProtocols = null; - - public MultipleSyslogConfig() { - this.syslogProtocols = new ArrayList(); - } + private static final long serialVersionUID = 753704522364959612L; - public MultipleSyslogConfig(List protocols) { - if (protocols != null) { - this.syslogProtocols = protocols; - - } else { - this.syslogProtocols = new ArrayList(); - } - } + protected List syslogProtocols = null; - public MultipleSyslogConfig(String[] protocols) { - if (protocols != null) { - this.syslogProtocols = new ArrayList(protocols.length); - - for(int i=0; iSyslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractNetSyslog.java,v 1.7 2009/01/24 22:00:18 cvs Exp $ -*/ + * AbstractNetSyslog is an abstract extension of AbstractSyslog + * that provides support for network-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractNetSyslog.java,v 1.7 2009/01/24 22:00:18 cvs Exp $ + */ public abstract class AbstractNetSyslog extends AbstractSyslog { - private static final long serialVersionUID = -3250858945515853967L; - - protected static final Object cachedHostAddressSyncObject = new Object(); - - protected InetAddress cachedHostAddress = null; - - protected AbstractNetSyslogConfigIF netSyslogConfig = null; - - protected void initialize() throws SyslogRuntimeException { - try { - this.netSyslogConfig = (AbstractNetSyslogConfigIF) this.syslogConfig; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must implement interface AbstractNetSyslogConfigIF"); - } - } - - /** - * @return Returns an object of InetAddress of the local host, using caching if so directed. - */ - public InetAddress getHostAddress() { - InetAddress hostAddress = null; - - if (this.netSyslogConfig.isCacheHostAddress()) { - if (this.cachedHostAddress == null) { - synchronized(cachedHostAddressSyncObject) { - if (this.cachedHostAddress == null) { - this.cachedHostAddress = SyslogUtility.getInetAddress(this.syslogConfig.getHost()); - } - } - } - - hostAddress = this.cachedHostAddress; - - } else { - hostAddress = SyslogUtility.getInetAddress(this.syslogConfig.getHost()); - } - - return hostAddress; - } + private static final long serialVersionUID = -3250858945515853967L; + + protected static final Object cachedHostAddressSyncObject = new Object(); + + protected InetAddress cachedHostAddress = null; + + protected AbstractNetSyslogConfigIF netSyslogConfig = null; + + protected void initialize() throws SyslogRuntimeException { + try { + this.netSyslogConfig = (AbstractNetSyslogConfigIF) this.syslogConfig; + + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must implement interface AbstractNetSyslogConfigIF"); + } + } + + /** + * @return Returns an object of InetAddress of the local host, using caching if so directed. + */ + public InetAddress getHostAddress() { + InetAddress hostAddress = null; + + if (this.netSyslogConfig.isCacheHostAddress()) { + if (this.cachedHostAddress == null) { + synchronized (cachedHostAddressSyncObject) { + if (this.cachedHostAddress == null) { + this.cachedHostAddress = SyslogUtility.getInetAddress(this.syslogConfig.getHost()); + } + } + } + + hostAddress = this.cachedHostAddress; + + } else { + hostAddress = SyslogUtility.getInetAddress(this.syslogConfig.getHost()); + } + + return hostAddress; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfig.java index ec9935e..c1a04c0 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfig.java @@ -3,83 +3,83 @@ package org.graylog2.syslog4j.impl.net; import org.graylog2.syslog4j.impl.AbstractSyslogConfig; /** -* AbstractNetSyslogConfig is an abstract extension of AbstractSyslogConfig -* that provides configuration support for network-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractNetSyslogConfig.java,v 1.12 2010/10/25 03:50:25 cvs Exp $ -*/ + * AbstractNetSyslogConfig is an abstract extension of AbstractSyslogConfig + * that provides configuration support for network-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractNetSyslogConfig.java,v 1.12 2010/10/25 03:50:25 cvs Exp $ + */ public abstract class AbstractNetSyslogConfig extends AbstractSyslogConfig implements AbstractNetSyslogConfigIF { - private static final long serialVersionUID = 7240133962159244924L; + private static final long serialVersionUID = 7240133962159244924L; - protected String host = SYSLOG_HOST_DEFAULT; - protected int port = SYSLOG_PORT_DEFAULT; - - protected boolean cacheHostAddress = CACHE_HOST_ADDRESS_DEFAULT; - - protected int maxQueueSize = MAX_QUEUE_SIZE_DEFAULT; - - public AbstractNetSyslogConfig() { - // - } - - public AbstractNetSyslogConfig(int facility) { - this.facility = facility; - } + protected String host = SYSLOG_HOST_DEFAULT; + protected int port = SYSLOG_PORT_DEFAULT; - public AbstractNetSyslogConfig(int facility, String host) { - this.facility = facility; - this.host = host; - } + protected boolean cacheHostAddress = CACHE_HOST_ADDRESS_DEFAULT; - public AbstractNetSyslogConfig(String host) { - this.host = host; - } + protected int maxQueueSize = MAX_QUEUE_SIZE_DEFAULT; - public AbstractNetSyslogConfig(int facility, String host, int port) { - this.facility = facility; - this.host = host; - this.port = port; - } + public AbstractNetSyslogConfig() { + // + } - public AbstractNetSyslogConfig(String host, int port) { - this.host = host; - this.port = port; - } + public AbstractNetSyslogConfig(int facility) { + this.facility = facility; + } - public boolean isCacheHostAddress() { - return this.cacheHostAddress; - } - - public void setCacheHostAddress(boolean cacheHostAddress) { - this.cacheHostAddress = cacheHostAddress; - } - - public String getHost() { - return this.host; - } - - public void setHost(String host) { - this.host = host; - } - - public int getPort() { - return this.port; - } - - public void setPort(int port) { - this.port = port; - } + public AbstractNetSyslogConfig(int facility, String host) { + this.facility = facility; + this.host = host; + } - public int getMaxQueueSize() { - return maxQueueSize; - } + public AbstractNetSyslogConfig(String host) { + this.host = host; + } - public void setMaxQueueSize(int maxQueueSize) { - this.maxQueueSize = maxQueueSize; - } + public AbstractNetSyslogConfig(int facility, String host, int port) { + this.facility = facility; + this.host = host; + this.port = port; + } + + public AbstractNetSyslogConfig(String host, int port) { + this.host = host; + this.port = port; + } + + public boolean isCacheHostAddress() { + return this.cacheHostAddress; + } + + public void setCacheHostAddress(boolean cacheHostAddress) { + this.cacheHostAddress = cacheHostAddress; + } + + public String getHost() { + return this.host; + } + + public void setHost(String host) { + this.host = host; + } + + public int getPort() { + return this.port; + } + + public void setPort(int port) { + this.port = port; + } + + public int getMaxQueueSize() { + return maxQueueSize; + } + + public void setMaxQueueSize(int maxQueueSize) { + this.maxQueueSize = maxQueueSize; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfigIF.java b/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfigIF.java index 53a522e..e84247c 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/AbstractNetSyslogConfigIF.java @@ -3,17 +3,18 @@ package org.graylog2.syslog4j.impl.net; import org.graylog2.syslog4j.impl.AbstractSyslogConfigIF; /** -* AbstractNetSyslogConfigIF is a configuration interface supporting network-based -* Syslog implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractNetSyslogConfigIF.java,v 1.4 2009/06/06 19:11:02 cvs Exp $ -*/ + * AbstractNetSyslogConfigIF is a configuration interface supporting network-based + * Syslog implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractNetSyslogConfigIF.java,v 1.4 2009/06/06 19:11:02 cvs Exp $ + */ public interface AbstractNetSyslogConfigIF extends AbstractSyslogConfigIF { - public boolean isCacheHostAddress(); - public void setCacheHostAddress(boolean cacheHostAddress); + public boolean isCacheHostAddress(); + + public void setCacheHostAddress(boolean cacheHostAddress); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslog.java index 2e3da7c..dd4ffdf 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslog.java @@ -5,87 +5,87 @@ import org.graylog2.syslog4j.impl.AbstractSyslogWriter; import org.graylog2.syslog4j.impl.net.AbstractNetSyslog; /** -* TCPNetSyslog is an extension of AbstractSyslog that provides support for -* TCP/IP-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslog.java,v 1.21 2010/11/28 04:43:31 cvs Exp $ -*/ + * TCPNetSyslog is an extension of AbstractSyslog that provides support for + * TCP/IP-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslog.java,v 1.21 2010/11/28 04:43:31 cvs Exp $ + */ public class TCPNetSyslog extends AbstractNetSyslog { - private static final long serialVersionUID = -2157528355215068721L; + private static final long serialVersionUID = -2157528355215068721L; - protected TCPNetSyslogWriter writer = null; - - protected TCPNetSyslogConfigIF tcpNetSyslogConfig = null; - - public void initialize() throws SyslogRuntimeException { - super.initialize(); - - try { - this.tcpNetSyslogConfig = (TCPNetSyslogConfigIF) this.syslogConfig; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must implement interface TCPNetSyslogConfigIF"); - } - } + protected TCPNetSyslogWriter writer = null; - public AbstractSyslogWriter getWriter() { - return getWriter(true); - } + protected TCPNetSyslogConfigIF tcpNetSyslogConfig = null; - public synchronized AbstractSyslogWriter getWriter(boolean create) { - if (this.writer != null || !create) { - return this.writer; - } - - this.writer = (TCPNetSyslogWriter) createWriter(); + public void initialize() throws SyslogRuntimeException { + super.initialize(); - if (this.tcpNetSyslogConfig.isThreaded()) { - createWriterThread(this.writer); - } + try { + this.tcpNetSyslogConfig = (TCPNetSyslogConfigIF) this.syslogConfig; - return this.writer; - } - - protected void write(int level, byte[] message) throws SyslogRuntimeException { - AbstractSyslogWriter syslogWriter = getWriter(); - - try { - if (syslogWriter.hasThread()) { - syslogWriter.queue(level,message); - - } else { - synchronized(syslogWriter) { - syslogWriter.write(message); - } - } - - } finally { - returnWriter(syslogWriter); - } - } + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must implement interface TCPNetSyslogConfigIF"); + } + } - public void flush() throws SyslogRuntimeException { - AbstractSyslogWriter syslogWriter = getWriter(false); - - if (syslogWriter != null) { - syslogWriter.flush(); - } - } + public AbstractSyslogWriter getWriter() { + return getWriter(true); + } - public void shutdown() throws SyslogRuntimeException { - AbstractSyslogWriter syslogWriter = getWriter(false); - - if (syslogWriter != null) { - syslogWriter.shutdown(); - } - } + public synchronized AbstractSyslogWriter getWriter(boolean create) { + if (this.writer != null || !create) { + return this.writer; + } - public void returnWriter(AbstractSyslogWriter syslogWriter) { - // - } + this.writer = (TCPNetSyslogWriter) createWriter(); + + if (this.tcpNetSyslogConfig.isThreaded()) { + createWriterThread(this.writer); + } + + return this.writer; + } + + protected void write(int level, byte[] message) throws SyslogRuntimeException { + AbstractSyslogWriter syslogWriter = getWriter(); + + try { + if (syslogWriter.hasThread()) { + syslogWriter.queue(level, message); + + } else { + synchronized (syslogWriter) { + syslogWriter.write(message); + } + } + + } finally { + returnWriter(syslogWriter); + } + } + + public void flush() throws SyslogRuntimeException { + AbstractSyslogWriter syslogWriter = getWriter(false); + + if (syslogWriter != null) { + syslogWriter.flush(); + } + } + + public void shutdown() throws SyslogRuntimeException { + AbstractSyslogWriter syslogWriter = getWriter(false); + + if (syslogWriter != null) { + syslogWriter.shutdown(); + } + } + + public void returnWriter(AbstractSyslogWriter syslogWriter) { + // + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfig.java index b4fda09..f80dee9 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfig.java @@ -5,152 +5,152 @@ import org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig; import org.graylog2.syslog4j.util.SyslogUtility; /** -* TCPNetSyslogConfig is an extension of AbstractNetSyslogConfig that provides -* configuration support for TCP/IP-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogConfig.java,v 1.18 2010/10/29 03:14:12 cvs Exp $ -*/ + * TCPNetSyslogConfig is an extension of AbstractNetSyslogConfig that provides + * configuration support for TCP/IP-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogConfig.java,v 1.18 2010/10/29 03:14:12 cvs Exp $ + */ public class TCPNetSyslogConfig extends AbstractNetSyslogConfig implements TCPNetSyslogConfigIF { - private static final long serialVersionUID = 9023152050686365460L; - - public static byte[] SYSTEM_DELIMITER_SEQUENCE = null; - - static { - String delimiterSequence = System.getProperty("line.separator"); - - SYSTEM_DELIMITER_SEQUENCE = delimiterSequence.getBytes(); - - if (SYSTEM_DELIMITER_SEQUENCE == null || SYSTEM_DELIMITER_SEQUENCE.length < 1) { - SYSTEM_DELIMITER_SEQUENCE = SyslogConstants.TCP_DELIMITER_SEQUENCE_DEFAULT; - } - } - - protected byte[] delimiterSequence = SYSTEM_DELIMITER_SEQUENCE; - - protected boolean persistentConnection = TCP_PERSISTENT_CONNECTION_DEFAULT; - - protected boolean soLinger = TCP_SO_LINGER_DEFAULT; - protected int soLingerSeconds = TCP_SO_LINGER_SECONDS_DEFAULT; - - protected boolean keepAlive = TCP_KEEP_ALIVE_DEFAULT; - - protected boolean reuseAddress = TCP_REUSE_ADDRESS_DEFAULT; - - protected boolean setBufferSize = TCP_SET_BUFFER_SIZE_DEFAULT; - - protected int freshConnectionInterval = TCP_FRESH_CONNECTION_INTERVAL_DEFAULT; - - public TCPNetSyslogConfig() { - initialize(); - } - - protected void initialize() { - // - } + private static final long serialVersionUID = 9023152050686365460L; - public TCPNetSyslogConfig(int facility, String host, int port) { - super(facility, host, port); - initialize(); - } + public static byte[] SYSTEM_DELIMITER_SEQUENCE = null; - public TCPNetSyslogConfig(int facility, String host) { - super(facility, host); - initialize(); - } + static { + String delimiterSequence = System.getProperty("line.separator"); - public TCPNetSyslogConfig(int facility) { - super(facility); - initialize(); - } + SYSTEM_DELIMITER_SEQUENCE = delimiterSequence.getBytes(); - public TCPNetSyslogConfig(String host, int port) { - super(host, port); - initialize(); - } + if (SYSTEM_DELIMITER_SEQUENCE == null || SYSTEM_DELIMITER_SEQUENCE.length < 1) { + SYSTEM_DELIMITER_SEQUENCE = SyslogConstants.TCP_DELIMITER_SEQUENCE_DEFAULT; + } + } - public TCPNetSyslogConfig(String host) { - super(host); - initialize(); - } + protected byte[] delimiterSequence = SYSTEM_DELIMITER_SEQUENCE; - public Class getSyslogClass() { - return TCPNetSyslog.class; - } - - public byte[] getDelimiterSequence() { - return this.delimiterSequence; - } + protected boolean persistentConnection = TCP_PERSISTENT_CONNECTION_DEFAULT; - public void setDelimiterSequence(byte[] delimiterSequence) { - this.delimiterSequence = delimiterSequence; - } + protected boolean soLinger = TCP_SO_LINGER_DEFAULT; + protected int soLingerSeconds = TCP_SO_LINGER_SECONDS_DEFAULT; - public void setDelimiterSequence(String delimiterSequence) { - this.delimiterSequence = SyslogUtility.getBytes(this,delimiterSequence); - } + protected boolean keepAlive = TCP_KEEP_ALIVE_DEFAULT; - public boolean isPersistentConnection() { - return this.persistentConnection; - } + protected boolean reuseAddress = TCP_REUSE_ADDRESS_DEFAULT; - public void setPersistentConnection(boolean persistentConnection) { - this.persistentConnection = persistentConnection; - } + protected boolean setBufferSize = TCP_SET_BUFFER_SIZE_DEFAULT; - public boolean isSoLinger() { - return this.soLinger; - } + protected int freshConnectionInterval = TCP_FRESH_CONNECTION_INTERVAL_DEFAULT; - public void setSoLinger(boolean soLinger) { - this.soLinger = soLinger; - } + public TCPNetSyslogConfig() { + initialize(); + } - public int getSoLingerSeconds() { - return this.soLingerSeconds; - } + protected void initialize() { + // + } - public void setSoLingerSeconds(int soLingerSeconds) { - this.soLingerSeconds = soLingerSeconds; - } + public TCPNetSyslogConfig(int facility, String host, int port) { + super(facility, host, port); + initialize(); + } - public boolean isKeepAlive() { - return this.keepAlive; - } + public TCPNetSyslogConfig(int facility, String host) { + super(facility, host); + initialize(); + } - public void setKeepAlive(boolean keepAlive) { - this.keepAlive = keepAlive; - } + public TCPNetSyslogConfig(int facility) { + super(facility); + initialize(); + } - public boolean isReuseAddress() { - return this.reuseAddress; - } + public TCPNetSyslogConfig(String host, int port) { + super(host, port); + initialize(); + } - public void setReuseAddress(boolean reuseAddress) { - this.reuseAddress = reuseAddress; - } + public TCPNetSyslogConfig(String host) { + super(host); + initialize(); + } - public boolean isSetBufferSize() { - return this.setBufferSize; - } + public Class getSyslogClass() { + return TCPNetSyslog.class; + } - public void setSetBufferSize(boolean setBufferSize) { - this.setBufferSize = setBufferSize; - } + public byte[] getDelimiterSequence() { + return this.delimiterSequence; + } - public int getFreshConnectionInterval() { - return freshConnectionInterval; - } + public void setDelimiterSequence(byte[] delimiterSequence) { + this.delimiterSequence = delimiterSequence; + } - public void setFreshConnectionInterval(int freshConnectionInterval) { - this.freshConnectionInterval = freshConnectionInterval; - } + public void setDelimiterSequence(String delimiterSequence) { + this.delimiterSequence = SyslogUtility.getBytes(this, delimiterSequence); + } - public Class getSyslogWriterClass() { - return TCPNetSyslogWriter.class; - } + public boolean isPersistentConnection() { + return this.persistentConnection; + } + + public void setPersistentConnection(boolean persistentConnection) { + this.persistentConnection = persistentConnection; + } + + public boolean isSoLinger() { + return this.soLinger; + } + + public void setSoLinger(boolean soLinger) { + this.soLinger = soLinger; + } + + public int getSoLingerSeconds() { + return this.soLingerSeconds; + } + + public void setSoLingerSeconds(int soLingerSeconds) { + this.soLingerSeconds = soLingerSeconds; + } + + public boolean isKeepAlive() { + return this.keepAlive; + } + + public void setKeepAlive(boolean keepAlive) { + this.keepAlive = keepAlive; + } + + public boolean isReuseAddress() { + return this.reuseAddress; + } + + public void setReuseAddress(boolean reuseAddress) { + this.reuseAddress = reuseAddress; + } + + public boolean isSetBufferSize() { + return this.setBufferSize; + } + + public void setSetBufferSize(boolean setBufferSize) { + this.setBufferSize = setBufferSize; + } + + public int getFreshConnectionInterval() { + return freshConnectionInterval; + } + + public void setFreshConnectionInterval(int freshConnectionInterval) { + this.freshConnectionInterval = freshConnectionInterval; + } + + public Class getSyslogWriterClass() { + return TCPNetSyslogWriter.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfigIF.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfigIF.java index 6c03af2..66b00c9 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogConfigIF.java @@ -3,38 +3,46 @@ package org.graylog2.syslog4j.impl.net.tcp; import org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfigIF; /** -* TCPNetSyslogConfigIF is a configuration interface supporting TCP/IP-based -* Syslog implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogConfigIF.java,v 1.6 2010/10/29 03:14:12 cvs Exp $ -*/ + * TCPNetSyslogConfigIF is a configuration interface supporting TCP/IP-based + * Syslog implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogConfigIF.java,v 1.6 2010/10/29 03:14:12 cvs Exp $ + */ public interface TCPNetSyslogConfigIF extends AbstractNetSyslogConfigIF { - public byte[] getDelimiterSequence(); - public void setDelimiterSequence(byte[] delimiterSequence); + public byte[] getDelimiterSequence(); - public boolean isPersistentConnection(); - public void setPersistentConnection(boolean persistentConnection); - - public boolean isSoLinger(); - public void setSoLinger(boolean soLinger); - - public int getSoLingerSeconds(); - public void setSoLingerSeconds(int soLingerSeconds); - - public boolean isKeepAlive(); - public void setKeepAlive(boolean keepAlive); - - public boolean isReuseAddress(); - public void setReuseAddress(boolean reuseAddress); - - public boolean isSetBufferSize(); - public void setSetBufferSize(boolean setBufferSize); + public void setDelimiterSequence(byte[] delimiterSequence); - public int getFreshConnectionInterval(); - public void setFreshConnectionInterval(int interval); + public boolean isPersistentConnection(); + + public void setPersistentConnection(boolean persistentConnection); + + public boolean isSoLinger(); + + public void setSoLinger(boolean soLinger); + + public int getSoLingerSeconds(); + + public void setSoLingerSeconds(int soLingerSeconds); + + public boolean isKeepAlive(); + + public void setKeepAlive(boolean keepAlive); + + public boolean isReuseAddress(); + + public void setReuseAddress(boolean reuseAddress); + + public boolean isSetBufferSize(); + + public void setSetBufferSize(boolean setBufferSize); + + public int getFreshConnectionInterval(); + + public void setFreshConnectionInterval(int interval); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogWriter.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogWriter.java index 68ab39a..aa7e84a 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogWriter.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/TCPNetSyslogWriter.java @@ -14,213 +14,213 @@ import org.graylog2.syslog4j.impl.AbstractSyslogWriter; import org.graylog2.syslog4j.util.SyslogUtility; /** -* TCPNetSyslogWriter is an implementation of Runnable that supports sending -* TCP-based messages within a separate Thread. -* -*

When used in "threaded" mode (see TCPNetSyslogConfig for the option), -* a queuing mechanism is used (via LinkedList).

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogWriter.java,v 1.20 2010/11/28 01:38:08 cvs Exp $ -*/ + * TCPNetSyslogWriter is an implementation of Runnable that supports sending + * TCP-based messages within a separate Thread. + *

+ *

When used in "threaded" mode (see TCPNetSyslogConfig for the option), + * a queuing mechanism is used (via LinkedList).

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogWriter.java,v 1.20 2010/11/28 01:38:08 cvs Exp $ + */ public class TCPNetSyslogWriter extends AbstractSyslogWriter { - private static final long serialVersionUID = -6388813866108482855L; + private static final long serialVersionUID = -6388813866108482855L; - protected TCPNetSyslog tcpNetSyslog = null; - - protected Socket socket = null; - - protected TCPNetSyslogConfigIF tcpNetSyslogConfig = null; - - protected long lastSocketCreationTimeMs = 0; - - public TCPNetSyslogWriter() { - // - } - - public void initialize(AbstractSyslog abstractSyslog) { - super.initialize(abstractSyslog); - - this.tcpNetSyslog = (TCPNetSyslog) abstractSyslog; - - this.tcpNetSyslogConfig = (TCPNetSyslogConfigIF) this.tcpNetSyslog.getConfig(); - } - - protected SocketFactory obtainSocketFactory() { - return SocketFactory.getDefault(); - } - - protected Socket createSocket(InetAddress hostAddress, int port, boolean keepalive) throws IOException { - SocketFactory socketFactory = obtainSocketFactory(); - - Socket newSocket = socketFactory.createSocket(hostAddress,port); + protected TCPNetSyslog tcpNetSyslog = null; - if (this.tcpNetSyslogConfig.isSoLinger()) { - newSocket.setSoLinger(true,this.tcpNetSyslogConfig.getSoLingerSeconds()); - } - - if (this.tcpNetSyslogConfig.isKeepAlive()) { - newSocket.setKeepAlive(keepalive); - } - - if (this.tcpNetSyslogConfig.isReuseAddress()) { - newSocket.setReuseAddress(true); - } - - return newSocket; - } - - protected Socket getSocket() throws SyslogRuntimeException { - if (this.socket != null && this.socket.isConnected()) { - int freshConnectionInterval = this.tcpNetSyslogConfig.getFreshConnectionInterval(); - - if (freshConnectionInterval > 0) { - long currentTimeMs = System.currentTimeMillis(); - - if ((currentTimeMs - lastSocketCreationTimeMs) >= freshConnectionInterval) { - closeSocket(this.socket); - } - - } else { - return this.socket; - } - } - - if (this.socket == null) { - lastSocketCreationTimeMs = 0; - - try { - InetAddress hostAddress = this.tcpNetSyslog.getHostAddress(); - - this.socket = createSocket(hostAddress,this.syslog.getConfig().getPort(),this.tcpNetSyslogConfig.isPersistentConnection()); - lastSocketCreationTimeMs = System.currentTimeMillis(); - - } catch (IOException ioe) { - throw new SyslogRuntimeException(ioe); - } - } - - return this.socket; - } - - protected void closeSocket(Socket socketToClose) { - if (socketToClose == null) { - return; - } - - try { - socketToClose.close(); - - } catch (IOException ioe) { - if (!"Socket is closed".equalsIgnoreCase(ioe.getMessage())) { - throw new SyslogRuntimeException(ioe); - } - - } finally { - if (socketToClose == this.socket) { - this.socket = null; - } - } - } - - public void write(byte[] message) throws SyslogRuntimeException { - Socket currentSocket = null; - - int attempts = 0; - while(attempts != -1 && attempts < (this.tcpNetSyslogConfig.getWriteRetries() + 1)) { - try { - currentSocket = getSocket(); - - if (currentSocket == null) { - throw new SyslogRuntimeException("No socket available"); - } - - OutputStream os = currentSocket.getOutputStream(); - - if (this.tcpNetSyslogConfig.isSetBufferSize()) { - currentSocket.setSendBufferSize(message.length); - } - - os.write(message); - - byte[] delimiterSequence = this.tcpNetSyslogConfig.getDelimiterSequence(); - if (delimiterSequence != null && delimiterSequence.length > 0) { - os.write(delimiterSequence); - } - - this.syslog.setBackLogStatus(false); + protected Socket socket = null; - attempts = -1; - - if (!this.tcpNetSyslogConfig.isPersistentConnection()) { - closeSocket(currentSocket); - } - - } catch (IOException ioe) { - attempts++; - closeSocket(currentSocket); - - if (attempts >= (this.tcpNetSyslogConfig.getWriteRetries() + 1)) { - throw new SyslogRuntimeException(ioe); - } - } - } - } + protected TCPNetSyslogConfigIF tcpNetSyslogConfig = null; - public synchronized void flush() throws SyslogRuntimeException { - if (this.socket == null) { - return; - } - - if (this.syslogConfig.isThreaded()) { - this.shutdown(); - this.syslog.createWriterThread(this); - - } else { - closeSocket(this.socket); - } - } - - public synchronized void shutdown() throws SyslogRuntimeException { - this.shutdown = true; - - if (this.syslogConfig.isThreaded()) { - long timeStart = System.currentTimeMillis(); - boolean done = false; - - while(!done) { - if (this.socket == null || this.socket.isClosed()) { - done = true; - - } else { - long now = System.currentTimeMillis(); - - if (now > (timeStart + this.tcpNetSyslogConfig.getMaxShutdownWait())) { - closeSocket(this.socket); - this.thread.interrupt(); - done = true; - } - - if (!done) { - SyslogUtility.sleep(SyslogConstants.SHUTDOWN_INTERVAL); - } - } - } - - } else { - if (this.socket == null || this.socket.isClosed()) { - return; - } - - closeSocket(this.socket); - } - } - - protected void runCompleted() { - closeSocket(this.socket); - } + protected long lastSocketCreationTimeMs = 0; + + public TCPNetSyslogWriter() { + // + } + + public void initialize(AbstractSyslog abstractSyslog) { + super.initialize(abstractSyslog); + + this.tcpNetSyslog = (TCPNetSyslog) abstractSyslog; + + this.tcpNetSyslogConfig = (TCPNetSyslogConfigIF) this.tcpNetSyslog.getConfig(); + } + + protected SocketFactory obtainSocketFactory() { + return SocketFactory.getDefault(); + } + + protected Socket createSocket(InetAddress hostAddress, int port, boolean keepalive) throws IOException { + SocketFactory socketFactory = obtainSocketFactory(); + + Socket newSocket = socketFactory.createSocket(hostAddress, port); + + if (this.tcpNetSyslogConfig.isSoLinger()) { + newSocket.setSoLinger(true, this.tcpNetSyslogConfig.getSoLingerSeconds()); + } + + if (this.tcpNetSyslogConfig.isKeepAlive()) { + newSocket.setKeepAlive(keepalive); + } + + if (this.tcpNetSyslogConfig.isReuseAddress()) { + newSocket.setReuseAddress(true); + } + + return newSocket; + } + + protected Socket getSocket() throws SyslogRuntimeException { + if (this.socket != null && this.socket.isConnected()) { + int freshConnectionInterval = this.tcpNetSyslogConfig.getFreshConnectionInterval(); + + if (freshConnectionInterval > 0) { + long currentTimeMs = System.currentTimeMillis(); + + if ((currentTimeMs - lastSocketCreationTimeMs) >= freshConnectionInterval) { + closeSocket(this.socket); + } + + } else { + return this.socket; + } + } + + if (this.socket == null) { + lastSocketCreationTimeMs = 0; + + try { + InetAddress hostAddress = this.tcpNetSyslog.getHostAddress(); + + this.socket = createSocket(hostAddress, this.syslog.getConfig().getPort(), this.tcpNetSyslogConfig.isPersistentConnection()); + lastSocketCreationTimeMs = System.currentTimeMillis(); + + } catch (IOException ioe) { + throw new SyslogRuntimeException(ioe); + } + } + + return this.socket; + } + + protected void closeSocket(Socket socketToClose) { + if (socketToClose == null) { + return; + } + + try { + socketToClose.close(); + + } catch (IOException ioe) { + if (!"Socket is closed".equalsIgnoreCase(ioe.getMessage())) { + throw new SyslogRuntimeException(ioe); + } + + } finally { + if (socketToClose == this.socket) { + this.socket = null; + } + } + } + + public void write(byte[] message) throws SyslogRuntimeException { + Socket currentSocket = null; + + int attempts = 0; + while (attempts != -1 && attempts < (this.tcpNetSyslogConfig.getWriteRetries() + 1)) { + try { + currentSocket = getSocket(); + + if (currentSocket == null) { + throw new SyslogRuntimeException("No socket available"); + } + + OutputStream os = currentSocket.getOutputStream(); + + if (this.tcpNetSyslogConfig.isSetBufferSize()) { + currentSocket.setSendBufferSize(message.length); + } + + os.write(message); + + byte[] delimiterSequence = this.tcpNetSyslogConfig.getDelimiterSequence(); + if (delimiterSequence != null && delimiterSequence.length > 0) { + os.write(delimiterSequence); + } + + this.syslog.setBackLogStatus(false); + + attempts = -1; + + if (!this.tcpNetSyslogConfig.isPersistentConnection()) { + closeSocket(currentSocket); + } + + } catch (IOException ioe) { + attempts++; + closeSocket(currentSocket); + + if (attempts >= (this.tcpNetSyslogConfig.getWriteRetries() + 1)) { + throw new SyslogRuntimeException(ioe); + } + } + } + } + + public synchronized void flush() throws SyslogRuntimeException { + if (this.socket == null) { + return; + } + + if (this.syslogConfig.isThreaded()) { + this.shutdown(); + this.syslog.createWriterThread(this); + + } else { + closeSocket(this.socket); + } + } + + public synchronized void shutdown() throws SyslogRuntimeException { + this.shutdown = true; + + if (this.syslogConfig.isThreaded()) { + long timeStart = System.currentTimeMillis(); + boolean done = false; + + while (!done) { + if (this.socket == null || this.socket.isClosed()) { + done = true; + + } else { + long now = System.currentTimeMillis(); + + if (now > (timeStart + this.tcpNetSyslogConfig.getMaxShutdownWait())) { + closeSocket(this.socket); + this.thread.interrupt(); + done = true; + } + + if (!done) { + SyslogUtility.sleep(SyslogConstants.SHUTDOWN_INTERVAL); + } + } + } + + } else { + if (this.socket == null || this.socket.isClosed()) { + return; + } + + closeSocket(this.socket); + } + } + + protected void runCompleted() { + closeSocket(this.socket); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslog.java index ee4a475..e306600 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslog.java @@ -7,70 +7,70 @@ import org.graylog2.syslog4j.impl.pool.AbstractSyslogPoolFactory; import org.graylog2.syslog4j.impl.pool.generic.GenericSyslogPoolFactory; /** -* PooledTCPNetSyslog is an extension of TCPNetSyslog which provides support -* for Apache Commons Pool. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PooledTCPNetSyslog.java,v 1.5 2008/12/10 04:30:15 cvs Exp $ -*/ + * PooledTCPNetSyslog is an extension of TCPNetSyslog which provides support + * for Apache Commons Pool. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PooledTCPNetSyslog.java,v 1.5 2008/12/10 04:30:15 cvs Exp $ + */ public class PooledTCPNetSyslog extends TCPNetSyslog { - private static final long serialVersionUID = 4279960451141784200L; - - protected AbstractSyslogPoolFactory poolFactory = null; + private static final long serialVersionUID = 4279960451141784200L; - public void initialize() throws SyslogRuntimeException { - super.initialize(); - - this.poolFactory = createSyslogPoolFactory(); - - this.poolFactory.initialize(this); - } - - protected AbstractSyslogPoolFactory createSyslogPoolFactory() { - AbstractSyslogPoolFactory syslogPoolFactory = new GenericSyslogPoolFactory(); - - return syslogPoolFactory; - } + protected AbstractSyslogPoolFactory poolFactory = null; - public AbstractSyslogWriter getWriter() { - try { - AbstractSyslogWriter syslogWriter = this.poolFactory.borrowSyslogWriter(); - - return syslogWriter; - - } catch (Exception e) { - throw new SyslogRuntimeException(e); - } - } + public void initialize() throws SyslogRuntimeException { + super.initialize(); - public void returnWriter(AbstractSyslogWriter syslogWriter) { - try { - this.poolFactory.returnSyslogWriter(syslogWriter); - - } catch (Exception e) { - throw new SyslogRuntimeException(e); - } - } + this.poolFactory = createSyslogPoolFactory(); - public void flush() throws SyslogRuntimeException { - try { - this.poolFactory.clear(); - - } catch (Exception e) { - // - } - } + this.poolFactory.initialize(this); + } - public void shutdown() throws SyslogRuntimeException { - try { - this.poolFactory.close(); - - } catch (Exception e) { - // - } - } + protected AbstractSyslogPoolFactory createSyslogPoolFactory() { + AbstractSyslogPoolFactory syslogPoolFactory = new GenericSyslogPoolFactory(); + + return syslogPoolFactory; + } + + public AbstractSyslogWriter getWriter() { + try { + AbstractSyslogWriter syslogWriter = this.poolFactory.borrowSyslogWriter(); + + return syslogWriter; + + } catch (Exception e) { + throw new SyslogRuntimeException(e); + } + } + + public void returnWriter(AbstractSyslogWriter syslogWriter) { + try { + this.poolFactory.returnSyslogWriter(syslogWriter); + + } catch (Exception e) { + throw new SyslogRuntimeException(e); + } + } + + public void flush() throws SyslogRuntimeException { + try { + this.poolFactory.clear(); + + } catch (Exception e) { + // + } + } + + public void shutdown() throws SyslogRuntimeException { + try { + this.poolFactory.close(); + + } catch (Exception e) { + // + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslogConfig.java index f4ea8e1..1af4172 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/pool/PooledTCPNetSyslogConfig.java @@ -5,168 +5,168 @@ import org.graylog2.syslog4j.SyslogPoolConfigIF; import org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslogConfig; /** -* NetSyslogPoolFactory is an implementation of SyslogPoolConfigIF -* which provides configuration support for the Apache Commons Pool. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PooledTCPNetSyslogConfig.java,v 1.3 2008/11/26 15:01:47 cvs Exp $ -*/ + * NetSyslogPoolFactory is an implementation of SyslogPoolConfigIF + * which provides configuration support for the Apache Commons Pool. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PooledTCPNetSyslogConfig.java,v 1.3 2008/11/26 15:01:47 cvs Exp $ + */ public class PooledTCPNetSyslogConfig extends TCPNetSyslogConfig implements SyslogPoolConfigIF { - private static final long serialVersionUID = 2283355983363422888L; - - protected int maxActive = SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT; - protected int maxIdle = SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT; - protected long maxWait = SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT; - protected long minEvictableIdleTimeMillis = SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT; - protected int minIdle = SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT; - protected int numTestsPerEvictionRun = SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT; - protected long softMinEvictableIdleTimeMillis = SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT; - protected long timeBetweenEvictionRunsMillis = SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT; - protected byte whenExhaustedAction = GenericObjectPool.WHEN_EXHAUSTED_BLOCK; - protected boolean testOnBorrow = SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT; - protected boolean testOnReturn = SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT; - protected boolean testWhileIdle = SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT; - - public PooledTCPNetSyslogConfig() { - // - } + private static final long serialVersionUID = 2283355983363422888L; - public PooledTCPNetSyslogConfig(int facility, String host, int port) { - super(facility, host, port); - } + protected int maxActive = SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT; + protected int maxIdle = SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT; + protected long maxWait = SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT; + protected long minEvictableIdleTimeMillis = SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT; + protected int minIdle = SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT; + protected int numTestsPerEvictionRun = SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT; + protected long softMinEvictableIdleTimeMillis = SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT; + protected long timeBetweenEvictionRunsMillis = SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT; + protected byte whenExhaustedAction = GenericObjectPool.WHEN_EXHAUSTED_BLOCK; + protected boolean testOnBorrow = SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT; + protected boolean testOnReturn = SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT; + protected boolean testWhileIdle = SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT; - public PooledTCPNetSyslogConfig(int facility, String host) { - super(facility, host); - } + public PooledTCPNetSyslogConfig() { + // + } - public PooledTCPNetSyslogConfig(int facility) { - super(facility); - } + public PooledTCPNetSyslogConfig(int facility, String host, int port) { + super(facility, host, port); + } - public PooledTCPNetSyslogConfig(String host, int port) { - super(host, port); - } + public PooledTCPNetSyslogConfig(int facility, String host) { + super(facility, host); + } - public PooledTCPNetSyslogConfig(String host) { - super(host); - } - - protected void configureThreadedValues(int value) { - if (isThreaded()) { - this.minIdle = value; - this.maxIdle = value; - this.maxActive = value; - } - } - - public int getMaxActive() { - return this.maxActive; - } + public PooledTCPNetSyslogConfig(int facility) { + super(facility); + } - public void setMaxActive(int maxActive) { - configureThreadedValues(maxActive); - - this.maxActive = maxActive; - } + public PooledTCPNetSyslogConfig(String host, int port) { + super(host, port); + } - public int getMaxIdle() { - return this.maxIdle; - } + public PooledTCPNetSyslogConfig(String host) { + super(host); + } - public void setMaxIdle(int maxIdle) { - configureThreadedValues(maxIdle); - - this.maxIdle = maxIdle; - } + protected void configureThreadedValues(int value) { + if (isThreaded()) { + this.minIdle = value; + this.maxIdle = value; + this.maxActive = value; + } + } - public long getMaxWait() { - return this.maxWait; - } + public int getMaxActive() { + return this.maxActive; + } - public void setMaxWait(long maxWait) { - this.maxWait = maxWait; - } + public void setMaxActive(int maxActive) { + configureThreadedValues(maxActive); - public long getMinEvictableIdleTimeMillis() { - return this.minEvictableIdleTimeMillis; - } + this.maxActive = maxActive; + } - public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis) { - this.minEvictableIdleTimeMillis = minEvictableIdleTimeMillis; - } + public int getMaxIdle() { + return this.maxIdle; + } - public int getMinIdle() { - return this.minIdle; - } + public void setMaxIdle(int maxIdle) { + configureThreadedValues(maxIdle); - public void setMinIdle(int minIdle) { - configureThreadedValues(minIdle); - - this.minIdle = minIdle; - } + this.maxIdle = maxIdle; + } - public int getNumTestsPerEvictionRun() { - return this.numTestsPerEvictionRun; - } + public long getMaxWait() { + return this.maxWait; + } - public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) { - this.numTestsPerEvictionRun = numTestsPerEvictionRun; - } + public void setMaxWait(long maxWait) { + this.maxWait = maxWait; + } - public long getSoftMinEvictableIdleTimeMillis() { - return this.softMinEvictableIdleTimeMillis; - } + public long getMinEvictableIdleTimeMillis() { + return this.minEvictableIdleTimeMillis; + } - public void setSoftMinEvictableIdleTimeMillis( - long softMinEvictableIdleTimeMillis) { - this.softMinEvictableIdleTimeMillis = softMinEvictableIdleTimeMillis; - } + public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis) { + this.minEvictableIdleTimeMillis = minEvictableIdleTimeMillis; + } - public long getTimeBetweenEvictionRunsMillis() { - return this.timeBetweenEvictionRunsMillis; - } + public int getMinIdle() { + return this.minIdle; + } - public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis) { - this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis; - } + public void setMinIdle(int minIdle) { + configureThreadedValues(minIdle); - public byte getWhenExhaustedAction() { - return this.whenExhaustedAction; - } + this.minIdle = minIdle; + } - public void setWhenExhaustedAction(byte whenExhaustedAction) { - this.whenExhaustedAction = whenExhaustedAction; - } + public int getNumTestsPerEvictionRun() { + return this.numTestsPerEvictionRun; + } - public boolean isTestOnBorrow() { - return this.testOnBorrow; - } + public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) { + this.numTestsPerEvictionRun = numTestsPerEvictionRun; + } - public void setTestOnBorrow(boolean testOnBorrow) { - this.testOnBorrow = testOnBorrow; - } + public long getSoftMinEvictableIdleTimeMillis() { + return this.softMinEvictableIdleTimeMillis; + } - public boolean isTestOnReturn() { - return this.testOnReturn; - } + public void setSoftMinEvictableIdleTimeMillis( + long softMinEvictableIdleTimeMillis) { + this.softMinEvictableIdleTimeMillis = softMinEvictableIdleTimeMillis; + } - public void setTestOnReturn(boolean testOnReturn) { - this.testOnReturn = testOnReturn; - } + public long getTimeBetweenEvictionRunsMillis() { + return this.timeBetweenEvictionRunsMillis; + } - public boolean isTestWhileIdle() { - return this.testWhileIdle; - } + public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis) { + this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis; + } - public void setTestWhileIdle(boolean testWhileIdle) { - this.testWhileIdle = testWhileIdle; - } + public byte getWhenExhaustedAction() { + return this.whenExhaustedAction; + } - public Class getSyslogClass() { - return PooledTCPNetSyslog.class; - } + public void setWhenExhaustedAction(byte whenExhaustedAction) { + this.whenExhaustedAction = whenExhaustedAction; + } + + public boolean isTestOnBorrow() { + return this.testOnBorrow; + } + + public void setTestOnBorrow(boolean testOnBorrow) { + this.testOnBorrow = testOnBorrow; + } + + public boolean isTestOnReturn() { + return this.testOnReturn; + } + + public void setTestOnReturn(boolean testOnReturn) { + this.testOnReturn = testOnReturn; + } + + public boolean isTestWhileIdle() { + return this.testWhileIdle; + } + + public void setTestWhileIdle(boolean testWhileIdle) { + this.testWhileIdle = testWhileIdle; + } + + public Class getSyslogClass() { + return PooledTCPNetSyslog.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslog.java index 0cf6867..71de576 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslog.java @@ -4,46 +4,46 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslog; /** -* SSLTCPNetSyslog is an extension of AbstractSyslog that provides support for -* TCP/IP-based (over SSL/TLS) syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslog.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslog is an extension of AbstractSyslog that provides support for + * TCP/IP-based (over SSL/TLS) syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslog.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ + */ public class SSLTCPNetSyslog extends TCPNetSyslog { - private static final long serialVersionUID = 2766654802524487317L; + private static final long serialVersionUID = 2766654802524487317L; - public void initialize() throws SyslogRuntimeException { - super.initialize(); - - SSLTCPNetSyslogConfigIF sslTcpNetSyslogConfig = (SSLTCPNetSyslogConfigIF) this.tcpNetSyslogConfig; - - String keyStore = sslTcpNetSyslogConfig.getKeyStore(); - - if (keyStore != null && !"".equals(keyStore.trim())) { - System.setProperty("javax.net.ssl.keyStore",keyStore); - } + public void initialize() throws SyslogRuntimeException { + super.initialize(); - String keyStorePassword = sslTcpNetSyslogConfig.getKeyStorePassword(); - - if (keyStorePassword != null && !"".equals(keyStorePassword.trim())) { - System.setProperty("javax.net.ssl.keyStorePassword",keyStorePassword); - } + SSLTCPNetSyslogConfigIF sslTcpNetSyslogConfig = (SSLTCPNetSyslogConfigIF) this.tcpNetSyslogConfig; - String trustStore = sslTcpNetSyslogConfig.getTrustStore(); - - if (trustStore != null && !"".equals(trustStore.trim())) { - System.setProperty("javax.net.ssl.trustStore",trustStore); - } + String keyStore = sslTcpNetSyslogConfig.getKeyStore(); - String trustStorePassword = sslTcpNetSyslogConfig.getTrustStorePassword(); - - if (trustStorePassword != null && !"".equals(trustStorePassword.trim())) { - System.setProperty("javax.net.ssl.trustStorePassword",trustStorePassword); - } - } + if (keyStore != null && !"".equals(keyStore.trim())) { + System.setProperty("javax.net.ssl.keyStore", keyStore); + } + + String keyStorePassword = sslTcpNetSyslogConfig.getKeyStorePassword(); + + if (keyStorePassword != null && !"".equals(keyStorePassword.trim())) { + System.setProperty("javax.net.ssl.keyStorePassword", keyStorePassword); + } + + String trustStore = sslTcpNetSyslogConfig.getTrustStore(); + + if (trustStore != null && !"".equals(trustStore.trim())) { + System.setProperty("javax.net.ssl.trustStore", trustStore); + } + + String trustStorePassword = sslTcpNetSyslogConfig.getTrustStorePassword(); + + if (trustStorePassword != null && !"".equals(trustStorePassword.trim())) { + System.setProperty("javax.net.ssl.trustStorePassword", trustStorePassword); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfig.java index a88a1bd..34f4094 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfig.java @@ -3,86 +3,86 @@ package org.graylog2.syslog4j.impl.net.tcp.ssl; import org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslogConfig; /** -* SSLTCPNetSyslogConfig is an extension of TCPNetSyslogConfig that provides -* configuration support for TCP/IP-based (over SSL/TLS) syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogConfig.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogConfig is an extension of TCPNetSyslogConfig that provides + * configuration support for TCP/IP-based (over SSL/TLS) syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogConfig.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ + */ public class SSLTCPNetSyslogConfig extends TCPNetSyslogConfig implements SSLTCPNetSyslogConfigIF { - private static final long serialVersionUID = 5569086213824510834L; + private static final long serialVersionUID = 5569086213824510834L; - protected String keyStore = null; - protected String keyStorePassword = null; + protected String keyStore = null; + protected String keyStorePassword = null; - protected String trustStore = null; - protected String trustStorePassword = null; + protected String trustStore = null; + protected String trustStorePassword = null; - public SSLTCPNetSyslogConfig() { - // - } + public SSLTCPNetSyslogConfig() { + // + } - public SSLTCPNetSyslogConfig(int facility, String host, int port) { - super(facility, host, port); - } + public SSLTCPNetSyslogConfig(int facility, String host, int port) { + super(facility, host, port); + } - public SSLTCPNetSyslogConfig(int facility, String host) { - super(facility, host); - } + public SSLTCPNetSyslogConfig(int facility, String host) { + super(facility, host); + } - public SSLTCPNetSyslogConfig(int facility) { - super(facility); - } + public SSLTCPNetSyslogConfig(int facility) { + super(facility); + } - public SSLTCPNetSyslogConfig(String host, int port) { - super(host, port); - } + public SSLTCPNetSyslogConfig(String host, int port) { + super(host, port); + } - public SSLTCPNetSyslogConfig(String host) { - super(host); - } - - public String getKeyStore() { - return this.keyStore; - } - - public void setKeyStore(String keyStore) { - this.keyStore = keyStore; - } - - public String getKeyStorePassword() { - return this.keyStorePassword; - } - - public void setKeyStorePassword(String keyStorePassword) { - this.keyStorePassword = keyStorePassword; - } + public SSLTCPNetSyslogConfig(String host) { + super(host); + } - public String getTrustStore() { - return this.trustStore; - } + public String getKeyStore() { + return this.keyStore; + } - public void setTrustStore(String trustStore) { - this.trustStore = trustStore; - } + public void setKeyStore(String keyStore) { + this.keyStore = keyStore; + } - public String getTrustStorePassword() { - return this.trustStorePassword; - } + public String getKeyStorePassword() { + return this.keyStorePassword; + } - public void setTrustStorePassword(String trustStorePassword) { - this.trustStorePassword = trustStorePassword; - } + public void setKeyStorePassword(String keyStorePassword) { + this.keyStorePassword = keyStorePassword; + } - public Class getSyslogClass() { - return SSLTCPNetSyslog.class; - } + public String getTrustStore() { + return this.trustStore; + } - public Class getSyslogWriterClass() { - return SSLTCPNetSyslogWriter.class; - } + public void setTrustStore(String trustStore) { + this.trustStore = trustStore; + } + + public String getTrustStorePassword() { + return this.trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + + public Class getSyslogClass() { + return SSLTCPNetSyslog.class; + } + + public Class getSyslogWriterClass() { + return SSLTCPNetSyslogWriter.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfigIF.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfigIF.java index 6065354..fd311f5 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogConfigIF.java @@ -3,26 +3,30 @@ package org.graylog2.syslog4j.impl.net.tcp.ssl; import org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslogConfigIF; /** -* SSLTCPNetSyslogConfigIF is a configuration interface supporting TCP/IP-based -* (over SSL/TLS) Syslog implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogConfigIF.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogConfigIF is a configuration interface supporting TCP/IP-based + * (over SSL/TLS) Syslog implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogConfigIF.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ + */ public interface SSLTCPNetSyslogConfigIF extends TCPNetSyslogConfigIF { - public String getKeyStore(); - public void setKeyStore(String keyStore); - - public String getKeyStorePassword(); - public void setKeyStorePassword(String keyStorePassword); + public String getKeyStore(); - public String getTrustStore(); - public void setTrustStore(String trustStore); - - public String getTrustStorePassword(); - public void setTrustStorePassword(String trustStorePassword); + public void setKeyStore(String keyStore); + + public String getKeyStorePassword(); + + public void setKeyStorePassword(String keyStorePassword); + + public String getTrustStore(); + + public void setTrustStore(String trustStore); + + public String getTrustStorePassword(); + + public void setTrustStorePassword(String trustStorePassword); } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogWriter.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogWriter.java index c60832f..24af464 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogWriter.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/SSLTCPNetSyslogWriter.java @@ -6,23 +6,23 @@ import javax.net.ssl.SSLSocketFactory; import org.graylog2.syslog4j.impl.net.tcp.TCPNetSyslogWriter; /** -* SSLTCPNetSyslogWriter is an implementation of Runnable that supports sending -* TCP/IP-based (over SSL/TLS) messages within a separate Thread. -* -*

When used in "threaded" mode (see TCPNetSyslogConfig for the option), -* a queuing mechanism is used (via LinkedList).

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogWriter.java,v 1.4 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogWriter is an implementation of Runnable that supports sending + * TCP/IP-based (over SSL/TLS) messages within a separate Thread. + *

+ *

When used in "threaded" mode (see TCPNetSyslogConfig for the option), + * a queuing mechanism is used (via LinkedList).

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogWriter.java,v 1.4 2009/03/29 17:38:58 cvs Exp $ + */ public class SSLTCPNetSyslogWriter extends TCPNetSyslogWriter { - private static final long serialVersionUID = 8944446235285662244L; + private static final long serialVersionUID = 8944446235285662244L; - protected SocketFactory obtainSocketFactory() { - return SSLSocketFactory.getDefault(); - } + protected SocketFactory obtainSocketFactory() { + return SSLSocketFactory.getDefault(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/pool/PooledSSLTCPNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/pool/PooledSSLTCPNetSyslogConfig.java index 4591070..6e96ba7 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/pool/PooledSSLTCPNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/tcp/ssl/pool/PooledSSLTCPNetSyslogConfig.java @@ -6,86 +6,86 @@ import org.graylog2.syslog4j.impl.net.tcp.ssl.SSLTCPNetSyslogConfigIF; import org.graylog2.syslog4j.impl.net.tcp.ssl.SSLTCPNetSyslogWriter; /** -* PooledSSLTCPNetSyslogConfig is an extension of PooledTCPNetSyslogConfig -* which provides configuration support for the Apache Commons Pool. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PooledSSLTCPNetSyslogConfig.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ -*/ + * PooledSSLTCPNetSyslogConfig is an extension of PooledTCPNetSyslogConfig + * which provides configuration support for the Apache Commons Pool. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PooledSSLTCPNetSyslogConfig.java,v 1.2 2009/03/29 17:38:58 cvs Exp $ + */ public class PooledSSLTCPNetSyslogConfig extends PooledTCPNetSyslogConfig implements SSLTCPNetSyslogConfigIF { - private static final long serialVersionUID = 2092268298395023976L; + private static final long serialVersionUID = 2092268298395023976L; - protected String keyStore = null; - protected String keyStorePassword = null; + protected String keyStore = null; + protected String keyStorePassword = null; - protected String trustStore = null; - protected String trustStorePassword = null; + protected String trustStore = null; + protected String trustStorePassword = null; - public PooledSSLTCPNetSyslogConfig() { - super(); - } + public PooledSSLTCPNetSyslogConfig() { + super(); + } - public PooledSSLTCPNetSyslogConfig(int facility, String host, int port) { - super(facility, host, port); - } + public PooledSSLTCPNetSyslogConfig(int facility, String host, int port) { + super(facility, host, port); + } - public PooledSSLTCPNetSyslogConfig(int facility, String host) { - super(facility, host); - } + public PooledSSLTCPNetSyslogConfig(int facility, String host) { + super(facility, host); + } - public PooledSSLTCPNetSyslogConfig(int facility) { - super(facility); - } + public PooledSSLTCPNetSyslogConfig(int facility) { + super(facility); + } - public PooledSSLTCPNetSyslogConfig(String host, int port) { - super(host, port); - } + public PooledSSLTCPNetSyslogConfig(String host, int port) { + super(host, port); + } - public PooledSSLTCPNetSyslogConfig(String host) { - super(host); - } - - public String getKeyStore() { - return this.keyStore; - } - - public void setKeyStore(String keyStore) { - this.keyStore = keyStore; - } - - public String getKeyStorePassword() { - return this.keyStorePassword; - } - - public void setKeyStorePassword(String keyStorePassword) { - this.keyStorePassword = keyStorePassword; - } + public PooledSSLTCPNetSyslogConfig(String host) { + super(host); + } - public String getTrustStore() { - return this.trustStore; - } + public String getKeyStore() { + return this.keyStore; + } - public void setTrustStore(String trustStore) { - this.trustStore = trustStore; - } + public void setKeyStore(String keyStore) { + this.keyStore = keyStore; + } - public String getTrustStorePassword() { - return this.trustStorePassword; - } + public String getKeyStorePassword() { + return this.keyStorePassword; + } - public void setTrustStorePassword(String trustStorePassword) { - this.trustStorePassword = trustStorePassword; - } + public void setKeyStorePassword(String keyStorePassword) { + this.keyStorePassword = keyStorePassword; + } - public Class getSyslogClass() { - return SSLTCPNetSyslog.class; - } + public String getTrustStore() { + return this.trustStore; + } - public Class getSyslogWriterClass() { - return SSLTCPNetSyslogWriter.class; - } + public void setTrustStore(String trustStore) { + this.trustStore = trustStore; + } + + public String getTrustStorePassword() { + return this.trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + + public Class getSyslogClass() { + return SSLTCPNetSyslog.class; + } + + public Class getSyslogWriterClass() { + return SSLTCPNetSyslogWriter.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslog.java index aea7a44..c18be95 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslog.java @@ -11,94 +11,94 @@ import org.graylog2.syslog4j.impl.AbstractSyslogWriter; import org.graylog2.syslog4j.impl.net.AbstractNetSyslog; /** -* UDPNetSyslog is an extension of AbstractSyslog that provides support for -* UDP/IP-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UDPNetSyslog.java,v 1.18 2010/10/27 06:18:10 cvs Exp $ -*/ + * UDPNetSyslog is an extension of AbstractSyslog that provides support for + * UDP/IP-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UDPNetSyslog.java,v 1.18 2010/10/27 06:18:10 cvs Exp $ + */ public class UDPNetSyslog extends AbstractNetSyslog { - private static final long serialVersionUID = 5259485504549037999L; - - protected DatagramSocket socket = null; - - public void initialize() throws SyslogRuntimeException { - super.initialize(); - - createDatagramSocket(true); - } - - protected synchronized void createDatagramSocket(boolean initialize) { - try { - this.socket = new DatagramSocket(); - - } catch (SocketException se) { - if (initialize) { - if (this.syslogConfig.isThrowExceptionOnInitialize()) { - throw new SyslogRuntimeException(se); - } - - } else { - throw new SyslogRuntimeException(se); - } - } - - if (this.socket == null) { - throw new SyslogRuntimeException("Cannot seem to get a Datagram socket"); - } - } + private static final long serialVersionUID = 5259485504549037999L; + + protected DatagramSocket socket = null; + + public void initialize() throws SyslogRuntimeException { + super.initialize(); + + createDatagramSocket(true); + } + + protected synchronized void createDatagramSocket(boolean initialize) { + try { + this.socket = new DatagramSocket(); + + } catch (SocketException se) { + if (initialize) { + if (this.syslogConfig.isThrowExceptionOnInitialize()) { + throw new SyslogRuntimeException(se); + } + + } else { + throw new SyslogRuntimeException(se); + } + } + + if (this.socket == null) { + throw new SyslogRuntimeException("Cannot seem to get a Datagram socket"); + } + } + + protected void write(int level, byte[] message) throws SyslogRuntimeException { + if (this.socket == null) { + createDatagramSocket(false); + } + + InetAddress hostAddress = getHostAddress(); - protected void write(int level, byte[] message) throws SyslogRuntimeException { - if (this.socket == null) { - createDatagramSocket(false); - } - - InetAddress hostAddress = getHostAddress(); - DatagramPacket packet = new DatagramPacket( - message, - message.length, - hostAddress, - this.syslogConfig.getPort() + message, + message.length, + hostAddress, + this.syslogConfig.getPort() ); int attempts = 0; - - while(attempts != -1 && attempts < (this.netSyslogConfig.getWriteRetries() + 1)) { - try { - this.socket.send(packet); - attempts = -1; - - } catch (IOException ioe) { - if (attempts == (this.netSyslogConfig.getWriteRetries() + 1)) { - throw new SyslogRuntimeException(ioe); - } - } + + while (attempts != -1 && attempts < (this.netSyslogConfig.getWriteRetries() + 1)) { + try { + this.socket.send(packet); + attempts = -1; + + } catch (IOException ioe) { + if (attempts == (this.netSyslogConfig.getWriteRetries() + 1)) { + throw new SyslogRuntimeException(ioe); + } + } } - } + } - public void flush() throws SyslogRuntimeException { - shutdown(); - - createDatagramSocket(true); - } - - public void shutdown() throws SyslogRuntimeException { - if (this.socket != null) { - this.socket.close(); - this.socket = null; - } - } + public void flush() throws SyslogRuntimeException { + shutdown(); - public AbstractSyslogWriter getWriter() { - return null; - } + createDatagramSocket(true); + } - public void returnWriter(AbstractSyslogWriter syslogWriter) { - // - } + public void shutdown() throws SyslogRuntimeException { + if (this.socket != null) { + this.socket.close(); + this.socket = null; + } + } + + public AbstractSyslogWriter getWriter() { + return null; + } + + public void returnWriter(AbstractSyslogWriter syslogWriter) { + // + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslogConfig.java index 4310a45..3146d0d 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/net/udp/UDPNetSyslogConfig.java @@ -3,44 +3,44 @@ package org.graylog2.syslog4j.impl.net.udp; import org.graylog2.syslog4j.impl.net.AbstractNetSyslogConfig; /** -* UDPNetSyslogConfig is an extension of AbstractNetSyslogConfig that provides -* configuration support for UDP/IP-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UDPNetSyslogConfig.java,v 1.6 2008/11/14 04:32:00 cvs Exp $ -*/ + * UDPNetSyslogConfig is an extension of AbstractNetSyslogConfig that provides + * configuration support for UDP/IP-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UDPNetSyslogConfig.java,v 1.6 2008/11/14 04:32:00 cvs Exp $ + */ public class UDPNetSyslogConfig extends AbstractNetSyslogConfig { - private static final long serialVersionUID = 4465067182562754345L; - - public UDPNetSyslogConfig() { - super(); - } + private static final long serialVersionUID = 4465067182562754345L; - public UDPNetSyslogConfig(int facility, String host, int port) { - super(facility,host,port); - } + public UDPNetSyslogConfig() { + super(); + } - public UDPNetSyslogConfig(int facility, String host) { - super(facility,host); - } + public UDPNetSyslogConfig(int facility, String host, int port) { + super(facility, host, port); + } - public UDPNetSyslogConfig(int facility) { - super(facility); - } + public UDPNetSyslogConfig(int facility, String host) { + super(facility, host); + } - public UDPNetSyslogConfig(String host, int port) { - super(host,port); - } + public UDPNetSyslogConfig(int facility) { + super(facility); + } - public UDPNetSyslogConfig(String host) { - super(host); - } + public UDPNetSyslogConfig(String host, int port) { + super(host, port); + } - public Class getSyslogClass() { - return UDPNetSyslog.class; - } + public UDPNetSyslogConfig(String host) { + super(host); + } + + public Class getSyslogClass() { + return UDPNetSyslog.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/pool/AbstractSyslogPoolFactory.java b/src/main/java/org/graylog2/syslog4j/impl/pool/AbstractSyslogPoolFactory.java index cb1a0c5..ef2a48f 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/pool/AbstractSyslogPoolFactory.java +++ b/src/main/java/org/graylog2/syslog4j/impl/pool/AbstractSyslogPoolFactory.java @@ -8,77 +8,77 @@ import org.graylog2.syslog4j.impl.AbstractSyslogConfigIF; import org.graylog2.syslog4j.impl.AbstractSyslogWriter; /** -* AbstractSyslogPoolFactory is an abstract implementation of the Apache Commons Pool -* BasePoolableObjectFactory. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogPoolFactory.java,v 1.5 2008/12/10 04:15:11 cvs Exp $ -* @see org.graylog2.syslog4j.impl.pool.generic.GenericSyslogPoolFactory -*/ + * AbstractSyslogPoolFactory is an abstract implementation of the Apache Commons Pool + * BasePoolableObjectFactory. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogPoolFactory.java,v 1.5 2008/12/10 04:15:11 cvs Exp $ + * @see org.graylog2.syslog4j.impl.pool.generic.GenericSyslogPoolFactory + */ public abstract class AbstractSyslogPoolFactory extends BasePoolableObjectFactory { - private static final long serialVersionUID = -7441569603980981508L; - - protected AbstractSyslog syslog = null; - protected AbstractSyslogConfigIF syslogConfig = null; - - protected ObjectPool pool = null; - - public AbstractSyslogPoolFactory() { - // - } + private static final long serialVersionUID = -7441569603980981508L; - public void initialize(AbstractSyslog abstractSyslog) throws SyslogRuntimeException { - this.syslog = abstractSyslog; - - try { - this.syslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); + protected AbstractSyslog syslog = null; + protected AbstractSyslogConfigIF syslogConfig = null; - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must implement AbstractSyslogConfigIF"); - } - - this.pool = createPool(); - } + protected ObjectPool pool = null; - public Object makeObject() throws Exception { - AbstractSyslogWriter syslogWriter = this.syslog.createWriter(); - - if (this.syslogConfig.isThreaded()) { - this.syslog.createWriterThread(syslogWriter); - } - - return syslogWriter; - } + public AbstractSyslogPoolFactory() { + // + } - public void destroyObject(Object obj) throws Exception { - AbstractSyslogWriter writer = (AbstractSyslogWriter) obj; + public void initialize(AbstractSyslog abstractSyslog) throws SyslogRuntimeException { + this.syslog = abstractSyslog; - writer.shutdown(); - - super.destroyObject(writer); - } - - public abstract ObjectPool createPool() throws SyslogRuntimeException; - - public AbstractSyslogWriter borrowSyslogWriter() throws Exception { - AbstractSyslogWriter syslogWriter = (AbstractSyslogWriter) this.pool.borrowObject(); - - return syslogWriter; - } + try { + this.syslogConfig = (AbstractSyslogConfigIF) this.syslog.getConfig(); - public void returnSyslogWriter(AbstractSyslogWriter syslogWriter) throws Exception { - this.pool.returnObject(syslogWriter); - } + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must implement AbstractSyslogConfigIF"); + } - public void clear() throws Exception { - this.pool.clear(); - } - - public void close() throws Exception { - this.pool.close(); - } + this.pool = createPool(); + } + + public Object makeObject() throws Exception { + AbstractSyslogWriter syslogWriter = this.syslog.createWriter(); + + if (this.syslogConfig.isThreaded()) { + this.syslog.createWriterThread(syslogWriter); + } + + return syslogWriter; + } + + public void destroyObject(Object obj) throws Exception { + AbstractSyslogWriter writer = (AbstractSyslogWriter) obj; + + writer.shutdown(); + + super.destroyObject(writer); + } + + public abstract ObjectPool createPool() throws SyslogRuntimeException; + + public AbstractSyslogWriter borrowSyslogWriter() throws Exception { + AbstractSyslogWriter syslogWriter = (AbstractSyslogWriter) this.pool.borrowObject(); + + return syslogWriter; + } + + public void returnSyslogWriter(AbstractSyslogWriter syslogWriter) throws Exception { + this.pool.returnObject(syslogWriter); + } + + public void clear() throws Exception { + this.pool.clear(); + } + + public void close() throws Exception { + this.pool.close(); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/pool/generic/GenericSyslogPoolFactory.java b/src/main/java/org/graylog2/syslog4j/impl/pool/generic/GenericSyslogPoolFactory.java index f291114..0fba0ad 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/pool/generic/GenericSyslogPoolFactory.java +++ b/src/main/java/org/graylog2/syslog4j/impl/pool/generic/GenericSyslogPoolFactory.java @@ -7,46 +7,46 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.pool.AbstractSyslogPoolFactory; /** -* GenericSyslogPoolFactory is an implementation of the Apache Commons Pool -* BasePoolableObjectFactory using a GenericObjectPool. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: GenericSyslogPoolFactory.java,v 1.5 2008/12/10 04:15:10 cvs Exp $ -*/ + * GenericSyslogPoolFactory is an implementation of the Apache Commons Pool + * BasePoolableObjectFactory using a GenericObjectPool. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: GenericSyslogPoolFactory.java,v 1.5 2008/12/10 04:15:10 cvs Exp $ + */ public class GenericSyslogPoolFactory extends AbstractSyslogPoolFactory { - protected void configureGenericObjectPool(GenericObjectPool genericObjectPool) throws SyslogRuntimeException { - SyslogPoolConfigIF poolConfig = null; - - try { - poolConfig = (SyslogPoolConfigIF) this.syslog.getConfig(); - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must implement interface SyslogPoolConfigIF"); - } - - genericObjectPool.setMaxActive(poolConfig.getMaxActive()); - genericObjectPool.setMaxIdle(poolConfig.getMaxIdle()); - genericObjectPool.setMaxWait(poolConfig.getMaxWait()); - genericObjectPool.setMinEvictableIdleTimeMillis(poolConfig.getMinEvictableIdleTimeMillis()); - genericObjectPool.setMinIdle(poolConfig.getMinIdle()); - genericObjectPool.setNumTestsPerEvictionRun(poolConfig.getNumTestsPerEvictionRun()); - genericObjectPool.setSoftMinEvictableIdleTimeMillis(poolConfig.getSoftMinEvictableIdleTimeMillis()); - genericObjectPool.setTestOnBorrow(poolConfig.isTestOnBorrow()); - genericObjectPool.setTestOnReturn(poolConfig.isTestOnReturn()); - genericObjectPool.setTestWhileIdle(poolConfig.isTestWhileIdle()); - genericObjectPool.setTimeBetweenEvictionRunsMillis(poolConfig.getTimeBetweenEvictionRunsMillis()); - genericObjectPool.setWhenExhaustedAction(poolConfig.getWhenExhaustedAction()); - } - - public ObjectPool createPool() throws SyslogRuntimeException { - GenericObjectPool genericPool = new GenericObjectPool(this); - - configureGenericObjectPool(genericPool); - - return genericPool; - } + protected void configureGenericObjectPool(GenericObjectPool genericObjectPool) throws SyslogRuntimeException { + SyslogPoolConfigIF poolConfig = null; + + try { + poolConfig = (SyslogPoolConfigIF) this.syslog.getConfig(); + + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must implement interface SyslogPoolConfigIF"); + } + + genericObjectPool.setMaxActive(poolConfig.getMaxActive()); + genericObjectPool.setMaxIdle(poolConfig.getMaxIdle()); + genericObjectPool.setMaxWait(poolConfig.getMaxWait()); + genericObjectPool.setMinEvictableIdleTimeMillis(poolConfig.getMinEvictableIdleTimeMillis()); + genericObjectPool.setMinIdle(poolConfig.getMinIdle()); + genericObjectPool.setNumTestsPerEvictionRun(poolConfig.getNumTestsPerEvictionRun()); + genericObjectPool.setSoftMinEvictableIdleTimeMillis(poolConfig.getSoftMinEvictableIdleTimeMillis()); + genericObjectPool.setTestOnBorrow(poolConfig.isTestOnBorrow()); + genericObjectPool.setTestOnReturn(poolConfig.isTestOnReturn()); + genericObjectPool.setTestWhileIdle(poolConfig.isTestWhileIdle()); + genericObjectPool.setTimeBetweenEvictionRunsMillis(poolConfig.getTimeBetweenEvictionRunsMillis()); + genericObjectPool.setWhenExhaustedAction(poolConfig.getWhenExhaustedAction()); + } + + public ObjectPool createPool() throws SyslogRuntimeException { + GenericObjectPool genericPool = new GenericObjectPool(this); + + configureGenericObjectPool(genericPool); + + return genericPool; + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslog.java index e3e31ae..1bc66a1 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslog.java @@ -11,115 +11,117 @@ import com.sun.jna.Memory; import com.sun.jna.Native; /** -* UnixSyslog is an extension of AbstractSyslog that provides support for -* Unix-based syslog clients. -* -*

This class requires the JNA (Java Native Access) library to directly -* access the native C libraries utilized on Unix platforms.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UnixSyslog.java,v 1.27 2010/10/25 04:21:19 cvs Exp $ -*/ + * UnixSyslog is an extension of AbstractSyslog that provides support for + * Unix-based syslog clients. + *

+ *

This class requires the JNA (Java Native Access) library to directly + * access the native C libraries utilized on Unix platforms.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UnixSyslog.java,v 1.27 2010/10/25 04:21:19 cvs Exp $ + */ public class UnixSyslog extends AbstractSyslog { - private static final long serialVersionUID = 4973353204252276740L; - - protected UnixSyslogConfig unixSyslogConfig = null; - + private static final long serialVersionUID = 4973353204252276740L; + + protected UnixSyslogConfig unixSyslogConfig = null; + protected interface CLibrary extends Library { public void openlog(final Memory ident, int option, int facility); + public void syslog(int priority, final String format, final String message); + public void closelog(); } - - protected static int currentFacility = -1; + + protected static int currentFacility = -1; protected static boolean openlogCalled = false; - + protected static CLibrary libraryInstance = null; - protected static synchronized void loadLibrary(UnixSyslogConfig config) throws SyslogRuntimeException { - if (!OSDetectUtility.isUnix()) { - throw new SyslogRuntimeException("UnixSyslog not supported on non-Unix platforms"); - } - - if (libraryInstance == null) { - libraryInstance = (CLibrary) Native.loadLibrary(config.getLibrary(),CLibrary.class); - } - } + protected static synchronized void loadLibrary(UnixSyslogConfig config) throws SyslogRuntimeException { + if (!OSDetectUtility.isUnix()) { + throw new SyslogRuntimeException("UnixSyslog not supported on non-Unix platforms"); + } - public void initialize() throws SyslogRuntimeException { - try { - this.unixSyslogConfig = (UnixSyslogConfig) this.syslogConfig; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must be of type UnixSyslogConfig"); - } - - loadLibrary(this.unixSyslogConfig); - } - - protected static void write(int level, String message, UnixSyslogConfig config) throws SyslogRuntimeException { - synchronized(libraryInstance) { - if (currentFacility != config.getFacility()) { - if (openlogCalled) { - libraryInstance.closelog(); - openlogCalled = false; - } - - currentFacility = config.getFacility(); - } - - if (!openlogCalled) { - String ident = config.getIdent(); - - if (ident != null && "".equals(ident.trim())) { - ident = null; - } - - Memory identBuffer = null; - - if (ident != null) { - identBuffer = new Memory(128); - identBuffer.setString(0, ident, false); - } - - libraryInstance.openlog(identBuffer,config.getOption(),currentFacility); - openlogCalled = true; - } + if (libraryInstance == null) { + libraryInstance = (CLibrary) Native.loadLibrary(config.getLibrary(), CLibrary.class); + } + } - int priority = currentFacility | level; - - libraryInstance.syslog(priority,"%s",message); - } - } + public void initialize() throws SyslogRuntimeException { + try { + this.unixSyslogConfig = (UnixSyslogConfig) this.syslogConfig; - protected void write(int level, byte[] message) throws SyslogRuntimeException { - // NO-OP - } + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must be of type UnixSyslogConfig"); + } - public void log(SyslogMessageProcessorIF messageProcessor, int level, String message) { - write(level,message,this.unixSyslogConfig); - } - - public void flush() throws SyslogRuntimeException { - synchronized(libraryInstance) { - libraryInstance.closelog(); - openlogCalled = false; - } - } + loadLibrary(this.unixSyslogConfig); + } - public void shutdown() throws SyslogRuntimeException { - flush(); - } + protected static void write(int level, String message, UnixSyslogConfig config) throws SyslogRuntimeException { + synchronized (libraryInstance) { + if (currentFacility != config.getFacility()) { + if (openlogCalled) { + libraryInstance.closelog(); + openlogCalled = false; + } - public AbstractSyslogWriter getWriter() { - return null; - } + currentFacility = config.getFacility(); + } - public void returnWriter(AbstractSyslogWriter syslogWriter) { - // - } + if (!openlogCalled) { + String ident = config.getIdent(); + + if (ident != null && "".equals(ident.trim())) { + ident = null; + } + + Memory identBuffer = null; + + if (ident != null) { + identBuffer = new Memory(128); + identBuffer.setString(0, ident, false); + } + + libraryInstance.openlog(identBuffer, config.getOption(), currentFacility); + openlogCalled = true; + } + + int priority = currentFacility | level; + + libraryInstance.syslog(priority, "%s", message); + } + } + + protected void write(int level, byte[] message) throws SyslogRuntimeException { + // NO-OP + } + + public void log(SyslogMessageProcessorIF messageProcessor, int level, String message) { + write(level, message, this.unixSyslogConfig); + } + + public void flush() throws SyslogRuntimeException { + synchronized (libraryInstance) { + libraryInstance.closelog(); + openlogCalled = false; + } + } + + public void shutdown() throws SyslogRuntimeException { + flush(); + } + + public AbstractSyslogWriter getWriter() { + return null; + } + + public void returnWriter(AbstractSyslogWriter syslogWriter) { + // + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslogConfig.java index fc080b4..699da88 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/unix/UnixSyslogConfig.java @@ -4,68 +4,68 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.AbstractSyslogConfig; /** -* UnixSyslogConfig is an extension of AbstractNetSyslogConfig that provides -* configuration support for Unix-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UnixSyslogConfig.java,v 1.13 2010/10/25 03:50:25 cvs Exp $ -*/ + * UnixSyslogConfig is an extension of AbstractNetSyslogConfig that provides + * configuration support for Unix-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UnixSyslogConfig.java,v 1.13 2010/10/25 03:50:25 cvs Exp $ + */ public class UnixSyslogConfig extends AbstractSyslogConfig { - private static final long serialVersionUID = -4805767812011660656L; + private static final long serialVersionUID = -4805767812011660656L; - protected String library = SYSLOG_LIBRARY_DEFAULT; - protected int option = OPTION_NONE; - - public UnixSyslogConfig() { - // Unix-based syslog does not need localName sent - this.setSendLocalName(false); - } + protected String library = SYSLOG_LIBRARY_DEFAULT; + protected int option = OPTION_NONE; - public Class getSyslogClass() { - return UnixSyslog.class; - } + public UnixSyslogConfig() { + // Unix-based syslog does not need localName sent + this.setSendLocalName(false); + } - public String getHost() { - return null; - } + public Class getSyslogClass() { + return UnixSyslog.class; + } - public int getPort() { - return 0; - } + public String getHost() { + return null; + } - public void setHost(String host) throws SyslogRuntimeException { - throw new SyslogRuntimeException("Host not appropriate for class \"" + this.getClass().getName() + "\""); - } + public int getPort() { + return 0; + } - public void setPort(int port) throws SyslogRuntimeException { - throw new SyslogRuntimeException("Port not appropriate for class \"" + this.getClass().getName() + "\""); - } + public void setHost(String host) throws SyslogRuntimeException { + throw new SyslogRuntimeException("Host not appropriate for class \"" + this.getClass().getName() + "\""); + } - public String getLibrary() { - return this.library; - } + public void setPort(int port) throws SyslogRuntimeException { + throw new SyslogRuntimeException("Port not appropriate for class \"" + this.getClass().getName() + "\""); + } - public void setLibrary(String library) { - this.library = library; - } + public String getLibrary() { + return this.library; + } - public int getOption() { - return this.option; - } + public void setLibrary(String library) { + this.library = library; + } - public void setOption(int option) { - this.option = option; - } + public int getOption() { + return this.option; + } - public int getMaxQueueSize() { - throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); - } + public void setOption(int option) { + this.option = option; + } - public void setMaxQueueSize(int maxQueueSize) { - throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); - } + public int getMaxQueueSize() { + throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); + } + + public void setMaxQueueSize(int maxQueueSize) { + throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslog.java b/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslog.java index 0435f0d..c8f43b0 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslog.java +++ b/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslog.java @@ -12,132 +12,136 @@ import com.sun.jna.Native; import com.sun.jna.Structure; /** -* UnixSocketSyslog is an extension of AbstractSyslog that provides support for -* Unix socket-based syslog clients. -* -*

This class requires the JNA (Java Native Access) library to directly -* access the native C libraries utilized on Unix platforms.

-* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UnixSocketSyslog.java,v 1.13 2010/11/16 00:52:01 cvs Exp $ -*/ + * UnixSocketSyslog is an extension of AbstractSyslog that provides support for + * Unix socket-based syslog clients. + *

+ *

This class requires the JNA (Java Native Access) library to directly + * access the native C libraries utilized on Unix platforms.

+ *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UnixSocketSyslog.java,v 1.13 2010/11/16 00:52:01 cvs Exp $ + */ public class UnixSocketSyslog extends AbstractSyslog { - private static final long serialVersionUID = 39878807911936785L; - - protected static class SockAddr extends Structure { - public final static int SUN_PATH_SIZE = 108; - public final static byte[] ZERO_BYTE = new byte[] { 0 }; - - public short sun_family = 1; - public byte[] sun_path = new byte[SUN_PATH_SIZE]; - - public void setSunPath(String sunPath) { - System.arraycopy(sunPath.getBytes(), 0,this.sun_path, 0, sunPath.length()); - System.arraycopy(ZERO_BYTE,0,this.sun_path,sunPath.length(),1); - } - } - + private static final long serialVersionUID = 39878807911936785L; + + protected static class SockAddr extends Structure { + public final static int SUN_PATH_SIZE = 108; + public final static byte[] ZERO_BYTE = new byte[]{0}; + + public short sun_family = 1; + public byte[] sun_path = new byte[SUN_PATH_SIZE]; + + public void setSunPath(String sunPath) { + System.arraycopy(sunPath.getBytes(), 0, this.sun_path, 0, sunPath.length()); + System.arraycopy(ZERO_BYTE, 0, this.sun_path, sunPath.length(), 1); + } + } + protected interface CLibrary extends Library { public int socket(int domain, int type, int protocol); + public int connect(int sockfd, SockAddr sockaddr, int addrlen); + public int write(int fd, ByteBuffer buffer, int count); + public int close(int fd); + public String strerror(int errno); } - - protected boolean libraryLoaded = false; + + protected boolean libraryLoaded = false; protected CLibrary libraryInstance = null; - - protected UnixSocketSyslogConfig unixSocketSyslogConfig = null; - protected int fd = -1; - - protected synchronized void loadLibrary() { - if (!OSDetectUtility.isUnix()) { - throw new SyslogRuntimeException("UnixSyslog not supported on non-Unix platforms"); - } - - if (!this.libraryLoaded) { - this.libraryInstance = (CLibrary) Native.loadLibrary(this.unixSocketSyslogConfig.getLibrary(),CLibrary.class); - this.libraryLoaded = true; - } - } - public void initialize() throws SyslogRuntimeException { - try { - this.unixSocketSyslogConfig = (UnixSocketSyslogConfig) this.syslogConfig; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must be of type UnixSocketSyslogConfig"); - } - - loadLibrary(); - - } - - protected synchronized void connect() { - if (this.fd != -1) { - return; - } - - this.fd = this.libraryInstance.socket(this.unixSocketSyslogConfig.getFamily(),this.unixSocketSyslogConfig.getType(),this.unixSocketSyslogConfig.getProtocol()); - - if (this.fd == -1) { - this.fd = -1; - return; - } - - SockAddr sockAddr = new SockAddr(); - - sockAddr.sun_family = this.unixSocketSyslogConfig.getFamily(); - sockAddr.setSunPath(this.unixSocketSyslogConfig.getPath()); - - int c = this.libraryInstance.connect(this.fd, sockAddr, sockAddr.size()); + protected UnixSocketSyslogConfig unixSocketSyslogConfig = null; + protected int fd = -1; - if (c == -1) { - this.fd = -1; - return; - } - } + protected synchronized void loadLibrary() { + if (!OSDetectUtility.isUnix()) { + throw new SyslogRuntimeException("UnixSyslog not supported on non-Unix platforms"); + } - protected void write(int level, byte[] message) throws SyslogRuntimeException { - if (this.fd == -1) { - connect(); - } - - if (this.fd == -1) { - return; - } - - ByteBuffer byteBuffer = ByteBuffer.wrap(message); - - this.libraryInstance.write(this.fd,byteBuffer,message.length); - } + if (!this.libraryLoaded) { + this.libraryInstance = (CLibrary) Native.loadLibrary(this.unixSocketSyslogConfig.getLibrary(), CLibrary.class); + this.libraryLoaded = true; + } + } - public void flush() throws SyslogRuntimeException { - shutdown(); - - this.fd = this.libraryInstance.socket(this.unixSocketSyslogConfig.getFamily(),this.unixSocketSyslogConfig.getType(),this.unixSocketSyslogConfig.getProtocol()); - } - - public void shutdown() throws SyslogRuntimeException { - if (this.fd == -1) { - return; - } - - this.libraryInstance.close(this.fd); - - this.fd = -1; - } - - public AbstractSyslogWriter getWriter() { - return null; - } + public void initialize() throws SyslogRuntimeException { + try { + this.unixSocketSyslogConfig = (UnixSocketSyslogConfig) this.syslogConfig; - public void returnWriter(AbstractSyslogWriter syslogWriter) { - // - } + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must be of type UnixSocketSyslogConfig"); + } + + loadLibrary(); + + } + + protected synchronized void connect() { + if (this.fd != -1) { + return; + } + + this.fd = this.libraryInstance.socket(this.unixSocketSyslogConfig.getFamily(), this.unixSocketSyslogConfig.getType(), this.unixSocketSyslogConfig.getProtocol()); + + if (this.fd == -1) { + this.fd = -1; + return; + } + + SockAddr sockAddr = new SockAddr(); + + sockAddr.sun_family = this.unixSocketSyslogConfig.getFamily(); + sockAddr.setSunPath(this.unixSocketSyslogConfig.getPath()); + + int c = this.libraryInstance.connect(this.fd, sockAddr, sockAddr.size()); + + if (c == -1) { + this.fd = -1; + return; + } + } + + protected void write(int level, byte[] message) throws SyslogRuntimeException { + if (this.fd == -1) { + connect(); + } + + if (this.fd == -1) { + return; + } + + ByteBuffer byteBuffer = ByteBuffer.wrap(message); + + this.libraryInstance.write(this.fd, byteBuffer, message.length); + } + + public void flush() throws SyslogRuntimeException { + shutdown(); + + this.fd = this.libraryInstance.socket(this.unixSocketSyslogConfig.getFamily(), this.unixSocketSyslogConfig.getType(), this.unixSocketSyslogConfig.getProtocol()); + } + + public void shutdown() throws SyslogRuntimeException { + if (this.fd == -1) { + return; + } + + this.libraryInstance.close(this.fd); + + this.fd = -1; + } + + public AbstractSyslogWriter getWriter() { + return null; + } + + public void returnWriter(AbstractSyslogWriter syslogWriter) { + // + } } diff --git a/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslogConfig.java b/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslogConfig.java index 0381567..6b926a6 100644 --- a/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslogConfig.java +++ b/src/main/java/org/graylog2/syslog4j/impl/unix/socket/UnixSocketSyslogConfig.java @@ -4,138 +4,138 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.impl.AbstractSyslogConfig; /** -* UnixSocketSyslogConfig is an extension of AbstractNetSyslogConfig that provides -* configuration support for Unix socket-based syslog clients. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UnixSocketSyslogConfig.java,v 1.8 2010/11/12 03:43:12 cvs Exp $ -*/ + * UnixSocketSyslogConfig is an extension of AbstractNetSyslogConfig that provides + * configuration support for Unix socket-based syslog clients. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UnixSocketSyslogConfig.java,v 1.8 2010/11/12 03:43:12 cvs Exp $ + */ public class UnixSocketSyslogConfig extends AbstractSyslogConfig { - private static final long serialVersionUID = -3145794243736015707L; + private static final long serialVersionUID = -3145794243736015707L; - protected int type = SYSLOG_SOCKET_TYPE_DEFAULT; - protected short family = SYSLOG_SOCKET_FAMILY_DEFAULT; - protected int protocol = SYSLOG_SOCKET_PROTOCOL_DEFAULT; - protected String library = SYSLOG_SOCKET_LIBRARY_DEFAULT; - protected String path = SYSLOG_SOCKET_PATH_DEFAULT; - - public UnixSocketSyslogConfig() { - // Unix-based socket does not need localName sent - this.setSendLocalName(false); - this.setIdent("java"); - } - - public Class getSyslogClass() { - return UnixSocketSyslog.class; - } + protected int type = SYSLOG_SOCKET_TYPE_DEFAULT; + protected short family = SYSLOG_SOCKET_FAMILY_DEFAULT; + protected int protocol = SYSLOG_SOCKET_PROTOCOL_DEFAULT; + protected String library = SYSLOG_SOCKET_LIBRARY_DEFAULT; + protected String path = SYSLOG_SOCKET_PATH_DEFAULT; - public UnixSocketSyslogConfig(int facility) { - this.facility = facility; - } + public UnixSocketSyslogConfig() { + // Unix-based socket does not need localName sent + this.setSendLocalName(false); + this.setIdent("java"); + } - public UnixSocketSyslogConfig(int facility, String path) { - this.facility = facility; - this.path = path; - } + public Class getSyslogClass() { + return UnixSocketSyslog.class; + } - public UnixSocketSyslogConfig(String path) { - this.path = path; - } + public UnixSocketSyslogConfig(int facility) { + this.facility = facility; + } - public String getHost() { - return null; - } + public UnixSocketSyslogConfig(int facility, String path) { + this.facility = facility; + this.path = path; + } - public int getPort() { - return -1; - } + public UnixSocketSyslogConfig(String path) { + this.path = path; + } - public void setHost(String host) throws SyslogRuntimeException { - throw new SyslogRuntimeException("Host not appropriate for class \"" + this.getClass().getName() + "\""); - } + public String getHost() { + return null; + } - public void setPort(int port) throws SyslogRuntimeException { - throw new SyslogRuntimeException("Port not appropriate for class \"" + this.getClass().getName() + "\""); - } + public int getPort() { + return -1; + } - public String getLibrary() { - return this.library; - } + public void setHost(String host) throws SyslogRuntimeException { + throw new SyslogRuntimeException("Host not appropriate for class \"" + this.getClass().getName() + "\""); + } - public void setLibrary(String library) { - this.library = library; - } + public void setPort(int port) throws SyslogRuntimeException { + throw new SyslogRuntimeException("Port not appropriate for class \"" + this.getClass().getName() + "\""); + } - public String getPath() { - return this.path; - } + public String getLibrary() { + return this.library; + } - public void setPath(String path) { - this.path = path; - } - - public int getType() { - return this.type; - } - - public void setType(int type) { - this.type = type; - } - - public void setType(String type) { - if (type == null) { - throw new SyslogRuntimeException("Type cannot be null for class \"" + this.getClass().getName() + "\""); - } - - if ("SOCK_STREAM".equalsIgnoreCase(type.trim())) { - this.type = SOCK_STREAM; - - } else if ("SOCK_DGRAM".equalsIgnoreCase(type.trim())) { - this.type = SOCK_DGRAM; - - } else { - throw new SyslogRuntimeException("Type must be \"SOCK_STREAM\" or \"SOCK_DGRAM\" for class \"" + this.getClass().getName() + "\""); - } - } + public void setLibrary(String library) { + this.library = library; + } - public short getFamily() { - return this.family; - } + public String getPath() { + return this.path; + } - public void setFamily(short family) { - this.family = family; - } + public void setPath(String path) { + this.path = path; + } - public void setFamily(String family) { - if (family == null) { - throw new SyslogRuntimeException("Family cannot be null for class \"" + this.getClass().getName() + "\""); - } - - if ("AF_UNIX".equalsIgnoreCase(family.trim())) { - this.family = AF_UNIX; - - } else { - throw new SyslogRuntimeException("Family must be \"AF_UNIX\" for class \"" + this.getClass().getName() + "\""); - } - } + public int getType() { + return this.type; + } - public int getProtocol() { - return this.protocol; - } + public void setType(int type) { + this.type = type; + } - public void setProtocol(int protocol) { - this.protocol = protocol; - } + public void setType(String type) { + if (type == null) { + throw new SyslogRuntimeException("Type cannot be null for class \"" + this.getClass().getName() + "\""); + } - public int getMaxQueueSize() { - return -1; - } + if ("SOCK_STREAM".equalsIgnoreCase(type.trim())) { + this.type = SOCK_STREAM; - public void setMaxQueueSize(int maxQueueSize) { - throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); - } + } else if ("SOCK_DGRAM".equalsIgnoreCase(type.trim())) { + this.type = SOCK_DGRAM; + + } else { + throw new SyslogRuntimeException("Type must be \"SOCK_STREAM\" or \"SOCK_DGRAM\" for class \"" + this.getClass().getName() + "\""); + } + } + + public short getFamily() { + return this.family; + } + + public void setFamily(short family) { + this.family = family; + } + + public void setFamily(String family) { + if (family == null) { + throw new SyslogRuntimeException("Family cannot be null for class \"" + this.getClass().getName() + "\""); + } + + if ("AF_UNIX".equalsIgnoreCase(family.trim())) { + this.family = AF_UNIX; + + } else { + throw new SyslogRuntimeException("Family must be \"AF_UNIX\" for class \"" + this.getClass().getName() + "\""); + } + } + + public int getProtocol() { + return this.protocol; + } + + public void setProtocol(int protocol) { + this.protocol = protocol; + } + + public int getMaxQueueSize() { + return -1; + } + + public void setMaxQueueSize(int maxQueueSize) { + throw new SyslogRuntimeException("UnixSyslog protocol does not uses a queueing mechanism"); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServer.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServer.java index 4e05fb9..445af65 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServer.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServer.java @@ -15,225 +15,225 @@ import org.graylog2.syslog4j.util.SyslogUtility; /** * This class provides a Singleton-based interface for Syslog4j * server implementations. - * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: SyslogServer.java,v 1.14 2011/01/23 20:49:12 cvs Exp $ */ public class SyslogServer implements SyslogConstants { - private static final long serialVersionUID = -2260889360828258602L; + private static final long serialVersionUID = -2260889360828258602L; - private static boolean SUPPRESS_RUNTIME_EXCEPTIONS = false; + private static boolean SUPPRESS_RUNTIME_EXCEPTIONS = false; - protected static final Map instances = new Hashtable(); - - static { - initialize(); - } - - private SyslogServer() { - // - } + protected static final Map instances = new Hashtable(); - /** - * @return Returns the current version identifier for Syslog4j. - */ - public static final String getVersion() { - return Syslog4jVersion.VERSION; - } + static { + initialize(); + } - - /** - * @param suppress - true to suppress throwing SyslogRuntimeException in many methods of this class, false to throw exceptions (default) - */ - public static void setSuppressRuntimeExceptions(boolean suppress) { - SUPPRESS_RUNTIME_EXCEPTIONS = suppress; - } - - /** - * @return Returns whether or not to suppress throwing SyslogRuntimeException in many methods of this class - */ - public static boolean getSuppressRuntimeExceptions() { - return SUPPRESS_RUNTIME_EXCEPTIONS; - } - - /** - * Throws SyslogRuntimeException unless it has been suppressed via setSuppressRuntimeException(boolean). - * - * @param message - * @throws SyslogRuntimeException - */ - private static void throwRuntimeException(String message) throws SyslogRuntimeException { - if (SUPPRESS_RUNTIME_EXCEPTIONS) { - return; - - } else { - throw new SyslogRuntimeException(message.toString()); - } - } + private SyslogServer() { + // + } - public static final SyslogServerIF getInstance(String protocol) throws SyslogRuntimeException { - String syslogProtocol = protocol.toLowerCase(); - - if (instances.containsKey(syslogProtocol)) { - return (SyslogServerIF) instances.get(syslogProtocol); - - } else { - throwRuntimeException("SyslogServer instance \"" + syslogProtocol + "\" not defined; use \"tcp\" or \"udp\" or call SyslogServer.createInstance(protocol,config) first"); - return null; - } - } - - public static final SyslogServerIF getThreadedInstance(String protocol) throws SyslogRuntimeException { - SyslogServerIF server = getInstance(protocol); + /** + * @return Returns the current version identifier for Syslog4j. + */ + public static final String getVersion() { + return Syslog4jVersion.VERSION; + } - if (server.getThread() == null) { - Thread thread = new Thread(server); - thread.setName("SyslogServer: " + protocol); - thread.setDaemon(server.getConfig().isUseDaemonThread()); - if (server.getConfig().getThreadPriority() > -1) { - thread.setPriority(server.getConfig().getThreadPriority()); - } - - server.setThread(thread); - thread.start(); - } - - return server; - } - - public static final boolean exists(String protocol) { - if (protocol == null || "".equals(protocol.trim())) { - return false; - } - - return instances.containsKey(protocol.toLowerCase()); - } - - public static final SyslogServerIF createInstance(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException { - if (protocol == null || "".equals(protocol.trim())) { - throwRuntimeException("Instance protocol cannot be null or empty"); - return null; - } - - if (config == null) { - throwRuntimeException("SyslogServerConfig cannot be null"); - return null; - } - - String syslogProtocol = protocol.toLowerCase(); - - SyslogServerIF syslogServer = null; - - synchronized(instances) { - if (instances.containsKey(syslogProtocol)) { - throwRuntimeException("SyslogServer instance \"" + syslogProtocol + "\" already defined."); - return null; - } - - try { - Class syslogClass = config.getSyslogServerClass(); - - syslogServer = (SyslogServerIF) syslogClass.newInstance(); - - } catch (ClassCastException cse) { - throw new SyslogRuntimeException(cse); - - } catch (IllegalAccessException iae) { - throw new SyslogRuntimeException(iae); - - } catch (InstantiationException ie) { - throw new SyslogRuntimeException(ie); - } - - syslogServer.initialize(syslogProtocol,config); - - instances.put(syslogProtocol,syslogServer); - } - return syslogServer; - } + /** + * @param suppress - true to suppress throwing SyslogRuntimeException in many methods of this class, false to throw exceptions (default) + */ + public static void setSuppressRuntimeExceptions(boolean suppress) { + SUPPRESS_RUNTIME_EXCEPTIONS = suppress; + } - public static final SyslogServerIF createThreadedInstance(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException { - createInstance(protocol,config); - - SyslogServerIF server = getThreadedInstance(protocol); - - return server; - } + /** + * @return Returns whether or not to suppress throwing SyslogRuntimeException in many methods of this class + */ + public static boolean getSuppressRuntimeExceptions() { + return SUPPRESS_RUNTIME_EXCEPTIONS; + } - public synchronized static final void destroyInstance(String protocol) { - if (protocol == null || "".equals(protocol.trim())) { - return; - } + /** + * Throws SyslogRuntimeException unless it has been suppressed via setSuppressRuntimeException(boolean). + * + * @param message + * @throws SyslogRuntimeException + */ + private static void throwRuntimeException(String message) throws SyslogRuntimeException { + if (SUPPRESS_RUNTIME_EXCEPTIONS) { + return; - String _protocol = protocol.toLowerCase(); - - if (instances.containsKey(_protocol)) { - SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); - - SyslogServerIF syslogServer = (SyslogServerIF) instances.get(_protocol); + } else { + throw new SyslogRuntimeException(message.toString()); + } + } - try { - syslogServer.shutdown(); - - } finally { - instances.remove(_protocol); - } - - } else { - throwRuntimeException("Cannot destroy server protocol \"" + protocol + "\" instance; call shutdown instead"); - return; - } - } - - public synchronized static final void destroyInstance(SyslogServerIF syslogServer) { - if (syslogServer == null) { - return; - } - - String protocol = syslogServer.getProtocol().toLowerCase(); - - if (instances.containsKey(protocol)) { - SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); - - try { - syslogServer.shutdown(); - - } finally { - instances.remove(protocol); - } - - } else { - throwRuntimeException("Cannot destroy server protocol \"" + protocol + "\" instance; call shutdown instead"); - } - } - - public synchronized static void initialize() { - createInstance(UDP,new UDPNetSyslogServerConfig()); - createInstance(TCP,new TCPNetSyslogServerConfig()); - } - - public synchronized static final void shutdown() throws SyslogRuntimeException { - Set protocols = instances.keySet(); - - Iterator i = protocols.iterator(); - - while(i.hasNext()) { - String protocol = (String) i.next(); - - SyslogServerIF syslogServer = (SyslogServerIF) instances.get(protocol); + public static final SyslogServerIF getInstance(String protocol) throws SyslogRuntimeException { + String syslogProtocol = protocol.toLowerCase(); - syslogServer.shutdown(); - } + if (instances.containsKey(syslogProtocol)) { + return (SyslogServerIF) instances.get(syslogProtocol); - instances.clear(); - } - - public static void main(String[] args) throws Exception { - SyslogServerMain.main(args); - } + } else { + throwRuntimeException("SyslogServer instance \"" + syslogProtocol + "\" not defined; use \"tcp\" or \"udp\" or call SyslogServer.createInstance(protocol,config) first"); + return null; + } + } + + public static final SyslogServerIF getThreadedInstance(String protocol) throws SyslogRuntimeException { + SyslogServerIF server = getInstance(protocol); + + if (server.getThread() == null) { + Thread thread = new Thread(server); + thread.setName("SyslogServer: " + protocol); + thread.setDaemon(server.getConfig().isUseDaemonThread()); + if (server.getConfig().getThreadPriority() > -1) { + thread.setPriority(server.getConfig().getThreadPriority()); + } + + server.setThread(thread); + thread.start(); + } + + return server; + } + + public static final boolean exists(String protocol) { + if (protocol == null || "".equals(protocol.trim())) { + return false; + } + + return instances.containsKey(protocol.toLowerCase()); + } + + public static final SyslogServerIF createInstance(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException { + if (protocol == null || "".equals(protocol.trim())) { + throwRuntimeException("Instance protocol cannot be null or empty"); + return null; + } + + if (config == null) { + throwRuntimeException("SyslogServerConfig cannot be null"); + return null; + } + + String syslogProtocol = protocol.toLowerCase(); + + SyslogServerIF syslogServer = null; + + synchronized (instances) { + if (instances.containsKey(syslogProtocol)) { + throwRuntimeException("SyslogServer instance \"" + syslogProtocol + "\" already defined."); + return null; + } + + try { + Class syslogClass = config.getSyslogServerClass(); + + syslogServer = (SyslogServerIF) syslogClass.newInstance(); + + } catch (ClassCastException cse) { + throw new SyslogRuntimeException(cse); + + } catch (IllegalAccessException iae) { + throw new SyslogRuntimeException(iae); + + } catch (InstantiationException ie) { + throw new SyslogRuntimeException(ie); + } + + syslogServer.initialize(syslogProtocol, config); + + instances.put(syslogProtocol, syslogServer); + } + + return syslogServer; + } + + public static final SyslogServerIF createThreadedInstance(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException { + createInstance(protocol, config); + + SyslogServerIF server = getThreadedInstance(protocol); + + return server; + } + + public synchronized static final void destroyInstance(String protocol) { + if (protocol == null || "".equals(protocol.trim())) { + return; + } + + String _protocol = protocol.toLowerCase(); + + if (instances.containsKey(_protocol)) { + SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); + + SyslogServerIF syslogServer = (SyslogServerIF) instances.get(_protocol); + + try { + syslogServer.shutdown(); + + } finally { + instances.remove(_protocol); + } + + } else { + throwRuntimeException("Cannot destroy server protocol \"" + protocol + "\" instance; call shutdown instead"); + return; + } + } + + public synchronized static final void destroyInstance(SyslogServerIF syslogServer) { + if (syslogServer == null) { + return; + } + + String protocol = syslogServer.getProtocol().toLowerCase(); + + if (instances.containsKey(protocol)) { + SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); + + try { + syslogServer.shutdown(); + + } finally { + instances.remove(protocol); + } + + } else { + throwRuntimeException("Cannot destroy server protocol \"" + protocol + "\" instance; call shutdown instead"); + } + } + + public synchronized static void initialize() { + createInstance(UDP, new UDPNetSyslogServerConfig()); + createInstance(TCP, new TCPNetSyslogServerConfig()); + } + + public synchronized static final void shutdown() throws SyslogRuntimeException { + Set protocols = instances.keySet(); + + Iterator i = protocols.iterator(); + + while (i.hasNext()) { + String protocol = (String) i.next(); + + SyslogServerIF syslogServer = (SyslogServerIF) instances.get(protocol); + + syslogServer.shutdown(); + } + + instances.clear(); + } + + public static void main(String[] args) throws Exception { + SyslogServerMain.main(args); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerConfigIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerConfigIF.java index 28e201c..22e2dc3 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerConfigIF.java @@ -7,44 +7,54 @@ import org.graylog2.syslog4j.SyslogConstants; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* SyslogServerConfigIF provides a common, extensible configuration interface for all -* implementations of SyslogServerIF. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogServerConfigIF.java,v 1.12 2011/01/11 05:11:13 cvs Exp $ -*/ + * SyslogServerConfigIF provides a common, extensible configuration interface for all + * implementations of SyslogServerIF. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogServerConfigIF.java,v 1.12 2011/01/11 05:11:13 cvs Exp $ + */ public interface SyslogServerConfigIF extends SyslogConstants, SyslogCharSetIF { - public Class getSyslogServerClass(); + public Class getSyslogServerClass(); - public String getHost(); - public void setHost(String host) throws SyslogRuntimeException; + public String getHost(); - public int getPort(); - public void setPort(int port) throws SyslogRuntimeException; - - public boolean isUseDaemonThread(); - public void setUseDaemonThread(boolean useDaemonThread); - - public int getThreadPriority(); - public void setThreadPriority(int threadPriority); - - public List getEventHandlers(); - - public long getShutdownWait(); - public void setShutdownWait(long shutdownWait); - - public void addEventHandler(SyslogServerEventHandlerIF eventHandler); - public void insertEventHandler(int pos, SyslogServerEventHandlerIF eventHandler); - public void removeEventHandler(SyslogServerEventHandlerIF eventHandler); - public void removeAllEventHandlers(); - - public boolean isUseStructuredData(); - public void setUseStructuredData(boolean useStructuredData); - - public Object getDateTimeFormatter(); - public void setDateTimeFormatter(Object dateTimeFormatter); + public void setHost(String host) throws SyslogRuntimeException; + + public int getPort(); + + public void setPort(int port) throws SyslogRuntimeException; + + public boolean isUseDaemonThread(); + + public void setUseDaemonThread(boolean useDaemonThread); + + public int getThreadPriority(); + + public void setThreadPriority(int threadPriority); + + public List getEventHandlers(); + + public long getShutdownWait(); + + public void setShutdownWait(long shutdownWait); + + public void addEventHandler(SyslogServerEventHandlerIF eventHandler); + + public void insertEventHandler(int pos, SyslogServerEventHandlerIF eventHandler); + + public void removeEventHandler(SyslogServerEventHandlerIF eventHandler); + + public void removeAllEventHandlers(); + + public boolean isUseStructuredData(); + + public void setUseStructuredData(boolean useStructuredData); + + public Object getDateTimeFormatter(); + + public void setDateTimeFormatter(Object dateTimeFormatter); } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventHandlerIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventHandlerIF.java index 8624789..9cb796c 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventHandlerIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventHandlerIF.java @@ -3,6 +3,7 @@ package org.graylog2.syslog4j.server; import java.io.Serializable; public abstract interface SyslogServerEventHandlerIF extends Serializable { - public void initialize(SyslogServerIF syslogServer); - public void destroy(SyslogServerIF syslogServer); + public void initialize(SyslogServerIF syslogServer); + + public void destroy(SyslogServerIF syslogServer); } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventIF.java index c64a833..efa90d8 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerEventIF.java @@ -5,37 +5,43 @@ import java.util.Date; import org.graylog2.syslog4j.SyslogCharSetIF; /** -* SyslogServerEventIF provides an extensible interface for Syslog4j -* server events. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogServerEventIF.java,v 1.4 2010/11/28 01:38:08 cvs Exp $ -*/ + * SyslogServerEventIF provides an extensible interface for Syslog4j + * server events. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogServerEventIF.java,v 1.4 2010/11/28 01:38:08 cvs Exp $ + */ public interface SyslogServerEventIF extends SyslogCharSetIF { - /** - * Note: getRaw() may use System.arraycopy(..) each time it is called; best to call it once and store the result. - * - * @return Returns the raw data received from the client. - */ - public byte[] getRaw(); - - public int getFacility(); - public void setFacility(int facility); + /** + * Note: getRaw() may use System.arraycopy(..) each time it is called; best to call it once and store the result. + * + * @return Returns the raw data received from the client. + */ + public byte[] getRaw(); - public Date getDate(); - public void setDate(Date date); - - public int getLevel(); - public void setLevel(int level); - - public String getHost(); - public void setHost(String host); - public boolean isHostStrippedFromMessage(); - - public String getMessage(); - public void setMessage(String message); + public int getFacility(); + + public void setFacility(int facility); + + public Date getDate(); + + public void setDate(Date date); + + public int getLevel(); + + public void setLevel(int level); + + public String getHost(); + + public void setHost(String host); + + public boolean isHostStrippedFromMessage(); + + public String getMessage(); + + public void setMessage(String message); } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerIF.java index 2b1e7a3..e25a50c 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerIF.java @@ -3,25 +3,27 @@ package org.graylog2.syslog4j.server; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* SyslogServerIF provides a common interface for all Syslog4j server implementations. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogServerIF.java,v 1.5 2008/11/07 15:15:41 cvs Exp $ -*/ + * SyslogServerIF provides a common interface for all Syslog4j server implementations. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogServerIF.java,v 1.5 2008/11/07 15:15:41 cvs Exp $ + */ public interface SyslogServerIF extends Runnable { - public void initialize(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException; - - public String getProtocol(); - public SyslogServerConfigIF getConfig(); + public void initialize(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException; - public void run(); - - public Thread getThread(); - public void setThread(Thread thread); + public String getProtocol(); - public void shutdown(); + public SyslogServerConfigIF getConfig(); + + public void run(); + + public Thread getThread(); + + public void setThread(Thread thread); + + public void shutdown(); } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerMain.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerMain.java index 3c396de..bf3aa8e 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerMain.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerMain.java @@ -8,158 +8,200 @@ import org.graylog2.syslog4j.util.SyslogUtility; /** * This class provides a command-line interface for Syslog4j * server implementations. - * + *

*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy * of the LGPL license is available in the META-INF folder in all * distributions of Syslog4j and in the base directory of the "doc" ZIP.

- * + * * @author <syslog4j@productivity.org> * @version $Id: SyslogServerMain.java,v 1.3 2010/11/28 01:38:08 cvs Exp $ */ public class SyslogServerMain { - public static boolean CALL_SYSTEM_EXIT_ON_FAILURE = true; - - public static class Options { - public String protocol = null; - public String fileName = null; - public boolean append = false; - public boolean quiet = false; - - public String host = null; - public String port = null; - public String timeout = null; - - public String usage = null; - } - - public static void usage(String problem) { - if (problem != null) { - System.out.println("Error: " + problem); - System.out.println(); - } - - System.out.println("Usage:"); - System.out.println(); - System.out.println("SyslogServer [-h ] [-p ] [-o ] [-a] [-q] "); - System.out.println(); - System.out.println("-h host or IP to bind"); - System.out.println("-p port to bind"); - System.out.println("-t socket timeout (in milliseconds)"); - System.out.println("-o file to write entries (overwrites by default)"); - System.out.println(); - System.out.println("-a append to file (instead of overwrite)"); - System.out.println("-q do not write anything to standard out"); - System.out.println(); - System.out.println("protocol Syslog4j protocol implementation (tcp, udp, ...)"); - } - - public static Options parseOptions(String[] args) { - Options options = new Options(); - - int i = 0; - while(i < args.length) { - String arg = args[i++]; - boolean match = false; - - if ("-h".equals(arg)) { if (i == args.length) { options.usage = "Must specify host with -h"; return options; } match = true; options.host = args[i++]; } - if ("-p".equals(arg)) { if (i == args.length) { options.usage = "Must specify port with -p"; return options; } match = true; options.port = args[i++]; } - if ("-t".equals(arg)) { if (i == args.length) { options.usage = "Must specify value (in milliseconds)"; return options; } match = true; options.timeout = args[i++]; } - if ("-o".equals(arg)) { if (i == args.length) { options.usage = "Must specify file with -o"; return options; } match = true; options.fileName = args[i++]; } - - if ("-a".equals(arg)) { match = true; options.append = true; } - if ("-q".equals(arg)) { match = true; options.quiet = true; } - - if (!match) { - if (options.protocol != null) { - options.usage = "Only one protocol definition allowed"; - return options; - } - - options.protocol = arg; - } - } - - if (options.protocol == null) { - options.usage = "Must specify protocol"; - return options; - } - - if (options.fileName == null && options.append) { - options.usage = "Cannot specify -a without specifying -f "; - return options; - } - - return options; - } - - public static void main(String[] args) throws Exception { - Options options = parseOptions(args); + public static boolean CALL_SYSTEM_EXIT_ON_FAILURE = true; - if (options.usage != null) { - usage(options.usage); - if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; } - } - - if (!options.quiet) { - System.out.println("SyslogServer " + SyslogServer.getVersion()); - } - - if (!SyslogServer.exists(options.protocol)) { - usage("Protocol \"" + options.protocol + "\" not supported"); - if (CALL_SYSTEM_EXIT_ON_FAILURE) { System.exit(1); } else { return; } - } - - SyslogServerIF syslogServer = SyslogServer.getInstance(options.protocol); - - SyslogServerConfigIF syslogServerConfig = syslogServer.getConfig(); - - if (options.host != null) { - syslogServerConfig.setHost(options.host); - if (!options.quiet) { - System.out.println("Listening on host: " + options.host); - } - } + public static class Options { + public String protocol = null; + public String fileName = null; + public boolean append = false; + public boolean quiet = false; - if (options.port != null) { - syslogServerConfig.setPort(Integer.parseInt(options.port)); - if (!options.quiet) { - System.out.println("Listening on port: " + options.port); - } - } + public String host = null; + public String port = null; + public String timeout = null; - if (options.timeout != null) { - if (syslogServerConfig instanceof TCPNetSyslogServerConfigIF) { - ((TCPNetSyslogServerConfigIF) syslogServerConfig).setTimeout(Integer.parseInt(options.timeout)); - if (!options.quiet) { - System.out.println("Timeout: " + options.timeout); - } - - } else { - System.err.println("Timeout not supported for protocol \"" + options.protocol + "\" (ignored)"); - } - } + public String usage = null; + } - if (options.fileName != null) { - SyslogServerEventHandlerIF eventHandler = new FileSyslogServerEventHandler(options.fileName,options.append); - syslogServerConfig.addEventHandler(eventHandler); - if (!options.quiet) { - System.out.println((options.append ? "Appending" : "Writing") + " to file: " + options.fileName); - } - } - - if (!options.quiet) { - SyslogServerEventHandlerIF eventHandler = SystemOutSyslogServerEventHandler.create(); - syslogServerConfig.addEventHandler(eventHandler); - } + public static void usage(String problem) { + if (problem != null) { + System.out.println("Error: " + problem); + System.out.println(); + } - if (!options.quiet) { - System.out.println(); - } + System.out.println("Usage:"); + System.out.println(); + System.out.println("SyslogServer [-h ] [-p ] [-o ] [-a] [-q] "); + System.out.println(); + System.out.println("-h host or IP to bind"); + System.out.println("-p port to bind"); + System.out.println("-t socket timeout (in milliseconds)"); + System.out.println("-o file to write entries (overwrites by default)"); + System.out.println(); + System.out.println("-a append to file (instead of overwrite)"); + System.out.println("-q do not write anything to standard out"); + System.out.println(); + System.out.println("protocol Syslog4j protocol implementation (tcp, udp, ...)"); + } - SyslogServer.getThreadedInstance(options.protocol); - - while(true) { - SyslogUtility.sleep(1000); - } - } + public static Options parseOptions(String[] args) { + Options options = new Options(); + + int i = 0; + while (i < args.length) { + String arg = args[i++]; + boolean match = false; + + if ("-h".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify host with -h"; + return options; + } + match = true; + options.host = args[i++]; + } + if ("-p".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify port with -p"; + return options; + } + match = true; + options.port = args[i++]; + } + if ("-t".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify value (in milliseconds)"; + return options; + } + match = true; + options.timeout = args[i++]; + } + if ("-o".equals(arg)) { + if (i == args.length) { + options.usage = "Must specify file with -o"; + return options; + } + match = true; + options.fileName = args[i++]; + } + + if ("-a".equals(arg)) { + match = true; + options.append = true; + } + if ("-q".equals(arg)) { + match = true; + options.quiet = true; + } + + if (!match) { + if (options.protocol != null) { + options.usage = "Only one protocol definition allowed"; + return options; + } + + options.protocol = arg; + } + } + + if (options.protocol == null) { + options.usage = "Must specify protocol"; + return options; + } + + if (options.fileName == null && options.append) { + options.usage = "Cannot specify -a without specifying -f "; + return options; + } + + return options; + } + + public static void main(String[] args) throws Exception { + Options options = parseOptions(args); + + if (options.usage != null) { + usage(options.usage); + if (CALL_SYSTEM_EXIT_ON_FAILURE) { + System.exit(1); + } else { + return; + } + } + + if (!options.quiet) { + System.out.println("SyslogServer " + SyslogServer.getVersion()); + } + + if (!SyslogServer.exists(options.protocol)) { + usage("Protocol \"" + options.protocol + "\" not supported"); + if (CALL_SYSTEM_EXIT_ON_FAILURE) { + System.exit(1); + } else { + return; + } + } + + SyslogServerIF syslogServer = SyslogServer.getInstance(options.protocol); + + SyslogServerConfigIF syslogServerConfig = syslogServer.getConfig(); + + if (options.host != null) { + syslogServerConfig.setHost(options.host); + if (!options.quiet) { + System.out.println("Listening on host: " + options.host); + } + } + + if (options.port != null) { + syslogServerConfig.setPort(Integer.parseInt(options.port)); + if (!options.quiet) { + System.out.println("Listening on port: " + options.port); + } + } + + if (options.timeout != null) { + if (syslogServerConfig instanceof TCPNetSyslogServerConfigIF) { + ((TCPNetSyslogServerConfigIF) syslogServerConfig).setTimeout(Integer.parseInt(options.timeout)); + if (!options.quiet) { + System.out.println("Timeout: " + options.timeout); + } + + } else { + System.err.println("Timeout not supported for protocol \"" + options.protocol + "\" (ignored)"); + } + } + + if (options.fileName != null) { + SyslogServerEventHandlerIF eventHandler = new FileSyslogServerEventHandler(options.fileName, options.append); + syslogServerConfig.addEventHandler(eventHandler); + if (!options.quiet) { + System.out.println((options.append ? "Appending" : "Writing") + " to file: " + options.fileName); + } + } + + if (!options.quiet) { + SyslogServerEventHandlerIF eventHandler = SystemOutSyslogServerEventHandler.create(); + syslogServerConfig.addEventHandler(eventHandler); + } + + if (!options.quiet) { + System.out.println(); + } + + SyslogServer.getThreadedInstance(options.protocol); + + while (true) { + SyslogUtility.sleep(1000); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionEventHandlerIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionEventHandlerIF.java index a9790bd..615a450 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionEventHandlerIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionEventHandlerIF.java @@ -3,8 +3,11 @@ package org.graylog2.syslog4j.server; import java.net.SocketAddress; public interface SyslogServerSessionEventHandlerIF extends SyslogServerEventHandlerIF { - public Object sessionOpened(SyslogServerIF syslogServer, SocketAddress socketAddress); - public void event(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event); - public void exception(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception); - public void sessionClosed(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, boolean timeout); + public Object sessionOpened(SyslogServerIF syslogServer, SocketAddress socketAddress); + + public void event(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event); + + public void exception(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception); + + public void sessionClosed(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, boolean timeout); } diff --git a/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionlessEventHandlerIF.java b/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionlessEventHandlerIF.java index ccdd5db..99f0930 100644 --- a/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionlessEventHandlerIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/SyslogServerSessionlessEventHandlerIF.java @@ -4,17 +4,18 @@ import java.net.SocketAddress; /** -* SyslogServerEventHandlerIF provides an extensible interface for Syslog4j -* server event handlers. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogServerSessionlessEventHandlerIF.java,v 1.1 2010/11/12 02:56:44 cvs Exp $ -*/ + * SyslogServerEventHandlerIF provides an extensible interface for Syslog4j + * server event handlers. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogServerSessionlessEventHandlerIF.java,v 1.1 2010/11/12 02:56:44 cvs Exp $ + */ public interface SyslogServerSessionlessEventHandlerIF extends SyslogServerEventHandlerIF { - public void event(SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event); - public void exception(SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception); + public void event(SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event); + + public void exception(SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception); } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServer.java b/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServer.java index 2b6f648..f988fa3 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServer.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServer.java @@ -22,318 +22,318 @@ import org.graylog2.syslog4j.server.impl.event.structured.StructuredSyslogServer import org.graylog2.syslog4j.util.SyslogUtility; /** -* AbstractSyslogServer provides a base abstract implementation of the SyslogServerIF. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogServer.java,v 1.12 2011/01/11 05:11:13 cvs Exp $ -*/ + * AbstractSyslogServer provides a base abstract implementation of the SyslogServerIF. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogServer.java,v 1.12 2011/01/11 05:11:13 cvs Exp $ + */ public abstract class AbstractSyslogServer implements SyslogServerIF { - public static class Sessions extends HashMap { - private static final long serialVersionUID = -4438949276263772580L; - - public static final Object syncObject = new Object(); + public static class Sessions extends HashMap { + private static final long serialVersionUID = -4438949276263772580L; - public void addSocket(Socket socket) { - synchronized(syncObject) { - put(socket,new HashMap()); - } - } - - public Iterator getSockets() { - if (size() > 0) { - return keySet().iterator(); - - } else { - return null; - } - } + public static final Object syncObject = new Object(); - public void addSession(Socket socket, SyslogServerEventHandlerIF eventHandler, Object session) { - synchronized(syncObject) { - Map handlerMap = getHandlerMap(socket); - - if (handlerMap == null) { - handlerMap = new HashMap(); - } - - handlerMap.put(eventHandler,session); - } - } + public void addSocket(Socket socket) { + synchronized (syncObject) { + put(socket, new HashMap()); + } + } - public void removeSocket(Socket socket) { - synchronized(syncObject) { - Map handlerMap = getHandlerMap(socket); - - if (handlerMap != null) { - handlerMap.clear(); - } - } - } + public Iterator getSockets() { + if (size() > 0) { + return keySet().iterator(); - protected Map getHandlerMap(Socket socket) { - Map handlerMap = null; - - if (containsKey(socket)) { - handlerMap = (Map) get(socket); - } - - return handlerMap; - } + } else { + return null; + } + } - public Object getSession(Socket socket, SyslogServerEventHandlerIF eventHandler) { - synchronized(syncObject) { - Map handlerMap = getHandlerMap(socket); - - Object session = handlerMap.get(eventHandler); - - return session; - } - } - } - - protected String syslogProtocol = null; - protected AbstractSyslogServerConfig syslogServerConfig = null; - protected Thread thread = null; - - protected boolean shutdown = false; - - public void initialize(String protocol, SyslogServerConfigIF config) throws SyslogRuntimeException { - this.syslogProtocol = protocol; - - try { - this.syslogServerConfig = (AbstractSyslogServerConfig) config; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException(cce); - } - - initialize(); - } - - public String getProtocol() { - return this.syslogProtocol; - } + public void addSession(Socket socket, SyslogServerEventHandlerIF eventHandler, Object session) { + synchronized (syncObject) { + Map handlerMap = getHandlerMap(socket); - public SyslogServerConfigIF getConfig() { - return this.syslogServerConfig; - } - - protected abstract void initialize() throws SyslogRuntimeException; - - public void shutdown() throws SyslogRuntimeException { - this.shutdown = true; - } + if (handlerMap == null) { + handlerMap = new HashMap(); + } - public Thread getThread() { - return this.thread; - } + handlerMap.put(eventHandler, session); + } + } - public void setThread(Thread thread) { - this.thread = thread; - } - - protected static boolean isStructuredMessage(SyslogCharSetIF syslogCharSet, byte[] receiveData) { - String receiveDataString = SyslogUtility.newString(syslogCharSet, receiveData); + public void removeSocket(Socket socket) { + synchronized (syncObject) { + Map handlerMap = getHandlerMap(socket); - boolean isStructuredMessage = isStructuredMessage(syslogCharSet,receiveDataString); - - return isStructuredMessage; - } + if (handlerMap != null) { + handlerMap.clear(); + } + } + } - protected static boolean isStructuredMessage(SyslogCharSetIF syslogCharSet, String receiveData) { - int idx = receiveData.indexOf('>'); + protected Map getHandlerMap(Socket socket) { + Map handlerMap = null; - if (idx != -1) { - // If there's a numerical VERSION field after the , return true. - if (receiveData.length() > idx + 1 && Character.isDigit(receiveData.charAt(idx + 1))) { - return true; - } - } + if (containsKey(socket)) { + handlerMap = (Map) get(socket); + } - return false; - } + return handlerMap; + } - protected static SyslogServerEventIF createEvent(SyslogServerConfigIF serverConfig, byte[] lineBytes, int lineBytesLength, InetAddress inetAddr) { - SyslogServerEventIF event = null; - - if (serverConfig.isUseStructuredData() && AbstractSyslogServer.isStructuredMessage(serverConfig,lineBytes)) { - event = new StructuredSyslogServerEvent(lineBytes,lineBytesLength,inetAddr); - - if (serverConfig.getDateTimeFormatter() != null) { - ((StructuredSyslogServerEvent) event).setDateTimeFormatter(serverConfig.getDateTimeFormatter()); - } - - } else { - event = new SyslogServerEvent(lineBytes,lineBytesLength,inetAddr); - } - - return event; - } - - protected static SyslogServerEventIF createEvent(SyslogServerConfigIF serverConfig, String line, InetAddress inetAddr) { - SyslogServerEventIF event = null; - - if (serverConfig.isUseStructuredData() && AbstractSyslogServer.isStructuredMessage(serverConfig,line)) { - event = new StructuredSyslogServerEvent(line,inetAddr); - - } else { - event = new SyslogServerEvent(line,inetAddr); - } - - return event; - } - - public static void handleInitialize(SyslogServerIF syslogServer) { - List eventHandlers = syslogServer.getConfig().getEventHandlers(); - - for(int i=0; i'); + + if (idx != -1) { + // If there's a numerical VERSION field after the , return true. + if (receiveData.length() > idx + 1 && Character.isDigit(receiveData.charAt(idx + 1))) { + return true; + } + } + + return false; + } + + protected static SyslogServerEventIF createEvent(SyslogServerConfigIF serverConfig, byte[] lineBytes, int lineBytesLength, InetAddress inetAddr) { + SyslogServerEventIF event = null; + + if (serverConfig.isUseStructuredData() && AbstractSyslogServer.isStructuredMessage(serverConfig, lineBytes)) { + event = new StructuredSyslogServerEvent(lineBytes, lineBytesLength, inetAddr); + + if (serverConfig.getDateTimeFormatter() != null) { + ((StructuredSyslogServerEvent) event).setDateTimeFormatter(serverConfig.getDateTimeFormatter()); + } + + } else { + event = new SyslogServerEvent(lineBytes, lineBytesLength, inetAddr); + } + + return event; + } + + protected static SyslogServerEventIF createEvent(SyslogServerConfigIF serverConfig, String line, InetAddress inetAddr) { + SyslogServerEventIF event = null; + + if (serverConfig.isUseStructuredData() && AbstractSyslogServer.isStructuredMessage(serverConfig, line)) { + event = new StructuredSyslogServerEvent(line, inetAddr); + + } else { + event = new SyslogServerEvent(line, inetAddr); + } + + return event; + } + + public static void handleInitialize(SyslogServerIF syslogServer) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + try { + eventHandler.initialize(syslogServer); + + } catch (Exception exception) { + // + } + } + } + + public static void handleDestroy(SyslogServerIF syslogServer) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + try { + eventHandler.destroy(syslogServer); + + } catch (Exception exception) { + // + } + } + } + + public static void handleSessionOpen(Sessions sessions, SyslogServerIF syslogServer, Socket socket) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + if (eventHandler instanceof SyslogServerSessionEventHandlerIF) { + try { + Object session = ((SyslogServerSessionEventHandlerIF) eventHandler).sessionOpened(syslogServer, socket.getRemoteSocketAddress()); + + if (session != null) { + sessions.addSession(socket, eventHandler, session); + } + + } catch (Exception exception) { + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).exception(null, syslogServer, socket.getRemoteSocketAddress(), exception); + + } catch (Exception e) { + // + } + } + } + } + } + + public static void handleSessionClosed(Sessions sessions, SyslogServerIF syslogServer, Socket socket, boolean timeout) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + if (eventHandler instanceof SyslogServerSessionEventHandlerIF) { + Object session = sessions.getSession(socket, eventHandler); + + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).sessionClosed(session, syslogServer, socket.getRemoteSocketAddress(), timeout); + + } catch (Exception exception) { + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).exception(session, syslogServer, socket.getRemoteSocketAddress(), exception); + + } catch (Exception e) { + // + } + } + } + } + } + + public static void handleEvent(Sessions sessions, SyslogServerIF syslogServer, DatagramPacket packet, SyslogServerEventIF event) { + handleEvent(sessions, syslogServer, null, packet.getSocketAddress(), event); + } + + public static void handleEvent(Sessions sessions, SyslogServerIF syslogServer, Socket socket, SyslogServerEventIF event) { + handleEvent(sessions, syslogServer, socket, socket.getRemoteSocketAddress(), event); + } + + protected static void handleEvent(Sessions sessions, SyslogServerIF syslogServer, Socket socket, SocketAddress socketAddress, SyslogServerEventIF event) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + Object session = (sessions != null && socket != null) ? sessions.getSession(socket, eventHandler) : null; + + if (eventHandler instanceof SyslogServerSessionEventHandlerIF) { + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).event(session, syslogServer, socketAddress, event); + + } catch (Exception exception) { + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).exception(session, syslogServer, socketAddress, exception); + + } catch (Exception e) { + // + } + } + + } else if (eventHandler instanceof SyslogServerSessionlessEventHandlerIF) { + try { + ((SyslogServerSessionlessEventHandlerIF) eventHandler).event(syslogServer, socketAddress, event); + + } catch (Exception exception) { + try { + ((SyslogServerSessionlessEventHandlerIF) eventHandler).exception(syslogServer, socketAddress, exception); + + } catch (Exception e) { + // + } + } + } + } + } + + public static void handleException(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception) { + List eventHandlers = syslogServer.getConfig().getEventHandlers(); + + for (int i = 0; i < eventHandlers.size(); i++) { + SyslogServerEventHandlerIF eventHandler = (SyslogServerEventHandlerIF) eventHandlers.get(i); + + if (eventHandler instanceof SyslogServerSessionEventHandlerIF) { + try { + ((SyslogServerSessionEventHandlerIF) eventHandler).exception(session, syslogServer, socketAddress, exception); + + } catch (Exception e) { + // + } + + } else if (eventHandler instanceof SyslogServerSessionlessEventHandlerIF) { + try { + ((SyslogServerSessionlessEventHandlerIF) eventHandler).exception(syslogServer, socketAddress, exception); + + } catch (Exception e) { + // + } + } + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServerConfig.java b/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServerConfig.java index cd20d8d..bb14084 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServerConfig.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/AbstractSyslogServerConfig.java @@ -8,99 +8,99 @@ import org.graylog2.syslog4j.server.SyslogServerConfigIF; import org.graylog2.syslog4j.server.SyslogServerEventHandlerIF; /** -* AbstractSyslogServerConfig provides a base abstract implementation of the SyslogServerConfigIF -* configuration interface. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractSyslogServerConfig.java,v 1.9 2011/01/11 05:11:13 cvs Exp $ -*/ + * AbstractSyslogServerConfig provides a base abstract implementation of the SyslogServerConfigIF + * configuration interface. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractSyslogServerConfig.java,v 1.9 2011/01/11 05:11:13 cvs Exp $ + */ public abstract class AbstractSyslogServerConfig implements SyslogServerConfigIF { - private static final long serialVersionUID = 870248648801259856L; - - public abstract Class getSyslogServerClass(); - - protected String charSet = CHAR_SET_DEFAULT; - - protected long shutdownWait = SyslogConstants.SERVER_SHUTDOWN_WAIT_DEFAULT; + private static final long serialVersionUID = 870248648801259856L; - protected List eventHandlers = new ArrayList(); + public abstract Class getSyslogServerClass(); - protected boolean useStructuredData = USE_STRUCTURED_DATA_DEFAULT; - - protected Object dateTimeFormatter = null; - - protected boolean useDaemonThread = USE_DAEMON_THREAD_DEFAULT; - protected int threadPriority = THREAD_PRIORITY_DEFAULT; + protected String charSet = CHAR_SET_DEFAULT; - public String getCharSet() { - return this.charSet; - } + protected long shutdownWait = SyslogConstants.SERVER_SHUTDOWN_WAIT_DEFAULT; - public void setCharSet(String charSet) { - this.charSet = charSet; - } + protected List eventHandlers = new ArrayList(); - public long getShutdownWait() { - return this.shutdownWait; - } + protected boolean useStructuredData = USE_STRUCTURED_DATA_DEFAULT; - public void setShutdownWait(long shutdownWait) { - this.shutdownWait = shutdownWait; - } + protected Object dateTimeFormatter = null; - public List getEventHandlers() { - return this.eventHandlers; - } - - public void addEventHandler(SyslogServerEventHandlerIF eventHandler) { - this.eventHandlers.add(eventHandler); - } + protected boolean useDaemonThread = USE_DAEMON_THREAD_DEFAULT; + protected int threadPriority = THREAD_PRIORITY_DEFAULT; - public void insertEventHandler(int pos, SyslogServerEventHandlerIF eventHandler) { - this.eventHandlers.add(pos, eventHandler); - } + public String getCharSet() { + return this.charSet; + } - public void removeEventHandler(SyslogServerEventHandlerIF eventHandler) { - this.eventHandlers.remove(eventHandler); - } + public void setCharSet(String charSet) { + this.charSet = charSet; + } - public void removeAllEventHandlers() { - this.eventHandlers.clear(); - } - - public boolean isUseStructuredData() { - return useStructuredData; - } + public long getShutdownWait() { + return this.shutdownWait; + } - public void setUseStructuredData(boolean useStructuredData) { - this.useStructuredData = useStructuredData; - } + public void setShutdownWait(long shutdownWait) { + this.shutdownWait = shutdownWait; + } - public boolean isUseDaemonThread() { - return useDaemonThread; - } + public List getEventHandlers() { + return this.eventHandlers; + } - public Object getDateTimeFormatter() { - return dateTimeFormatter; - } + public void addEventHandler(SyslogServerEventHandlerIF eventHandler) { + this.eventHandlers.add(eventHandler); + } - public void setDateTimeFormatter(Object dateTimeFormatter) { - this.dateTimeFormatter = dateTimeFormatter; - } + public void insertEventHandler(int pos, SyslogServerEventHandlerIF eventHandler) { + this.eventHandlers.add(pos, eventHandler); + } - public void setUseDaemonThread(boolean useDaemonThread) { - this.useDaemonThread = useDaemonThread; - } + public void removeEventHandler(SyslogServerEventHandlerIF eventHandler) { + this.eventHandlers.remove(eventHandler); + } - public int getThreadPriority() { - return threadPriority; - } + public void removeAllEventHandlers() { + this.eventHandlers.clear(); + } - public void setThreadPriority(int threadPriority) { - this.threadPriority = threadPriority; - } + public boolean isUseStructuredData() { + return useStructuredData; + } + + public void setUseStructuredData(boolean useStructuredData) { + this.useStructuredData = useStructuredData; + } + + public boolean isUseDaemonThread() { + return useDaemonThread; + } + + public Object getDateTimeFormatter() { + return dateTimeFormatter; + } + + public void setDateTimeFormatter(Object dateTimeFormatter) { + this.dateTimeFormatter = dateTimeFormatter; + } + + public void setUseDaemonThread(boolean useDaemonThread) { + this.useDaemonThread = useDaemonThread; + } + + public int getThreadPriority() { + return threadPriority; + } + + public void setThreadPriority(int threadPriority) { + this.threadPriority = threadPriority; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/SyslogServerEvent.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/SyslogServerEvent.java index 8bee401..908554d 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/SyslogServerEvent.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/SyslogServerEvent.java @@ -12,202 +12,203 @@ import org.graylog2.syslog4j.server.SyslogServerEventIF; import org.graylog2.syslog4j.util.SyslogUtility; /** -* SyslogServerEvent provides an implementation of the SyslogServerEventIF interface. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogServerEvent.java,v 1.9 2011/01/11 06:21:15 cvs Exp $ -*/ + * SyslogServerEvent provides an implementation of the SyslogServerEventIF interface. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogServerEvent.java,v 1.9 2011/01/11 06:21:15 cvs Exp $ + */ public class SyslogServerEvent implements SyslogServerEventIF { - private static final long serialVersionUID = 6136043067089899962L; - - public static final String DATE_FORMAT = "MMM dd HH:mm:ss yyyy"; - public static final String DATE_FORMAT_S = "MMM d HH:mm:ss yyyy"; - - protected String charSet = SyslogConstants.CHAR_SET_DEFAULT; - protected String rawString = null; - protected byte[] rawBytes = null; - protected int rawLength = -1; - protected Date date = null; - protected int level = -1; - protected int facility = -1; - protected String host = null; - protected boolean isHostStrippedFromMessage = false; - protected String message = null; - protected InetAddress inetAddress = null; - - protected SyslogServerEvent() { } - - public SyslogServerEvent(final String message, InetAddress inetAddress) { - initialize(message,inetAddress); - - parse(); - } - - public SyslogServerEvent(final byte[] message, int length, InetAddress inetAddress) { - initialize(message,length,inetAddress); - - parse(); - } - - protected void initialize(final String message, InetAddress inetAddress) { - this.rawString = message; - this.rawLength = message.length(); - this.inetAddress = inetAddress; - - this.message = message; - } + private static final long serialVersionUID = 6136043067089899962L; - protected void initialize(final byte[] message, int length, InetAddress inetAddress) { - this.rawBytes = message; - this.rawLength = length; - this.inetAddress = inetAddress; - } + public static final String DATE_FORMAT = "MMM dd HH:mm:ss yyyy"; + public static final String DATE_FORMAT_S = "MMM d HH:mm:ss yyyy"; - protected void parseHost() { - int i = this.message.indexOf(' '); - - if (i > -1) { - this.host = this.message.substring(0,i).trim(); - } - } + protected String charSet = SyslogConstants.CHAR_SET_DEFAULT; + protected String rawString = null; + protected byte[] rawBytes = null; + protected int rawLength = -1; + protected Date date = null; + protected int level = -1; + protected int facility = -1; + protected String host = null; + protected boolean isHostStrippedFromMessage = false; + protected String message = null; + protected InetAddress inetAddress = null; - protected void parseDate() { - int datelength = 16; - String dateFormatS = DATE_FORMAT; - - if (this.message.length() > datelength) { - - // http://jira.graylog2.org/browse/SERVER-287 - if (this.message.charAt(5) == ' ') { - datelength = 15; - dateFormatS = DATE_FORMAT_S; - } + protected SyslogServerEvent() { + } - String year = Integer.toString(Calendar.getInstance().get(Calendar.YEAR)); + public SyslogServerEvent(final String message, InetAddress inetAddress) { + initialize(message, inetAddress); - String originalDate = this.message.substring(0,datelength-1) + " " + year; - DateFormat dateFormat = new SimpleDateFormat(dateFormatS); - try { - this.date = dateFormat.parse(originalDate); + parse(); + } - this.message = this.message.substring(datelength); + public SyslogServerEvent(final byte[] message, int length, InetAddress inetAddress) { + initialize(message, length, inetAddress); - } catch (ParseException pe) { - this.date = new Date(); - } + parse(); + } + + protected void initialize(final String message, InetAddress inetAddress) { + this.rawString = message; + this.rawLength = message.length(); + this.inetAddress = inetAddress; + + this.message = message; + } + + protected void initialize(final byte[] message, int length, InetAddress inetAddress) { + this.rawBytes = message; + this.rawLength = length; + this.inetAddress = inetAddress; + } + + protected void parseHost() { + int i = this.message.indexOf(' '); + + if (i > -1) { + this.host = this.message.substring(0, i).trim(); + } + } + + protected void parseDate() { + int datelength = 16; + String dateFormatS = DATE_FORMAT; + + if (this.message.length() > datelength) { + + // http://jira.graylog2.org/browse/SERVER-287 + if (this.message.charAt(5) == ' ') { + datelength = 15; + dateFormatS = DATE_FORMAT_S; + } + + String year = Integer.toString(Calendar.getInstance().get(Calendar.YEAR)); + + String originalDate = this.message.substring(0, datelength - 1) + " " + year; + DateFormat dateFormat = new SimpleDateFormat(dateFormatS); + try { + this.date = dateFormat.parse(originalDate); + + this.message = this.message.substring(datelength); + + } catch (ParseException pe) { + this.date = new Date(); + } + } + + parseHost(); + } + + protected void parsePriority() { + if (this.message.charAt(0) == '<') { + int i = this.message.indexOf(">"); + + if (i <= 4 && i > -1) { + String priorityStr = this.message.substring(1, i); + + int priority = 0; + try { + priority = Integer.parseInt(priorityStr); + this.facility = priority >> 3; + this.level = priority - (this.facility << 3); + + this.message = this.message.substring(i + 1); + + parseDate(); + + } catch (NumberFormatException nfe) { + // } - - parseHost(); - } - - protected void parsePriority() { - if (this.message.charAt(0) == '<') { - int i = this.message.indexOf(">"); - - if (i <= 4 && i > -1) { - String priorityStr = this.message.substring(1,i); - - int priority = 0; - try { - priority = Integer.parseInt(priorityStr); - this.facility = priority >> 3; - this.level = priority - (this.facility << 3); - - this.message = this.message.substring(i+1); - - parseDate(); - - } catch (NumberFormatException nfe) { - // - } - - parseHost(); - } - } - } - - protected void parse() { - if (this.message == null) { - this.message = SyslogUtility.newString(this,this.rawBytes,this.rawLength); - } - - parsePriority(); - } - - public int getFacility() { - return this.facility; - } - public void setFacility(int facility) { - this.facility = facility; - } + parseHost(); + } + } + } - public byte[] getRaw() { - if (this.rawString != null) { - byte[] rawStringBytes = SyslogUtility.getBytes(this,this.rawString); - - return rawStringBytes; - - } else if (this.rawBytes.length == this.rawLength) { - return this.rawBytes; - - } else { - byte[] newRawBytes = new byte[this.rawLength]; - System.arraycopy(this.rawBytes,0,newRawBytes,0,this.rawLength); - - return newRawBytes; - } - } - - public int getRawLength() { - return this.rawLength; - } - - public Date getDate() { - return this.date; - } + protected void parse() { + if (this.message == null) { + this.message = SyslogUtility.newString(this, this.rawBytes, this.rawLength); + } - public void setDate(Date date) { - this.date = date; - } - - public int getLevel() { - return this.level; - } - - public void setLevel(int level) { - this.level = level; - } - - public String getHost() { - return this.host; - } - - public void setHost(String host) { - this.host = host; - } - - public boolean isHostStrippedFromMessage() { - return isHostStrippedFromMessage; - } + parsePriority(); + } - public String getMessage() { - return this.message; - } - - public void setMessage(String message) { - this.message = message; - } + public int getFacility() { + return this.facility; + } - public String getCharSet() { - return this.charSet; - } + public void setFacility(int facility) { + this.facility = facility; + } - public void setCharSet(String charSet) { - this.charSet = charSet; - } + public byte[] getRaw() { + if (this.rawString != null) { + byte[] rawStringBytes = SyslogUtility.getBytes(this, this.rawString); + + return rawStringBytes; + + } else if (this.rawBytes.length == this.rawLength) { + return this.rawBytes; + + } else { + byte[] newRawBytes = new byte[this.rawLength]; + System.arraycopy(this.rawBytes, 0, newRawBytes, 0, this.rawLength); + + return newRawBytes; + } + } + + public int getRawLength() { + return this.rawLength; + } + + public Date getDate() { + return this.date; + } + + public void setDate(Date date) { + this.date = date; + } + + public int getLevel() { + return this.level; + } + + public void setLevel(int level) { + this.level = level; + } + + public String getHost() { + return this.host; + } + + public void setHost(String host) { + this.host = host; + } + + public boolean isHostStrippedFromMessage() { + return isHostStrippedFromMessage; + } + + public String getMessage() { + return this.message; + } + + public void setMessage(String message) { + this.message = message; + } + + public String getCharSet() { + return this.charSet; + } + + public void setCharSet(String charSet) { + this.charSet = charSet; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/FileSyslogServerEventHandler.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/FileSyslogServerEventHandler.java index 4747a8a..79491f6 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/FileSyslogServerEventHandler.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/FileSyslogServerEventHandler.java @@ -7,23 +7,23 @@ import java.io.OutputStream; import java.io.PrintStream; public class FileSyslogServerEventHandler extends PrintStreamSyslogServerEventHandler { - private static final long serialVersionUID = -755824686809731430L; + private static final long serialVersionUID = -755824686809731430L; - protected static PrintStream createPrintStream(String fileName, boolean append) throws IOException { - File file = new File(fileName); - - OutputStream os = new FileOutputStream(file,append); - - PrintStream printStream = new PrintStream(os); - - return printStream; - } - - public FileSyslogServerEventHandler(String fileName) throws IOException { - super(createPrintStream(fileName,true)); - } - - public FileSyslogServerEventHandler(String fileName, boolean append) throws IOException { - super(createPrintStream(fileName,append)); - } + protected static PrintStream createPrintStream(String fileName, boolean append) throws IOException { + File file = new File(fileName); + + OutputStream os = new FileOutputStream(file, append); + + PrintStream printStream = new PrintStream(os); + + return printStream; + } + + public FileSyslogServerEventHandler(String fileName) throws IOException { + super(createPrintStream(fileName, true)); + } + + public FileSyslogServerEventHandler(String fileName, boolean append) throws IOException { + super(createPrintStream(fileName, append)); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/PrintStreamSyslogServerEventHandler.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/PrintStreamSyslogServerEventHandler.java index e11336d..e499fde 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/PrintStreamSyslogServerEventHandler.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/PrintStreamSyslogServerEventHandler.java @@ -10,50 +10,50 @@ import org.graylog2.syslog4j.server.SyslogServerSessionEventHandlerIF; import org.graylog2.syslog4j.util.SyslogUtility; /** -* SystemOutSyslogServerEventHandler provides a simple example implementation -* of the SyslogServerEventHandlerIF which writes the events to System.out. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: PrintStreamSyslogServerEventHandler.java,v 1.7 2010/11/28 22:07:57 cvs Exp $ -*/ + * SystemOutSyslogServerEventHandler provides a simple example implementation + * of the SyslogServerEventHandlerIF which writes the events to System.out. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: PrintStreamSyslogServerEventHandler.java,v 1.7 2010/11/28 22:07:57 cvs Exp $ + */ public class PrintStreamSyslogServerEventHandler implements SyslogServerSessionEventHandlerIF { - private static final long serialVersionUID = 6036415838696050746L; - - protected PrintStream stream = null; - - public PrintStreamSyslogServerEventHandler(PrintStream stream) { - this.stream = stream; - } + private static final long serialVersionUID = 6036415838696050746L; - public void initialize(SyslogServerIF syslogServer) { - return; - } + protected PrintStream stream = null; - public Object sessionOpened(SyslogServerIF syslogServer, SocketAddress socketAddress) { - return null; - } + public PrintStreamSyslogServerEventHandler(PrintStream stream) { + this.stream = stream; + } - public void event(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event) { - String date = (event.getDate() == null ? new Date() : event.getDate()).toString(); - String facility = SyslogUtility.getFacilityString(event.getFacility()); - String level = SyslogUtility.getLevelString(event.getLevel()); - - this.stream.println("{" + facility + "} " + date + " " + level + " " + event.getMessage()); - } + public void initialize(SyslogServerIF syslogServer) { + return; + } - public void exception(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception) { - // - } + public Object sessionOpened(SyslogServerIF syslogServer, SocketAddress socketAddress) { + return null; + } - public void sessionClosed(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, boolean timeout) { - // - } + public void event(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, SyslogServerEventIF event) { + String date = (event.getDate() == null ? new Date() : event.getDate()).toString(); + String facility = SyslogUtility.getFacilityString(event.getFacility()); + String level = SyslogUtility.getLevelString(event.getLevel()); - public void destroy(SyslogServerIF syslogServer) { - return; - } + this.stream.println("{" + facility + "} " + date + " " + level + " " + event.getMessage()); + } + + public void exception(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, Exception exception) { + // + } + + public void sessionClosed(Object session, SyslogServerIF syslogServer, SocketAddress socketAddress, boolean timeout) { + // + } + + public void destroy(SyslogServerIF syslogServer) { + return; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemErrSyslogServerEventHandler.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemErrSyslogServerEventHandler.java index 744cce6..8926c2d 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemErrSyslogServerEventHandler.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemErrSyslogServerEventHandler.java @@ -3,13 +3,13 @@ package org.graylog2.syslog4j.server.impl.event.printstream; import org.graylog2.syslog4j.server.SyslogServerSessionEventHandlerIF; public class SystemErrSyslogServerEventHandler extends PrintStreamSyslogServerEventHandler { - private static final long serialVersionUID = -3496862887351690575L; + private static final long serialVersionUID = -3496862887351690575L; - public static SyslogServerSessionEventHandlerIF create() { - return new SystemErrSyslogServerEventHandler(); - } - - public SystemErrSyslogServerEventHandler() { - super(System.err); - } + public static SyslogServerSessionEventHandlerIF create() { + return new SystemErrSyslogServerEventHandler(); + } + + public SystemErrSyslogServerEventHandler() { + super(System.err); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemOutSyslogServerEventHandler.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemOutSyslogServerEventHandler.java index 6c8db67..75a447b 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemOutSyslogServerEventHandler.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/printstream/SystemOutSyslogServerEventHandler.java @@ -3,13 +3,13 @@ package org.graylog2.syslog4j.server.impl.event.printstream; import org.graylog2.syslog4j.server.SyslogServerSessionEventHandlerIF; public class SystemOutSyslogServerEventHandler extends PrintStreamSyslogServerEventHandler { - private static final long serialVersionUID = 1690551409588182601L; + private static final long serialVersionUID = 1690551409588182601L; - public static SyslogServerSessionEventHandlerIF create() { - return new SystemOutSyslogServerEventHandler(); - } - - public SystemOutSyslogServerEventHandler() { - super(System.out); - } + public static SyslogServerSessionEventHandlerIF create() { + return new SystemOutSyslogServerEventHandler(); + } + + public SystemOutSyslogServerEventHandler() { + super(System.out); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/event/structured/StructuredSyslogServerEvent.java b/src/main/java/org/graylog2/syslog4j/server/impl/event/structured/StructuredSyslogServerEvent.java index 8f81286..9f9acdd 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/event/structured/StructuredSyslogServerEvent.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/event/structured/StructuredSyslogServerEvent.java @@ -13,139 +13,139 @@ import org.graylog2.syslog4j.server.impl.event.SyslogServerEvent; * SyslogServerStructuredEvent provides an implementation of the * SyslogServerEventIF interface that supports receiving of structured syslog * messages, as defined in: - * + *

*

* http://tools.ietf.org/html/draft-ietf-syslog-protocol-23#section-6 *

- * + *

*

* Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy of the * LGPL license is available in the META-INF folder in all distributions of * Syslog4j and in the base directory of the "doc" ZIP. *

- * + * * @author Manish Motwani * @version $Id: StructuredSyslogServerEvent.java,v 1.6 2011/01/11 05:11:13 cvs Exp $ */ public class StructuredSyslogServerEvent extends SyslogServerEvent { - private static final long serialVersionUID = 1676499796406044315L; + private static final long serialVersionUID = 1676499796406044315L; - protected String applicationName = SyslogConstants.STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE; - protected String processId = null; - protected DateTime dateTime = null; - protected DateTimeFormatter dateTimeFormatter = null; - - public StructuredSyslogServerEvent(final byte[] message, int length, InetAddress inetAddress) { - super(); - - initialize(message,length,inetAddress); - parse(); - } + protected String applicationName = SyslogConstants.STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE; + protected String processId = null; + protected DateTime dateTime = null; + protected DateTimeFormatter dateTimeFormatter = null; - public StructuredSyslogServerEvent(final String message, InetAddress inetAddress) { - super(); - - initialize(message,inetAddress); - parse(); - } + public StructuredSyslogServerEvent(final byte[] message, int length, InetAddress inetAddress) { + super(); - public DateTimeFormatter getDateTimeFormatter() { - if (dateTimeFormatter == null) { - this.dateTimeFormatter = ISODateTimeFormat.dateTime(); - } - - return dateTimeFormatter; - } + initialize(message, length, inetAddress); + parse(); + } - public void setDateTimeFormatter(Object dateTimeFormatter) { - this.dateTimeFormatter = (DateTimeFormatter) dateTimeFormatter; - } + public StructuredSyslogServerEvent(final String message, InetAddress inetAddress) { + super(); - protected void parseApplicationName() { - int i = this.message.indexOf(' '); + initialize(message, inetAddress); + parse(); + } - if (i > -1) { - this.applicationName = this.message.substring(0, i).trim(); - this.message = this.message.substring(i + 1); - parseProcessId(); - } + public DateTimeFormatter getDateTimeFormatter() { + if (dateTimeFormatter == null) { + this.dateTimeFormatter = ISODateTimeFormat.dateTime(); + } - if (SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(this.applicationName)) { - this.applicationName = null; - } - } + return dateTimeFormatter; + } - protected void parseProcessId() { - int i = this.message.indexOf(' '); + public void setDateTimeFormatter(Object dateTimeFormatter) { + this.dateTimeFormatter = (DateTimeFormatter) dateTimeFormatter; + } - if (i > -1) { - this.processId = this.message.substring(0, i).trim(); - this.message = this.message.substring(i + 1); - } + protected void parseApplicationName() { + int i = this.message.indexOf(' '); - if (SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(this.processId)) { - this.processId = null; - } - } + if (i > -1) { + this.applicationName = this.message.substring(0, i).trim(); + this.message = this.message.substring(i + 1); + parseProcessId(); + } - protected void parseDate() { - // skip VERSION field - int i = this.message.indexOf(' '); - this.message = this.message.substring(i + 1); + if (SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(this.applicationName)) { + this.applicationName = null; + } + } - // parse the date - i = this.message.indexOf(' '); + protected void parseProcessId() { + int i = this.message.indexOf(' '); - if (i > -1) { - String dateString = this.message.substring(0, i).trim(); - - try { - DateTimeFormatter formatter = getDateTimeFormatter(); - - this.dateTime = formatter.parseDateTime(dateString); - this.date = this.dateTime.toDate(); - - this.message = this.message.substring(dateString.length() + 1); - - } catch (Exception e) { - // Not structured date format, try super one - super.parseDate(); - } - } - } + if (i > -1) { + this.processId = this.message.substring(0, i).trim(); + this.message = this.message.substring(i + 1); + } - protected void parseHost() { - int i = this.message.indexOf(' '); - - if (i > -1) { - this.host = this.message.substring(0,i).trim(); - this.message = this.message.substring(i+1); - - parseApplicationName(); - } - } + if (SyslogConstants.STRUCTURED_DATA_NILVALUE.equals(this.processId)) { + this.processId = null; + } + } - public String getApplicationName() { - return this.applicationName; - } + protected void parseDate() { + // skip VERSION field + int i = this.message.indexOf(' '); + this.message = this.message.substring(i + 1); - public String getProcessId() { - return this.processId; - } - - public DateTime getDateTime() { - return this.dateTime; - } + // parse the date + i = this.message.indexOf(' '); - public StructuredSyslogMessage getStructuredMessage() { - try { - return StructuredSyslogMessage.fromString(getMessage()); + if (i > -1) { + String dateString = this.message.substring(0, i).trim(); - } catch (IllegalArgumentException e) { - // throw new SyslogRuntimeException( - // "Message received is not a valid structured message: " - // + getMessage(), e); - return new StructuredSyslogMessage(null,null,getMessage()); - } - } + try { + DateTimeFormatter formatter = getDateTimeFormatter(); + + this.dateTime = formatter.parseDateTime(dateString); + this.date = this.dateTime.toDate(); + + this.message = this.message.substring(dateString.length() + 1); + + } catch (Exception e) { + // Not structured date format, try super one + super.parseDate(); + } + } + } + + protected void parseHost() { + int i = this.message.indexOf(' '); + + if (i > -1) { + this.host = this.message.substring(0, i).trim(); + this.message = this.message.substring(i + 1); + + parseApplicationName(); + } + } + + public String getApplicationName() { + return this.applicationName; + } + + public String getProcessId() { + return this.processId; + } + + public DateTime getDateTime() { + return this.dateTime; + } + + public StructuredSyslogMessage getStructuredMessage() { + try { + return StructuredSyslogMessage.fromString(getMessage()); + + } catch (IllegalArgumentException e) { + // throw new SyslogRuntimeException( + // "Message received is not a valid structured message: " + // + getMessage(), e); + return new StructuredSyslogMessage(null, null, getMessage()); + } + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/AbstractNetSyslogServerConfig.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/AbstractNetSyslogServerConfig.java index ce7c943..5a5d4a8 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/AbstractNetSyslogServerConfig.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/AbstractNetSyslogServerConfig.java @@ -3,35 +3,35 @@ package org.graylog2.syslog4j.server.impl.net; import org.graylog2.syslog4j.server.impl.AbstractSyslogServerConfig; /** -* AbstractNetSyslogServerConfig provides a base abstract implementation of the AbstractSyslogServerConfig -* configuration interface. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: AbstractNetSyslogServerConfig.java,v 1.4 2008/11/07 15:15:41 cvs Exp $ -*/ + * AbstractNetSyslogServerConfig provides a base abstract implementation of the AbstractSyslogServerConfig + * configuration interface. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: AbstractNetSyslogServerConfig.java,v 1.4 2008/11/07 15:15:41 cvs Exp $ + */ public abstract class AbstractNetSyslogServerConfig extends AbstractSyslogServerConfig { - private static final long serialVersionUID = -3363374941938350263L; - - protected String host = null; - protected int port = SYSLOG_PORT_DEFAULT; - - public String getHost() { - return this.host; - } + private static final long serialVersionUID = -3363374941938350263L; - public void setHost(String host) { - this.host = host; - } + protected String host = null; + protected int port = SYSLOG_PORT_DEFAULT; - public int getPort() { - return this.port; - } + public String getHost() { + return this.host; + } - public void setPort(int port) { - this.port = port; - } + public void setHost(String host) { + this.host = host; + } + + public int getPort() { + return this.port; + } + + public void setPort(int port) { + this.port = port; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServer.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServer.java index a7d81c0..6c50f70 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServer.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServer.java @@ -20,233 +20,233 @@ import org.graylog2.syslog4j.server.impl.AbstractSyslogServer; import org.graylog2.syslog4j.util.SyslogUtility; /** -* TCPNetSyslogServer provides a simple threaded TCP/IP server implementation. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogServer.java,v 1.23 2010/11/28 22:07:57 cvs Exp $ -*/ + * TCPNetSyslogServer provides a simple threaded TCP/IP server implementation. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogServer.java,v 1.23 2010/11/28 22:07:57 cvs Exp $ + */ public class TCPNetSyslogServer extends AbstractSyslogServer { - public static class TCPNetSyslogSocketHandler implements Runnable { - protected SyslogServerIF server = null; - protected Socket socket = null; - protected Sessions sessions = null; - - public TCPNetSyslogSocketHandler(Sessions sessions, SyslogServerIF server, Socket socket) { - this.sessions = sessions; - this.server = server; - this.socket = socket; - - synchronized(this.sessions) { - this.sessions.addSocket(socket); - } - } - - public void run() { - boolean timeout = false; - - try { - BufferedReader br = new BufferedReader(new InputStreamReader(this.socket.getInputStream())); + public static class TCPNetSyslogSocketHandler implements Runnable { + protected SyslogServerIF server = null; + protected Socket socket = null; + protected Sessions sessions = null; - String line = br.readLine(); - - if (line != null) { - AbstractSyslogServer.handleSessionOpen(this.sessions,this.server,this.socket); - } - - while (line != null && line.length() != 0) { - SyslogServerEventIF event = createEvent(this.server.getConfig(),line,this.socket.getInetAddress()); - - AbstractSyslogServer.handleEvent(this.sessions,this.server,this.socket,event); + public TCPNetSyslogSocketHandler(Sessions sessions, SyslogServerIF server, Socket socket) { + this.sessions = sessions; + this.server = server; + this.socket = socket; - line = br.readLine(); - } - - } catch (SocketTimeoutException ste) { - timeout = true; - - } catch (SocketException se) { - AbstractSyslogServer.handleException(this.sessions,this.server,this.socket.getRemoteSocketAddress(),se); - - if ("Socket closed".equals(se.getMessage())) { - // - - } else { - // - } - - } catch (IOException ioe) { - AbstractSyslogServer.handleException(this.sessions,this.server,this.socket.getRemoteSocketAddress(),ioe); - } - - try { - AbstractSyslogServer.handleSessionClosed(this.sessions,this.server,this.socket,timeout); - - this.sessions.removeSocket(this.socket); - - this.socket.close(); - - } catch (IOException ioe) { - AbstractSyslogServer.handleException(this.sessions,this.server,this.socket.getRemoteSocketAddress(),ioe); - } - } - } + synchronized (this.sessions) { + this.sessions.addSocket(socket); + } + } - protected ServerSocket serverSocket = null; - - protected final Sessions sessions = new Sessions(); - - protected TCPNetSyslogServerConfigIF tcpNetSyslogServerConfig = null; - - public void initialize() throws SyslogRuntimeException { - this.tcpNetSyslogServerConfig = null; - - try { - this.tcpNetSyslogServerConfig = (TCPNetSyslogServerConfigIF) this.syslogServerConfig; - - } catch (ClassCastException cce) { - throw new SyslogRuntimeException("config must be of type TCPNetSyslogServerConfig"); - } - - if (this.syslogServerConfig == null) { - throw new SyslogRuntimeException("config cannot be null"); - } + public void run() { + boolean timeout = false; - if (this.tcpNetSyslogServerConfig.getBacklog() < 1) { - this.tcpNetSyslogServerConfig.setBacklog(SyslogConstants.SERVER_SOCKET_BACKLOG_DEFAULT); - } - } - - public Sessions getSessions() { - return this.sessions; - } - - public synchronized void shutdown() { - super.shutdown(); - - try { - if (this.serverSocket != null) { - if (this.syslogServerConfig.getShutdownWait() > 0) { - SyslogUtility.sleep(this.syslogServerConfig.getShutdownWait()); - } - - this.serverSocket.close(); - } - - synchronized(this.sessions) { - Iterator i = this.sessions.getSockets(); - - if (i != null) { - while(i.hasNext()) { - Socket s = (Socket) i.next(); - - s.close(); - } - } - } - - } catch (IOException ioe) { - // - } - - if (this.thread != null) { - this.thread.interrupt(); - this.thread = null; - } - } + try { + BufferedReader br = new BufferedReader(new InputStreamReader(this.socket.getInputStream())); - protected ServerSocketFactory getServerSocketFactory() throws IOException { - ServerSocketFactory serverSocketFactory = ServerSocketFactory.getDefault(); - - return serverSocketFactory; - } - - protected ServerSocket createServerSocket() throws IOException { - ServerSocket newServerSocket = null; - - ServerSocketFactory factory = getServerSocketFactory(); - - if (this.syslogServerConfig.getHost() != null) { - InetAddress inetAddress = InetAddress.getByName(this.syslogServerConfig.getHost()); - - newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort(),this.tcpNetSyslogServerConfig.getBacklog(),inetAddress); - - } else { - if (this.tcpNetSyslogServerConfig.getBacklog() < 1) { - newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort()); - - } else { - newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort(),this.tcpNetSyslogServerConfig.getBacklog()); - } - } - - return newServerSocket; - } + String line = br.readLine(); - public void run() { - try { - this.serverSocket = createServerSocket(); - this.shutdown = false; - - } catch (SocketException se) { - throw new SyslogRuntimeException(se); + if (line != null) { + AbstractSyslogServer.handleSessionOpen(this.sessions, this.server, this.socket); + } - } catch (IOException ioe) { - throw new SyslogRuntimeException(ioe); - } + while (line != null && line.length() != 0) { + SyslogServerEventIF event = createEvent(this.server.getConfig(), line, this.socket.getInetAddress()); - handleInitialize(this); - - while(!this.shutdown) { - try { - Socket socket = this.serverSocket.accept(); - - if (this.tcpNetSyslogServerConfig.getTimeout() > 0) { - socket.setSoTimeout(this.tcpNetSyslogServerConfig.getTimeout()); - } - - if (this.tcpNetSyslogServerConfig.getMaxActiveSockets() > 0 && this.sessions.size() >= this.tcpNetSyslogServerConfig.getMaxActiveSockets()) { - if (this.tcpNetSyslogServerConfig.getMaxActiveSocketsBehavior() == TCPNetSyslogServerConfigIF.MAX_ACTIVE_SOCKETS_BEHAVIOR_REJECT) { - try { - socket.close(); - - } catch (Exception e) { - // - } - - socket = null; - - } else if (this.tcpNetSyslogServerConfig.getMaxActiveSocketsBehavior() == TCPNetSyslogServerConfigIF.MAX_ACTIVE_SOCKETS_BEHAVIOR_BLOCK) { - while (!this.shutdown && this.sessions.size() >= this.tcpNetSyslogServerConfig.getMaxActiveSockets() && socket.isConnected() && !socket.isClosed()) { - SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); - } - } - } + AbstractSyslogServer.handleEvent(this.sessions, this.server, this.socket, event); - if (socket != null) { - TCPNetSyslogSocketHandler handler = new TCPNetSyslogSocketHandler(this.sessions,this,socket); - - Thread t = new Thread(handler); - - t.start(); - } - - } catch (SocketException se) { - if ("Socket closed".equals(se.getMessage())) { - this.shutdown = true; - - } else { - // - } - - } catch (IOException ioe) { - // - } - } - - handleDestroy(this); - } + line = br.readLine(); + } + + } catch (SocketTimeoutException ste) { + timeout = true; + + } catch (SocketException se) { + AbstractSyslogServer.handleException(this.sessions, this.server, this.socket.getRemoteSocketAddress(), se); + + if ("Socket closed".equals(se.getMessage())) { + // + + } else { + // + } + + } catch (IOException ioe) { + AbstractSyslogServer.handleException(this.sessions, this.server, this.socket.getRemoteSocketAddress(), ioe); + } + + try { + AbstractSyslogServer.handleSessionClosed(this.sessions, this.server, this.socket, timeout); + + this.sessions.removeSocket(this.socket); + + this.socket.close(); + + } catch (IOException ioe) { + AbstractSyslogServer.handleException(this.sessions, this.server, this.socket.getRemoteSocketAddress(), ioe); + } + } + } + + protected ServerSocket serverSocket = null; + + protected final Sessions sessions = new Sessions(); + + protected TCPNetSyslogServerConfigIF tcpNetSyslogServerConfig = null; + + public void initialize() throws SyslogRuntimeException { + this.tcpNetSyslogServerConfig = null; + + try { + this.tcpNetSyslogServerConfig = (TCPNetSyslogServerConfigIF) this.syslogServerConfig; + + } catch (ClassCastException cce) { + throw new SyslogRuntimeException("config must be of type TCPNetSyslogServerConfig"); + } + + if (this.syslogServerConfig == null) { + throw new SyslogRuntimeException("config cannot be null"); + } + + if (this.tcpNetSyslogServerConfig.getBacklog() < 1) { + this.tcpNetSyslogServerConfig.setBacklog(SyslogConstants.SERVER_SOCKET_BACKLOG_DEFAULT); + } + } + + public Sessions getSessions() { + return this.sessions; + } + + public synchronized void shutdown() { + super.shutdown(); + + try { + if (this.serverSocket != null) { + if (this.syslogServerConfig.getShutdownWait() > 0) { + SyslogUtility.sleep(this.syslogServerConfig.getShutdownWait()); + } + + this.serverSocket.close(); + } + + synchronized (this.sessions) { + Iterator i = this.sessions.getSockets(); + + if (i != null) { + while (i.hasNext()) { + Socket s = (Socket) i.next(); + + s.close(); + } + } + } + + } catch (IOException ioe) { + // + } + + if (this.thread != null) { + this.thread.interrupt(); + this.thread = null; + } + } + + protected ServerSocketFactory getServerSocketFactory() throws IOException { + ServerSocketFactory serverSocketFactory = ServerSocketFactory.getDefault(); + + return serverSocketFactory; + } + + protected ServerSocket createServerSocket() throws IOException { + ServerSocket newServerSocket = null; + + ServerSocketFactory factory = getServerSocketFactory(); + + if (this.syslogServerConfig.getHost() != null) { + InetAddress inetAddress = InetAddress.getByName(this.syslogServerConfig.getHost()); + + newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort(), this.tcpNetSyslogServerConfig.getBacklog(), inetAddress); + + } else { + if (this.tcpNetSyslogServerConfig.getBacklog() < 1) { + newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort()); + + } else { + newServerSocket = factory.createServerSocket(this.syslogServerConfig.getPort(), this.tcpNetSyslogServerConfig.getBacklog()); + } + } + + return newServerSocket; + } + + public void run() { + try { + this.serverSocket = createServerSocket(); + this.shutdown = false; + + } catch (SocketException se) { + throw new SyslogRuntimeException(se); + + } catch (IOException ioe) { + throw new SyslogRuntimeException(ioe); + } + + handleInitialize(this); + + while (!this.shutdown) { + try { + Socket socket = this.serverSocket.accept(); + + if (this.tcpNetSyslogServerConfig.getTimeout() > 0) { + socket.setSoTimeout(this.tcpNetSyslogServerConfig.getTimeout()); + } + + if (this.tcpNetSyslogServerConfig.getMaxActiveSockets() > 0 && this.sessions.size() >= this.tcpNetSyslogServerConfig.getMaxActiveSockets()) { + if (this.tcpNetSyslogServerConfig.getMaxActiveSocketsBehavior() == TCPNetSyslogServerConfigIF.MAX_ACTIVE_SOCKETS_BEHAVIOR_REJECT) { + try { + socket.close(); + + } catch (Exception e) { + // + } + + socket = null; + + } else if (this.tcpNetSyslogServerConfig.getMaxActiveSocketsBehavior() == TCPNetSyslogServerConfigIF.MAX_ACTIVE_SOCKETS_BEHAVIOR_BLOCK) { + while (!this.shutdown && this.sessions.size() >= this.tcpNetSyslogServerConfig.getMaxActiveSockets() && socket.isConnected() && !socket.isClosed()) { + SyslogUtility.sleep(SyslogConstants.THREAD_LOOP_INTERVAL_DEFAULT); + } + } + } + + if (socket != null) { + TCPNetSyslogSocketHandler handler = new TCPNetSyslogSocketHandler(this.sessions, this, socket); + + Thread t = new Thread(handler); + + t.start(); + } + + } catch (SocketException se) { + if ("Socket closed".equals(se.getMessage())) { + this.shutdown = true; + + } else { + // + } + + } catch (IOException ioe) { + // + } + } + + handleDestroy(this); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfig.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfig.java index 5d63b01..2a673f0 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfig.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfig.java @@ -3,84 +3,84 @@ package org.graylog2.syslog4j.server.impl.net.tcp; import org.graylog2.syslog4j.server.impl.net.AbstractNetSyslogServerConfig; /** -* TCPNetSyslogServerConfig provides configuration for TCPNetSyslogServer. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogServerConfig.java,v 1.8 2010/11/28 01:38:08 cvs Exp $ -*/ + * TCPNetSyslogServerConfig provides configuration for TCPNetSyslogServer. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogServerConfig.java,v 1.8 2010/11/28 01:38:08 cvs Exp $ + */ public class TCPNetSyslogServerConfig extends AbstractNetSyslogServerConfig implements TCPNetSyslogServerConfigIF { - private static final long serialVersionUID = -1546696301177599370L; - - protected int timeout = 0; - protected int backlog = 0; - protected int maxActiveSockets = TCP_MAX_ACTIVE_SOCKETS_DEFAULT; - protected byte maxActiveSocketsBehavior = TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT; + private static final long serialVersionUID = -1546696301177599370L; - public TCPNetSyslogServerConfig() { - // - } + protected int timeout = 0; + protected int backlog = 0; + protected int maxActiveSockets = TCP_MAX_ACTIVE_SOCKETS_DEFAULT; + protected byte maxActiveSocketsBehavior = TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT; - public TCPNetSyslogServerConfig(int port) { - this.port = port; - } + public TCPNetSyslogServerConfig() { + // + } - public TCPNetSyslogServerConfig(int port, int backlog) { - this.port = port; - this.backlog = backlog; - } + public TCPNetSyslogServerConfig(int port) { + this.port = port; + } - public TCPNetSyslogServerConfig(String host) { - this.host = host; - } + public TCPNetSyslogServerConfig(int port, int backlog) { + this.port = port; + this.backlog = backlog; + } - public TCPNetSyslogServerConfig(String host, int port) { - this.host = host; - this.port = port; - } + public TCPNetSyslogServerConfig(String host) { + this.host = host; + } - public TCPNetSyslogServerConfig(String host, int port, int backlog) { - this.host = host; - this.port = port; - this.backlog = backlog; - } + public TCPNetSyslogServerConfig(String host, int port) { + this.host = host; + this.port = port; + } - public Class getSyslogServerClass() { - return TCPNetSyslogServer.class; - } - - public int getTimeout() { - return timeout; - } + public TCPNetSyslogServerConfig(String host, int port, int backlog) { + this.host = host; + this.port = port; + this.backlog = backlog; + } - public void setTimeout(int timeout) { - this.timeout = timeout; - } + public Class getSyslogServerClass() { + return TCPNetSyslogServer.class; + } - public int getBacklog() { - return this.backlog; - } + public int getTimeout() { + return timeout; + } - public void setBacklog(int backlog) { - this.backlog = backlog; - } + public void setTimeout(int timeout) { + this.timeout = timeout; + } - public int getMaxActiveSockets() { - return maxActiveSockets; - } + public int getBacklog() { + return this.backlog; + } - public void setMaxActiveSockets(int maxActiveSockets) { - this.maxActiveSockets = maxActiveSockets; - } + public void setBacklog(int backlog) { + this.backlog = backlog; + } - public byte getMaxActiveSocketsBehavior() { - return maxActiveSocketsBehavior; - } + public int getMaxActiveSockets() { + return maxActiveSockets; + } - public void setMaxActiveSocketsBehavior(byte maxActiveSocketsBehavior) { - this.maxActiveSocketsBehavior = maxActiveSocketsBehavior; - } + public void setMaxActiveSockets(int maxActiveSockets) { + this.maxActiveSockets = maxActiveSockets; + } + + public byte getMaxActiveSocketsBehavior() { + return maxActiveSocketsBehavior; + } + + public void setMaxActiveSocketsBehavior(byte maxActiveSocketsBehavior) { + this.maxActiveSocketsBehavior = maxActiveSocketsBehavior; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfigIF.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfigIF.java index ce6fab2..a932c79 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/TCPNetSyslogServerConfigIF.java @@ -3,28 +3,32 @@ package org.graylog2.syslog4j.server.impl.net.tcp; import org.graylog2.syslog4j.server.SyslogServerConfigIF; /** -* TCPNetSyslogServerConfigIF provides configuration for TCPNetSyslogServer. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: TCPNetSyslogServerConfigIF.java,v 1.3 2010/11/28 01:38:08 cvs Exp $ -*/ + * TCPNetSyslogServerConfigIF provides configuration for TCPNetSyslogServer. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: TCPNetSyslogServerConfigIF.java,v 1.3 2010/11/28 01:38:08 cvs Exp $ + */ public interface TCPNetSyslogServerConfigIF extends SyslogServerConfigIF { - public final static byte MAX_ACTIVE_SOCKETS_BEHAVIOR_BLOCK = 0; - public final static byte MAX_ACTIVE_SOCKETS_BEHAVIOR_REJECT = 1; - - public int getTimeout(); - public void setTimeout(int timeout); - - public int getBacklog(); - public void setBacklog(int backlog); - - public int getMaxActiveSockets(); - public void setMaxActiveSockets(int maxActiveSockets); - - public byte getMaxActiveSocketsBehavior(); - public void setMaxActiveSocketsBehavior(byte maxActiveSocketsBehavior); + public final static byte MAX_ACTIVE_SOCKETS_BEHAVIOR_BLOCK = 0; + public final static byte MAX_ACTIVE_SOCKETS_BEHAVIOR_REJECT = 1; + + public int getTimeout(); + + public void setTimeout(int timeout); + + public int getBacklog(); + + public void setBacklog(int backlog); + + public int getMaxActiveSockets(); + + public void setMaxActiveSockets(int maxActiveSockets); + + public byte getMaxActiveSocketsBehavior(); + + public void setMaxActiveSocketsBehavior(byte maxActiveSocketsBehavior); } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServer.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServer.java index c2e0704..c1505d2 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServer.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServer.java @@ -9,50 +9,50 @@ import org.graylog2.syslog4j.SyslogRuntimeException; import org.graylog2.syslog4j.server.impl.net.tcp.TCPNetSyslogServer; /** -* SSLTCPNetSyslogServer provides a simple threaded TCP/IP server implementation -* which uses SSL/TLS. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogServer.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogServer provides a simple threaded TCP/IP server implementation + * which uses SSL/TLS. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogServer.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ + */ public class SSLTCPNetSyslogServer extends TCPNetSyslogServer { - public void initialize() throws SyslogRuntimeException { - super.initialize(); - - SSLTCPNetSyslogServerConfigIF sslTcpNetSyslogServerConfig = (SSLTCPNetSyslogServerConfigIF) this.tcpNetSyslogServerConfig; - - String keyStore = sslTcpNetSyslogServerConfig.getKeyStore(); - - if (keyStore != null && !"".equals(keyStore.trim())) { - System.setProperty("javax.net.ssl.keyStore",keyStore); - } + public void initialize() throws SyslogRuntimeException { + super.initialize(); - String keyStorePassword = sslTcpNetSyslogServerConfig.getKeyStorePassword(); - - if (keyStorePassword != null && !"".equals(keyStorePassword.trim())) { - System.setProperty("javax.net.ssl.keyStorePassword",keyStorePassword); - } + SSLTCPNetSyslogServerConfigIF sslTcpNetSyslogServerConfig = (SSLTCPNetSyslogServerConfigIF) this.tcpNetSyslogServerConfig; - String trustStore = sslTcpNetSyslogServerConfig.getTrustStore(); - - if (trustStore != null && !"".equals(trustStore.trim())) { - System.setProperty("javax.net.ssl.trustStore",trustStore); - } + String keyStore = sslTcpNetSyslogServerConfig.getKeyStore(); - String trustStorePassword = sslTcpNetSyslogServerConfig.getTrustStorePassword(); - - if (trustStorePassword != null && !"".equals(trustStorePassword.trim())) { - System.setProperty("javax.net.ssl.trustStorePassword",trustStorePassword); - } - } + if (keyStore != null && !"".equals(keyStore.trim())) { + System.setProperty("javax.net.ssl.keyStore", keyStore); + } - protected ServerSocketFactory getServerSocketFactory() throws IOException { - ServerSocketFactory serverSocketFactory = SSLServerSocketFactory.getDefault(); - - return serverSocketFactory; - } + String keyStorePassword = sslTcpNetSyslogServerConfig.getKeyStorePassword(); + + if (keyStorePassword != null && !"".equals(keyStorePassword.trim())) { + System.setProperty("javax.net.ssl.keyStorePassword", keyStorePassword); + } + + String trustStore = sslTcpNetSyslogServerConfig.getTrustStore(); + + if (trustStore != null && !"".equals(trustStore.trim())) { + System.setProperty("javax.net.ssl.trustStore", trustStore); + } + + String trustStorePassword = sslTcpNetSyslogServerConfig.getTrustStorePassword(); + + if (trustStorePassword != null && !"".equals(trustStorePassword.trim())) { + System.setProperty("javax.net.ssl.trustStorePassword", trustStorePassword); + } + } + + protected ServerSocketFactory getServerSocketFactory() throws IOException { + ServerSocketFactory serverSocketFactory = SSLServerSocketFactory.getDefault(); + + return serverSocketFactory; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfig.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfig.java index 21aae76..a77c202 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfig.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfig.java @@ -3,57 +3,57 @@ package org.graylog2.syslog4j.server.impl.net.tcp.ssl; import org.graylog2.syslog4j.server.impl.net.tcp.TCPNetSyslogServerConfig; /** -* SSLTCPNetSyslogServerConfig provides configuration for SSLTCPNetSyslogServer. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogServerConfig.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogServerConfig provides configuration for SSLTCPNetSyslogServer. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogServerConfig.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ + */ public class SSLTCPNetSyslogServerConfig extends TCPNetSyslogServerConfig implements SSLTCPNetSyslogServerConfigIF { - private static final long serialVersionUID = -840102682868286462L; + private static final long serialVersionUID = -840102682868286462L; - protected String keyStore = null; - protected String keyStorePassword = null; + protected String keyStore = null; + protected String keyStorePassword = null; - protected String trustStore = null; - protected String trustStorePassword = null; + protected String trustStore = null; + protected String trustStorePassword = null; - public String getKeyStore() { - return this.keyStore; - } - - public void setKeyStore(String keyStore) { - this.keyStore = keyStore; - } - - public String getKeyStorePassword() { - return this.keyStorePassword; - } - - public void setKeyStorePassword(String keyStorePassword) { - this.keyStorePassword = keyStorePassword; - } + public String getKeyStore() { + return this.keyStore; + } - public String getTrustStore() { - return this.trustStore; - } + public void setKeyStore(String keyStore) { + this.keyStore = keyStore; + } - public void setTrustStore(String trustStore) { - this.trustStore = trustStore; - } + public String getKeyStorePassword() { + return this.keyStorePassword; + } - public String getTrustStorePassword() { - return this.trustStorePassword; - } + public void setKeyStorePassword(String keyStorePassword) { + this.keyStorePassword = keyStorePassword; + } - public void setTrustStorePassword(String trustStorePassword) { - this.trustStorePassword = trustStorePassword; - } + public String getTrustStore() { + return this.trustStore; + } - public Class getSyslogServerClass() { - return SSLTCPNetSyslogServer.class; - } + public void setTrustStore(String trustStore) { + this.trustStore = trustStore; + } + + public String getTrustStorePassword() { + return this.trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + + public Class getSyslogServerClass() { + return SSLTCPNetSyslogServer.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfigIF.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfigIF.java index a81f6ef..0b69156 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfigIF.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/tcp/ssl/SSLTCPNetSyslogServerConfigIF.java @@ -3,25 +3,29 @@ package org.graylog2.syslog4j.server.impl.net.tcp.ssl; import org.graylog2.syslog4j.server.impl.net.tcp.TCPNetSyslogServerConfigIF; /** -* SSLTCPNetSyslogServerConfigIF provides configuration for SSLTCPNetSyslogServer. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SSLTCPNetSyslogServerConfigIF.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ -*/ + * SSLTCPNetSyslogServerConfigIF provides configuration for SSLTCPNetSyslogServer. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SSLTCPNetSyslogServerConfigIF.java,v 1.1 2009/03/29 17:38:58 cvs Exp $ + */ public interface SSLTCPNetSyslogServerConfigIF extends TCPNetSyslogServerConfigIF { - public String getKeyStore(); - public void setKeyStore(String keyStore); - - public String getKeyStorePassword(); - public void setKeyStorePassword(String keyStorePassword); + public String getKeyStore(); - public String getTrustStore(); - public void setTrustStore(String trustStore); - - public String getTrustStorePassword(); - public void setTrustStorePassword(String trustStorePassword); + public void setKeyStore(String keyStore); + + public String getKeyStorePassword(); + + public void setKeyStorePassword(String keyStorePassword); + + public String getTrustStore(); + + public void setTrustStore(String trustStore); + + public String getTrustStorePassword(); + + public void setTrustStorePassword(String trustStorePassword); } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServer.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServer.java index 4390ea5..de943ea 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServer.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServer.java @@ -14,89 +14,89 @@ import org.graylog2.syslog4j.server.impl.AbstractSyslogServer; import org.graylog2.syslog4j.util.SyslogUtility; /** -* UDPNetSyslogServer provides a simple non-threaded UDP/IP server implementation. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UDPNetSyslogServer.java,v 1.16 2010/11/12 03:43:15 cvs Exp $ -*/ + * UDPNetSyslogServer provides a simple non-threaded UDP/IP server implementation. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UDPNetSyslogServer.java,v 1.16 2010/11/12 03:43:15 cvs Exp $ + */ public class UDPNetSyslogServer extends AbstractSyslogServer { - protected DatagramSocket ds = null; + protected DatagramSocket ds = null; - public void initialize() throws SyslogRuntimeException { - // - } - - public void shutdown() { - super.shutdown(); - - if (this.syslogServerConfig.getShutdownWait() > 0) { - SyslogUtility.sleep(this.syslogServerConfig.getShutdownWait()); - } - - if (this.ds != null && !this.ds.isClosed()) { - this.ds.close(); - } - } - - protected DatagramSocket createDatagramSocket() throws SocketException, UnknownHostException { - DatagramSocket datagramSocket = null; - - if (this.syslogServerConfig.getHost() != null) { - InetAddress inetAddress = InetAddress.getByName(this.syslogServerConfig.getHost()); - - datagramSocket = new DatagramSocket(this.syslogServerConfig.getPort(),inetAddress); - - } else { - datagramSocket = new DatagramSocket(this.syslogServerConfig.getPort()); - } - - return datagramSocket; - } + public void initialize() throws SyslogRuntimeException { + // + } - public void run() { - try { - this.ds = createDatagramSocket(); - this.shutdown = false; - - } catch (SocketException se) { - return; - - } catch (UnknownHostException uhe) { - return; - } - - byte[] receiveData = new byte[SyslogConstants.SYSLOG_BUFFER_SIZE]; - - handleInitialize(this); - - while(!this.shutdown) { - DatagramPacket dp = null; - - try { - dp = new DatagramPacket(receiveData,receiveData.length); - - this.ds.receive(dp); - - SyslogServerEventIF event = createEvent(this.getConfig(),receiveData,dp.getLength(),dp.getAddress()); - - handleEvent(null,this,dp,event); - - } catch (SocketException se) { - int i = se.getMessage() == null ? -1 : se.getMessage().toLowerCase().indexOf("socket closed"); - - if (i == -1) { - handleException(null,this,dp.getSocketAddress(),se); - } - - } catch (IOException ioe) { - handleException(null,this,dp.getSocketAddress(),ioe); - } - } - - handleDestroy(this); - } + public void shutdown() { + super.shutdown(); + + if (this.syslogServerConfig.getShutdownWait() > 0) { + SyslogUtility.sleep(this.syslogServerConfig.getShutdownWait()); + } + + if (this.ds != null && !this.ds.isClosed()) { + this.ds.close(); + } + } + + protected DatagramSocket createDatagramSocket() throws SocketException, UnknownHostException { + DatagramSocket datagramSocket = null; + + if (this.syslogServerConfig.getHost() != null) { + InetAddress inetAddress = InetAddress.getByName(this.syslogServerConfig.getHost()); + + datagramSocket = new DatagramSocket(this.syslogServerConfig.getPort(), inetAddress); + + } else { + datagramSocket = new DatagramSocket(this.syslogServerConfig.getPort()); + } + + return datagramSocket; + } + + public void run() { + try { + this.ds = createDatagramSocket(); + this.shutdown = false; + + } catch (SocketException se) { + return; + + } catch (UnknownHostException uhe) { + return; + } + + byte[] receiveData = new byte[SyslogConstants.SYSLOG_BUFFER_SIZE]; + + handleInitialize(this); + + while (!this.shutdown) { + DatagramPacket dp = null; + + try { + dp = new DatagramPacket(receiveData, receiveData.length); + + this.ds.receive(dp); + + SyslogServerEventIF event = createEvent(this.getConfig(), receiveData, dp.getLength(), dp.getAddress()); + + handleEvent(null, this, dp, event); + + } catch (SocketException se) { + int i = se.getMessage() == null ? -1 : se.getMessage().toLowerCase().indexOf("socket closed"); + + if (i == -1) { + handleException(null, this, dp.getSocketAddress(), se); + } + + } catch (IOException ioe) { + handleException(null, this, dp.getSocketAddress(), ioe); + } + } + + handleDestroy(this); + } } diff --git a/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServerConfig.java b/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServerConfig.java index 7e1885a..342df88 100644 --- a/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServerConfig.java +++ b/src/main/java/org/graylog2/syslog4j/server/impl/net/udp/UDPNetSyslogServerConfig.java @@ -3,36 +3,36 @@ package org.graylog2.syslog4j.server.impl.net.udp; import org.graylog2.syslog4j.server.impl.net.AbstractNetSyslogServerConfig; /** -* UDPNetSyslogServerConfig provides configuration for UDPNetSyslogServer. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: UDPNetSyslogServerConfig.java,v 1.6 2010/10/28 05:10:57 cvs Exp $ -*/ + * UDPNetSyslogServerConfig provides configuration for UDPNetSyslogServer. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: UDPNetSyslogServerConfig.java,v 1.6 2010/10/28 05:10:57 cvs Exp $ + */ public class UDPNetSyslogServerConfig extends AbstractNetSyslogServerConfig { - private static final long serialVersionUID = -2005919161187055486L; + private static final long serialVersionUID = -2005919161187055486L; - public UDPNetSyslogServerConfig() { - // - } + public UDPNetSyslogServerConfig() { + // + } - public UDPNetSyslogServerConfig(int port) { - this.port = port; - } + public UDPNetSyslogServerConfig(int port) { + this.port = port; + } - public UDPNetSyslogServerConfig(String host) { - this.host = host; - } + public UDPNetSyslogServerConfig(String host) { + this.host = host; + } - public UDPNetSyslogServerConfig(String host, int port) { - this.host = host; - this.port = port; - } + public UDPNetSyslogServerConfig(String host, int port) { + this.host = host; + this.port = port; + } - public Class getSyslogServerClass() { - return UDPNetSyslogServer.class; - } + public Class getSyslogServerClass() { + return UDPNetSyslogServer.class; + } } diff --git a/src/main/java/org/graylog2/syslog4j/util/Base64.java b/src/main/java/org/graylog2/syslog4j/util/Base64.java index 89f2a86..b766279 100644 --- a/src/main/java/org/graylog2/syslog4j/util/Base64.java +++ b/src/main/java/org/graylog2/syslog4j/util/Base64.java @@ -3,76 +3,76 @@ package org.graylog2.syslog4j.util; /** *

Encodes and decodes to and from Base64 notation.

*

Homepage: http://iharder.net/base64.

- * - *

The options parameter, which appears in a few places, is used to pass - * several pieces of information to the encoder. In the "higher level" methods such as - * encodeBytes( bytes, options ) the options parameter can be used to indicate such - * things as first gzipping the bytes before encoding them, not inserting linefeeds - * (though that breaks strict Base64 compatibility), and encoding using the URL-safe + *

+ *

The options parameter, which appears in a few places, is used to pass + * several pieces of information to the encoder. In the "higher level" methods such as + * encodeBytes( bytes, options ) the options parameter can be used to indicate such + * things as first gzipping the bytes before encoding them, not inserting linefeeds + * (though that breaks strict Base64 compatibility), and encoding using the URL-safe * and Ordered dialects.

- * - *

The constants defined in Base64 can be OR-ed together to combine options, so you + *

+ *

The constants defined in Base64 can be OR-ed together to combine options, so you * might make a call like this:

- * + *

* String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DONT_BREAK_LINES ); - * + *

*

to compress the data before encoding it and then making the output have no newline characters.

- * - * + *

+ *

*

* Change Log: *

*
    - *
  • [Small code cleanup/fixes for inclusion into Syslog4j]
    • - *
  • v2.2.2 - Fixed encodeFileToFile and decodeFileToFile to use the - * Base64.InputStream class to encode and decode on the fly which uses - * less memory than encoding/decoding an entire file into memory before writing.
    • - *
  • v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug - * when using very small files (~< 40 bytes).
    • - *
  • v2.2 - Added some helper methods for encoding/decoding directly from - * one file to the next. Also added a main() method to support command line - * encoding/decoding from one file to the next. Also added these Base64 dialects: - *
      - *
    1. The default is RFC3548 format.
      2. - *
    2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates - * URL and file name friendly format as described in Section 4 of RFC3548. - * http://www.faqs.org/rfcs/rfc3548.html
      3. - *
    3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates - * URL and file name friendly format that preserves lexical ordering as described - * in http://www.faqs.org/qa/rfcc-1940.html
      4. - *
    - * Special thanks to Jim Kellerman at http://www.powerset.com/ - * for contributing the new Base64 dialects. - *
    • - * - *
  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added - * some convenience methods for reading and writing to and from files.
    • - *
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems - * with other encodings (like EBCDIC).
    • - *
  • v2.0.1 - Fixed an error when decoding a single byte, that is, when the - * encoded data was a single byte.
    • - *
  • v2.0 - I got rid of methods that used booleans to set options. - * Now everything is more consolidated and cleaner. The code now detects - * when data that's being decoded is gzip-compressed and will decompress it - * automatically. Generally things are cleaner. You'll probably have to - * change some method calls that you were making to support the new - * options format (ints that you "OR" together).
    • - *
  • v1.5.1 - Fixed bug when decompressing and decoding to a - * byte[] using decode( String s, boolean gzipCompressed ). - * Added the ability to "suspend" encoding in the Output Stream so - * you can turn on and off the encoding if you need to embed base64 - * data in an otherwise "normal" stream (like an XML file).
    • - *
  • v1.5 - Output stream pases on flush() command but doesn't do anything itself. - * This helps when using GZIP streams. - * Added the ability to GZip-compress objects before encoding them.
    • - *
  • v1.4 - Added helper methods to read/write files.
    • - *
  • v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
    • - *
  • v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream - * where last buffer being read, if not completely full, was not returned.
    • - *
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
    • - *
  • v1.3.3 - Fixed I/O streams which were totally messed up.
    • + *
  • [Small code cleanup/fixes for inclusion into Syslog4j]
    • + *
  • v2.2.2 - Fixed encodeFileToFile and decodeFileToFile to use the + * Base64.InputStream class to encode and decode on the fly which uses + * less memory than encoding/decoding an entire file into memory before writing.
    • + *
  • v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug + * when using very small files (~< 40 bytes).
    • + *
  • v2.2 - Added some helper methods for encoding/decoding directly from + * one file to the next. Also added a main() method to support command line + * encoding/decoding from one file to the next. Also added these Base64 dialects: + *
      + *
    1. The default is RFC3548 format.
      2. + *
    2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates + * URL and file name friendly format as described in Section 4 of RFC3548. + * http://www.faqs.org/rfcs/rfc3548.html
      3. + *
    3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates + * URL and file name friendly format that preserves lexical ordering as described + * in http://www.faqs.org/qa/rfcc-1940.html
      4. + *
    + * Special thanks to Jim Kellerman at http://www.powerset.com/ + * for contributing the new Base64 dialects. + *
    • + *

    + *

  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added + * some convenience methods for reading and writing to and from files.
    • + *
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems + * with other encodings (like EBCDIC).
    • + *
  • v2.0.1 - Fixed an error when decoding a single byte, that is, when the + * encoded data was a single byte.
    • + *
  • v2.0 - I got rid of methods that used booleans to set options. + * Now everything is more consolidated and cleaner. The code now detects + * when data that's being decoded is gzip-compressed and will decompress it + * automatically. Generally things are cleaner. You'll probably have to + * change some method calls that you were making to support the new + * options format (ints that you "OR" together).
    • + *
  • v1.5.1 - Fixed bug when decompressing and decoding to a + * byte[] using decode( String s, boolean gzipCompressed ). + * Added the ability to "suspend" encoding in the Output Stream so + * you can turn on and off the encoding if you need to embed base64 + * data in an otherwise "normal" stream (like an XML file).
    • + *
  • v1.5 - Output stream pases on flush() command but doesn't do anything itself. + * This helps when using GZIP streams. + * Added the ability to GZip-compress objects before encoding them.
    • + *
  • v1.4 - Added helper methods to read/write files.
    • + *
  • v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
    • + *
  • v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream + * where last buffer being read, if not completely full, was not returned.
    • + *
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
    • + *
  • v1.3.3 - Fixed I/O streams which were totally messed up.
    • *
- * + *

*

* I am placing this code in the Public Domain. Do with it as you will. * This software comes with no guarantees or warranties but with @@ -85,120 +85,139 @@ package org.graylog2.syslog4j.util; * @author rob@iharder.net * @version 2.2.2 */ -public class Base64 -{ +public class Base64 { -/* ******** P U B L I C F I E L D S ******** */ - - - /** No options specified. Value is zero. */ +/* ******** P U B L I C F I E L D S ******** */ + + + /** + * No options specified. Value is zero. + */ public final static int NO_OPTIONS = 0; - - /** Specify encoding. */ + + /** + * Specify encoding. + */ public final static int ENCODE = 1; - - - /** Specify decoding. */ + + + /** + * Specify decoding. + */ public final static int DECODE = 0; - - - /** Specify that data should be gzip-compressed. */ + + + /** + * Specify that data should be gzip-compressed. + */ public final static int GZIP = 2; - - - /** Don't break lines when encoding (violates strict Base64 specification) */ + + + /** + * Don't break lines when encoding (violates strict Base64 specification) + */ public final static int DONT_BREAK_LINES = 8; - - /** - * Encode using Base64-like encoding that is URL- and Filename-safe as described - * in Section 4 of RFC3548: - * http://www.faqs.org/rfcs/rfc3548.html. - * It is important to note that data encoded this way is not officially valid Base64, - * or at the very least should not be called Base64 without also specifying that is - * was encoded using the URL- and Filename-safe dialect. - */ - public final static int URL_SAFE = 16; - - - /** - * Encode using the special "ordered" dialect of Base64 described here: - * http://www.faqs.org/qa/rfcc-1940.html. - */ - public final static int ORDERED = 32; + + /** + * Encode using Base64-like encoding that is URL- and Filename-safe as described + * in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * It is important to note that data encoded this way is not officially valid Base64, + * or at the very least should not be called Base64 without also specifying that is + * was encoded using the URL- and Filename-safe dialect. + */ + public final static int URL_SAFE = 16; + + + /** + * Encode using the special "ordered" dialect of Base64 described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ + public final static int ORDERED = 32; -/* ******** P R I V A T E F I E L D S ******** */ - - - /** Maximum line length (76) of Base64 output. */ +/* ******** P R I V A T E F I E L D S ******** */ + + + /** + * Maximum line length (76) of Base64 output. + */ private final static int MAX_LINE_LENGTH = 76; - - - /** The equals sign (=) as a byte. */ - private final static byte EQUALS_SIGN = (byte)'='; - - - /** The new line character (\n) as a byte. */ - private final static byte NEW_LINE = (byte)'\n'; - - - /** Preferred encoding. */ + + + /** + * The equals sign (=) as a byte. + */ + private final static byte EQUALS_SIGN = (byte) '='; + + + /** + * The new line character (\n) as a byte. + */ + private final static byte NEW_LINE = (byte) '\n'; + + + /** + * Preferred encoding. + */ private final static String PREFERRED_ENCODING = "UTF-8"; - - + + // I think I end up not using the BAD_ENCODING indicator. //private final static byte BAD_ENCODING = -9; // Indicates error in encoding private final static byte WHITE_SPACE_ENC = -5; // Indicates white space in encoding private final static byte EQUALS_SIGN_ENC = -1; // Indicates equals sign in encoding + - -/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */ - - /** The 64 valid Base64 values. */ +/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */ + + /** + * The 64 valid Base64 values. + */ //private final static byte[] ALPHABET; /* Host platform me be something funny like EBCDIC, so we hardcode these values. */ - private final static byte[] _STANDARD_ALPHABET = - { - (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', - (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', - (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', - (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', - (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', - (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', - (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', - (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', - (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', - (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/' - }; - - - /** + private final static byte[] _STANDARD_ALPHABET = + { + (byte) 'A', (byte) 'B', (byte) 'C', (byte) 'D', (byte) 'E', (byte) 'F', (byte) 'G', + (byte) 'H', (byte) 'I', (byte) 'J', (byte) 'K', (byte) 'L', (byte) 'M', (byte) 'N', + (byte) 'O', (byte) 'P', (byte) 'Q', (byte) 'R', (byte) 'S', (byte) 'T', (byte) 'U', + (byte) 'V', (byte) 'W', (byte) 'X', (byte) 'Y', (byte) 'Z', + (byte) 'a', (byte) 'b', (byte) 'c', (byte) 'd', (byte) 'e', (byte) 'f', (byte) 'g', + (byte) 'h', (byte) 'i', (byte) 'j', (byte) 'k', (byte) 'l', (byte) 'm', (byte) 'n', + (byte) 'o', (byte) 'p', (byte) 'q', (byte) 'r', (byte) 's', (byte) 't', (byte) 'u', + (byte) 'v', (byte) 'w', (byte) 'x', (byte) 'y', (byte) 'z', + (byte) '0', (byte) '1', (byte) '2', (byte) '3', (byte) '4', (byte) '5', + (byte) '6', (byte) '7', (byte) '8', (byte) '9', (byte) '+', (byte) '/' + }; + + + /** * Translates a Base64 value to either its 6-bit reconstruction value * or a negative number indicating some other meaning. - **/ + */ private final static byte[] _STANDARD_DECODABET = - { - -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 - -5,-5, // Whitespace: Tab and Linefeed - -9,-9, // Decimal 11 - 12 - -5, // Whitespace: Carriage Return - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 - -9,-9,-9,-9,-9, // Decimal 27 - 31 - -5, // Whitespace: Space - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 - 62, // Plus sign at decimal 43 - -9,-9,-9, // Decimal 44 - 46 - 63, // Slash at decimal 47 - 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine - -9,-9,-9, // Decimal 58 - 60 - -1, // Equals sign at decimal 61 - -9,-9,-9, // Decimal 62 - 64 - 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' - 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' - -9,-9,-9,-9,-9,-9, // Decimal 91 - 96 - 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' - 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' - -9,-9,-9,-9 // Decimal 123 - 126 + { + -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 0 - 8 + -5, -5, // Whitespace: Tab and Linefeed + -9, -9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 14 - 26 + -9, -9, -9, -9, -9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 33 - 42 + 62, // Plus sign at decimal 43 + -9, -9, -9, // Decimal 44 - 46 + 63, // Slash at decimal 47 + 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, // Numbers zero through nine + -9, -9, -9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9, -9, -9, // Decimal 62 - 64 + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, // Letters 'A' through 'N' + 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, // Letters 'O' through 'Z' + -9, -9, -9, -9, -9, -9, // Decimal 91 - 96 + 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, // Letters 'a' through 'm' + 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, // Letters 'n' through 'z' + -9, -9, -9, -9 // Decimal 123 - 126 /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 @@ -209,60 +228,60 @@ public class Base64 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ - }; + }; /* ******** U R L S A F E B A S E 6 4 A L P H A B E T ******** */ - - /** - * Used in the URL- and Filename-safe dialect described in Section 4 of RFC3548: - * http://www.faqs.org/rfcs/rfc3548.html. - * Notice that the last two bytes become "hyphen" and "underscore" instead of "plus" and "slash." - */ + + /** + * Used in the URL- and Filename-safe dialect described in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * Notice that the last two bytes become "hyphen" and "underscore" instead of "plus" and "slash." + */ private final static byte[] _URL_SAFE_ALPHABET = - { - (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', - (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', - (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', - (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', - (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', - (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', - (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', - (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', - (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', - (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'-', (byte)'_' - }; - - /** - * Used in decoding URL- and Filename-safe dialects of Base64. - */ + { + (byte) 'A', (byte) 'B', (byte) 'C', (byte) 'D', (byte) 'E', (byte) 'F', (byte) 'G', + (byte) 'H', (byte) 'I', (byte) 'J', (byte) 'K', (byte) 'L', (byte) 'M', (byte) 'N', + (byte) 'O', (byte) 'P', (byte) 'Q', (byte) 'R', (byte) 'S', (byte) 'T', (byte) 'U', + (byte) 'V', (byte) 'W', (byte) 'X', (byte) 'Y', (byte) 'Z', + (byte) 'a', (byte) 'b', (byte) 'c', (byte) 'd', (byte) 'e', (byte) 'f', (byte) 'g', + (byte) 'h', (byte) 'i', (byte) 'j', (byte) 'k', (byte) 'l', (byte) 'm', (byte) 'n', + (byte) 'o', (byte) 'p', (byte) 'q', (byte) 'r', (byte) 's', (byte) 't', (byte) 'u', + (byte) 'v', (byte) 'w', (byte) 'x', (byte) 'y', (byte) 'z', + (byte) '0', (byte) '1', (byte) '2', (byte) '3', (byte) '4', (byte) '5', + (byte) '6', (byte) '7', (byte) '8', (byte) '9', (byte) '-', (byte) '_' + }; + + /** + * Used in decoding URL- and Filename-safe dialects of Base64. + */ private final static byte[] _URL_SAFE_DECODABET = - { - -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 - -5,-5, // Whitespace: Tab and Linefeed - -9,-9, // Decimal 11 - 12 - -5, // Whitespace: Carriage Return - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 - -9,-9,-9,-9,-9, // Decimal 27 - 31 - -5, // Whitespace: Space - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 - -9, // Plus sign at decimal 43 - -9, // Decimal 44 - 62, // Minus sign at decimal 45 - -9, // Decimal 46 - -9, // Slash at decimal 47 - 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine - -9,-9,-9, // Decimal 58 - 60 - -1, // Equals sign at decimal 61 - -9,-9,-9, // Decimal 62 - 64 - 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' - 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' - -9,-9,-9,-9, // Decimal 91 - 94 - 63, // Underscore at decimal 95 - -9, // Decimal 96 - 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' - 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' - -9,-9,-9,-9 // Decimal 123 - 126 + { + -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 0 - 8 + -5, -5, // Whitespace: Tab and Linefeed + -9, -9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 14 - 26 + -9, -9, -9, -9, -9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 62, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, // Numbers zero through nine + -9, -9, -9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9, -9, -9, // Decimal 62 - 64 + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, // Letters 'A' through 'N' + 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, // Letters 'O' through 'Z' + -9, -9, -9, -9, // Decimal 91 - 94 + 63, // Underscore at decimal 95 + -9, // Decimal 96 + 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, // Letters 'a' through 'm' + 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, // Letters 'n' through 'z' + -9, -9, -9, -9 // Decimal 123 - 126 /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 @@ -273,62 +292,62 @@ public class Base64 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ - }; + }; /* ******** O R D E R E D B A S E 6 4 A L P H A B E T ******** */ - /** - * I don't get the point of this technique, but it is described here: - * http://www.faqs.org/qa/rfcc-1940.html. - */ + /** + * I don't get the point of this technique, but it is described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ private final static byte[] _ORDERED_ALPHABET = - { - (byte)'-', - (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', - (byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9', - (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', - (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', - (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', - (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', - (byte)'_', - (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', - (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', - (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', - (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z' - }; - - /** - * Used in decoding the "ordered" dialect of Base64. - */ + { + (byte) '-', + (byte) '0', (byte) '1', (byte) '2', (byte) '3', (byte) '4', + (byte) '5', (byte) '6', (byte) '7', (byte) '8', (byte) '9', + (byte) 'A', (byte) 'B', (byte) 'C', (byte) 'D', (byte) 'E', (byte) 'F', (byte) 'G', + (byte) 'H', (byte) 'I', (byte) 'J', (byte) 'K', (byte) 'L', (byte) 'M', (byte) 'N', + (byte) 'O', (byte) 'P', (byte) 'Q', (byte) 'R', (byte) 'S', (byte) 'T', (byte) 'U', + (byte) 'V', (byte) 'W', (byte) 'X', (byte) 'Y', (byte) 'Z', + (byte) '_', + (byte) 'a', (byte) 'b', (byte) 'c', (byte) 'd', (byte) 'e', (byte) 'f', (byte) 'g', + (byte) 'h', (byte) 'i', (byte) 'j', (byte) 'k', (byte) 'l', (byte) 'm', (byte) 'n', + (byte) 'o', (byte) 'p', (byte) 'q', (byte) 'r', (byte) 's', (byte) 't', (byte) 'u', + (byte) 'v', (byte) 'w', (byte) 'x', (byte) 'y', (byte) 'z' + }; + + /** + * Used in decoding the "ordered" dialect of Base64. + */ private final static byte[] _ORDERED_DECODABET = - { - -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 - -5,-5, // Whitespace: Tab and Linefeed - -9,-9, // Decimal 11 - 12 - -5, // Whitespace: Carriage Return - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 - -9,-9,-9,-9,-9, // Decimal 27 - 31 - -5, // Whitespace: Space - -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 - -9, // Plus sign at decimal 43 - -9, // Decimal 44 - 0, // Minus sign at decimal 45 - -9, // Decimal 46 - -9, // Slash at decimal 47 - 1,2,3,4,5,6,7,8,9,10, // Numbers zero through nine - -9,-9,-9, // Decimal 58 - 60 - -1, // Equals sign at decimal 61 - -9,-9,-9, // Decimal 62 - 64 - 11,12,13,14,15,16,17,18,19,20,21,22,23, // Letters 'A' through 'M' - 24,25,26,27,28,29,30,31,32,33,34,35,36, // Letters 'N' through 'Z' - -9,-9,-9,-9, // Decimal 91 - 94 - 37, // Underscore at decimal 95 - -9, // Decimal 96 - 38,39,40,41,42,43,44,45,46,47,48,49,50, // Letters 'a' through 'm' - 51,52,53,54,55,56,57,58,59,60,61,62,63, // Letters 'n' through 'z' - -9,-9,-9,-9 // Decimal 123 - 126 + { + -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 0 - 8 + -5, -5, // Whitespace: Tab and Linefeed + -9, -9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 14 - 26 + -9, -9, -9, -9, -9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9, -9, -9, -9, -9, -9, -9, -9, -9, -9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 0, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, // Numbers zero through nine + -9, -9, -9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9, -9, -9, // Decimal 62 - 64 + 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, // Letters 'A' through 'M' + 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, // Letters 'N' through 'Z' + -9, -9, -9, -9, // Decimal 91 - 94 + 37, // Underscore at decimal 95 + -9, // Decimal 96 + 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, // Letters 'a' through 'm' + 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, // Letters 'n' through 'z' + -9, -9, -9, -9 // Decimal 123 - 126 /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 @@ -339,71 +358,70 @@ public class Base64 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ - }; + }; /* ******** D E T E R M I N E W H I C H A L H A B E T ******** */ - /** - * Returns one of the _SOMETHING_ALPHABET byte arrays depending on - * the options specified. - * It's possible, though silly, to specify ORDERED and URLSAFE - * in which case one of them will be picked, though there is - * no guarantee as to which one will be picked. - */ - private final static byte[] getAlphabet( int options ) - { - if( (options & URL_SAFE) == URL_SAFE ) return _URL_SAFE_ALPHABET; - else if( (options & ORDERED) == ORDERED ) return _ORDERED_ALPHABET; - else return _STANDARD_ALPHABET; - - } // end getAlphabet - - - /** - * Returns one of the _SOMETHING_DECODABET byte arrays depending on - * the options specified. - * It's possible, though silly, to specify ORDERED and URL_SAFE - * in which case one of them will be picked, though there is - * no guarantee as to which one will be picked. - */ - private final static byte[] getDecodabet( int options ) - { - if( (options & URL_SAFE) == URL_SAFE ) return _URL_SAFE_DECODABET; - else if( (options & ORDERED) == ORDERED ) return _ORDERED_DECODABET; - else return _STANDARD_DECODABET; - - } // end getAlphabet - + /** + * Returns one of the _SOMETHING_ALPHABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URLSAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getAlphabet(int options) { + if ((options & URL_SAFE) == URL_SAFE) return _URL_SAFE_ALPHABET; + else if ((options & ORDERED) == ORDERED) return _ORDERED_ALPHABET; + else return _STANDARD_ALPHABET; + + } // end getAlphabet + + + /** + * Returns one of the _SOMETHING_DECODABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URL_SAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getDecodabet(int options) { + if ((options & URL_SAFE) == URL_SAFE) return _URL_SAFE_DECODABET; + else if ((options & ORDERED) == ORDERED) return _ORDERED_DECODABET; + else return _STANDARD_DECODABET; + + } // end getAlphabet + + + /** + * Defeats instantiation. + */ + private Base64() { + } - - /** Defeats instantiation. */ - private Base64(){} - /** * Encodes or decodes two files from the command line; * feel free to delete this method (in fact you probably should) * if you're embedding this code into a larger program. */ - public final static void main( String[] args ) - { - if( args.length < 3 ){ + public final static void main(String[] args) { + if (args.length < 3) { usage("Not enough arguments."); } // end if: args.length < 3 else { String flag = args[0]; String infile = args[1]; String outfile = args[2]; - if( flag.equals( "-e" ) ){ - Base64.encodeFileToFile( infile, outfile ); + if (flag.equals("-e")) { + Base64.encodeFileToFile(infile, outfile); } // end if: encode - else if( flag.equals( "-d" ) ) { - Base64.decodeFileToFile( infile, outfile ); + else if (flag.equals("-d")) { + Base64.decodeFileToFile(infile, outfile); } // end else if: decode else { - usage( "Unknown flag: " + flag ); + usage("Unknown flag: " + flag); } // end else } // end else } // end main @@ -413,16 +431,15 @@ public class Base64 * * @param msg A message to include with usage info. */ - private final static void usage( String msg ) - { - System.err.println( msg ); - System.err.println( "Usage: java Base64 -e|-d inputfile outputfile" ); + private final static void usage(String msg) { + System.err.println(msg); + System.err.println("Usage: java Base64 -e|-d inputfile outputfile"); } // end usage -/* ******** E N C O D I N G M E T H O D S ******** */ - - +/* ******** E N C O D I N G M E T H O D S ******** */ + + /** * Encodes up to the first three bytes of array threeBytes * and returns a four-byte array in Base64 notation. @@ -432,24 +449,23 @@ public class Base64 * numSigBytes. * Code can reuse a byte array by passing a four-byte array as b4. * - * @param b4 A reusable byte array to reduce array instantiation - * @param threeBytes the array to convert + * @param b4 A reusable byte array to reduce array instantiation + * @param threeBytes the array to convert * @param numSigBytes the number of significant bytes in your array * @return four byte array in Base64 notation. * @since 1.5.1 */ - private static byte[] encode3to4( byte[] b4, byte[] threeBytes, int numSigBytes, int options ) - { - encode3to4( threeBytes, 0, numSigBytes, b4, 0, options ); + private static byte[] encode3to4(byte[] b4, byte[] threeBytes, int numSigBytes, int options) { + encode3to4(threeBytes, 0, numSigBytes, b4, 0, options); return b4; } // end encode3to4 - + /** *

Encodes up to three bytes of the array source * and writes the resulting four Base64 bytes to destination. * The source and destination arrays can be manipulated - * anywhere along their length by specifying + * anywhere along their length by specifying * srcOffset and destOffset. * This method does not check to make sure your arrays * are large enough to accomodate srcOffset + 3 for @@ -457,68 +473,65 @@ public class Base64 * the destination array. * The actual number of significant bytes in your array is * given by numSigBytes.

- *

This is the lowest level of the encoding methods with - * all possible parameters.

+ *

This is the lowest level of the encoding methods with + * all possible parameters.

* - * @param source the array to convert - * @param srcOffset the index where conversion begins + * @param source the array to convert + * @param srcOffset the index where conversion begins * @param numSigBytes the number of significant bytes in your array * @param destination the array to hold the conversion - * @param destOffset the index where output will be put + * @param destOffset the index where output will be put * @return the destination array * @since 1.3 */ - private static byte[] encode3to4( - byte[] source, int srcOffset, int numSigBytes, - byte[] destination, int destOffset, int options ) - { - byte[] ALPHABET = getAlphabet( options ); - + private static byte[] encode3to4( + byte[] source, int srcOffset, int numSigBytes, + byte[] destination, int destOffset, int options) { + byte[] ALPHABET = getAlphabet(options); + // 1 2 3 // 01234567890123456789012345678901 Bit position // --------000000001111111122222222 Array position from threeBytes // --------| || || || | Six bit groups to index ALPHABET // >>18 >>12 >> 6 >> 0 Right shift necessary // 0x3f 0x3f 0x3f Additional AND - + // Create buffer with zero-padding if there are only one or two // significant bytes passed in the array. // We have to shift left 24 in order to flush out the 1's that appear // when Java treats a value as negative that is cast from a byte to an int. - int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 ) - | ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 ) - | ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 ); + int inBuff = (numSigBytes > 0 ? ((source[srcOffset] << 24) >>> 8) : 0) + | (numSigBytes > 1 ? ((source[srcOffset + 1] << 24) >>> 16) : 0) + | (numSigBytes > 2 ? ((source[srcOffset + 2] << 24) >>> 24) : 0); - switch( numSigBytes ) - { + switch (numSigBytes) { case 3: - destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; - destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; - destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; - destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ]; + destination[destOffset] = ALPHABET[(inBuff >>> 18)]; + destination[destOffset + 1] = ALPHABET[(inBuff >>> 12) & 0x3f]; + destination[destOffset + 2] = ALPHABET[(inBuff >>> 6) & 0x3f]; + destination[destOffset + 3] = ALPHABET[(inBuff) & 0x3f]; return destination; - + case 2: - destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; - destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; - destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; - destination[ destOffset + 3 ] = EQUALS_SIGN; + destination[destOffset] = ALPHABET[(inBuff >>> 18)]; + destination[destOffset + 1] = ALPHABET[(inBuff >>> 12) & 0x3f]; + destination[destOffset + 2] = ALPHABET[(inBuff >>> 6) & 0x3f]; + destination[destOffset + 3] = EQUALS_SIGN; return destination; - + case 1: - destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; - destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; - destination[ destOffset + 2 ] = EQUALS_SIGN; - destination[ destOffset + 3 ] = EQUALS_SIGN; + destination[destOffset] = ALPHABET[(inBuff >>> 18)]; + destination[destOffset + 1] = ALPHABET[(inBuff >>> 12) & 0x3f]; + destination[destOffset + 2] = EQUALS_SIGN; + destination[destOffset + 3] = EQUALS_SIGN; return destination; - + default: return destination; } // end switch } // end encode3to4 - - - + + /** * Serializes an object and returns the Base64-encoded * version of that serialized object. If the object @@ -530,11 +543,9 @@ public class Base64 * @return The Base64-encoded object * @since 1.4 */ - public static String encodeObject( java.io.Serializable serializableObject ) - { - return encodeObject( serializableObject, NO_OPTIONS ); + public static String encodeObject(java.io.Serializable serializableObject) { + return encodeObject(serializableObject, NO_OPTIONS); } // end encodeObject - /** @@ -542,83 +553,87 @@ public class Base64 * version of that serialized object. If the object * cannot be serialized or there is another error, * the method will return null. - *

+ *

* Valid options:

      *   GZIP: gzip-compresses object before encoding it.
      *   DONT_BREAK_LINES: don't break lines at 76 characters
      *     Note: Technically, this makes your encoding non-compliant.
      *
- *

+ *

* Example: encodeObject( myObj, Base64.GZIP ) or - *

+ *

* Example: encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES ) * * @param serializableObject The object to encode - * @param options Specified options + * @param options Specified options * @return The Base64-encoded object * @see Base64#GZIP * @see Base64#DONT_BREAK_LINES * @since 2.0 */ - public static String encodeObject( java.io.Serializable serializableObject, int options ) - { + public static String encodeObject(java.io.Serializable serializableObject, int options) { // Streams - java.io.ByteArrayOutputStream baos = null; - java.io.OutputStream b64os = null; - java.io.ObjectOutputStream oos = null; - java.util.zip.GZIPOutputStream gzos = null; - + java.io.ByteArrayOutputStream baos = null; + java.io.OutputStream b64os = null; + java.io.ObjectOutputStream oos = null; + java.util.zip.GZIPOutputStream gzos = null; + // Isolate options - int gzip = (options & GZIP); - - try - { + int gzip = (options & GZIP); + + try { // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream - baos = new java.io.ByteArrayOutputStream(); - b64os = new Base64.OutputStream( baos, ENCODE | options ); - + baos = new java.io.ByteArrayOutputStream(); + b64os = new Base64.OutputStream(baos, ENCODE | options); + // GZip? - if( gzip == GZIP ) - { - gzos = new java.util.zip.GZIPOutputStream( b64os ); - oos = new java.io.ObjectOutputStream( gzos ); + if (gzip == GZIP) { + gzos = new java.util.zip.GZIPOutputStream(b64os); + oos = new java.io.ObjectOutputStream(gzos); } // end if: gzip else - oos = new java.io.ObjectOutputStream( b64os ); - - oos.writeObject( serializableObject ); + oos = new java.io.ObjectOutputStream(b64os); + + oos.writeObject(serializableObject); } // end try - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { e.printStackTrace(); return null; } // end catch - finally - { - try{ if (oos != null) oos.close(); } catch( Exception e ){} - try{ if (gzos != null) gzos.close(); } catch( Exception e ){} - try{ if (b64os != null) b64os.close(); } catch( Exception e ){} - try{ if (baos != null) baos.close(); } catch( Exception e ){} + finally { + try { + if (oos != null) oos.close(); + } catch (Exception e) { + } + try { + if (gzos != null) gzos.close(); + } catch (Exception e) { + } + try { + if (b64os != null) b64os.close(); + } catch (Exception e) { + } + try { + if (baos != null) baos.close(); + } catch (Exception e) { + } } // end finally - + // Return value according to relevant encoding. - try - { - if (baos != null) { - return new String( baos.toByteArray(), PREFERRED_ENCODING ); - } + try { + if (baos != null) { + return new String(baos.toByteArray(), PREFERRED_ENCODING); + } } // end try - catch (java.io.UnsupportedEncodingException uue) - { - if (baos != null) { - return new String( baos.toByteArray() ); - } + catch (java.io.UnsupportedEncodingException uue) { + if (baos != null) { + return new String(baos.toByteArray()); + } } // end catch - + return null; } // end encode - - + /** * Encodes a byte array into Base64 notation. @@ -627,176 +642,165 @@ public class Base64 * @param source The data to convert * @since 1.4 */ - public static String encodeBytes( byte[] source ) - { - return encodeBytes( source, 0, source.length, NO_OPTIONS ); + public static String encodeBytes(byte[] source) { + return encodeBytes(source, 0, source.length, NO_OPTIONS); } // end encodeBytes - /** * Encodes a byte array into Base64 notation. - *

+ *

* Valid options:

      *   GZIP: gzip-compresses object before encoding it.
      *   DONT_BREAK_LINES: don't break lines at 76 characters
      *     Note: Technically, this makes your encoding non-compliant.
      *
- *

+ *

* Example: encodeBytes( myData, Base64.GZIP ) or - *

+ *

* Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES ) * - * - * @param source The data to convert + * @param source The data to convert * @param options Specified options * @see Base64#GZIP * @see Base64#DONT_BREAK_LINES * @since 2.0 */ - public static String encodeBytes( byte[] source, int options ) - { - return encodeBytes( source, 0, source.length, options ); + public static String encodeBytes(byte[] source, int options) { + return encodeBytes(source, 0, source.length, options); } // end encodeBytes - - + + /** * Encodes a byte array into Base64 notation. * Does not GZip-compress data. * * @param source The data to convert - * @param off Offset in array where conversion should begin - * @param len Length of data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert * @since 1.4 */ - public static String encodeBytes( byte[] source, int off, int len ) - { - return encodeBytes( source, off, len, NO_OPTIONS ); + public static String encodeBytes(byte[] source, int off, int len) { + return encodeBytes(source, off, len, NO_OPTIONS); } // end encodeBytes - - + /** * Encodes a byte array into Base64 notation. - *

+ *

* Valid options:

      *   GZIP: gzip-compresses object before encoding it.
      *   DONT_BREAK_LINES: don't break lines at 76 characters
      *     Note: Technically, this makes your encoding non-compliant.
      *
- *

+ *

* Example: encodeBytes( myData, Base64.GZIP ) or - *

+ *

* Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES ) * - * - * @param source The data to convert - * @param off Offset in array where conversion should begin - * @param len Length of data to convert + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert * @param options Specified options -- alphabet type is pulled from this (standard, url-safe, ordered) * @see Base64#GZIP * @see Base64#DONT_BREAK_LINES * @since 2.0 */ - public static String encodeBytes( byte[] source, int off, int len, int options ) - { + public static String encodeBytes(byte[] source, int off, int len, int options) { // Isolate options - int dontBreakLines = ( options & DONT_BREAK_LINES ); - int gzip = ( options & GZIP ); - + int dontBreakLines = (options & DONT_BREAK_LINES); + int gzip = (options & GZIP); + // Compress? - if( gzip == GZIP ) - { - java.io.ByteArrayOutputStream baos = null; - java.util.zip.GZIPOutputStream gzos = null; - Base64.OutputStream b64os = null; - - - try - { + if (gzip == GZIP) { + java.io.ByteArrayOutputStream baos = null; + java.util.zip.GZIPOutputStream gzos = null; + Base64.OutputStream b64os = null; + + + try { // GZip -> Base64 -> ByteArray baos = new java.io.ByteArrayOutputStream(); - b64os = new Base64.OutputStream( baos, ENCODE | options ); - gzos = new java.util.zip.GZIPOutputStream( b64os ); - - gzos.write( source, off, len ); + b64os = new Base64.OutputStream(baos, ENCODE | options); + gzos = new java.util.zip.GZIPOutputStream(b64os); + + gzos.write(source, off, len); gzos.close(); } // end try - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { e.printStackTrace(); return null; } // end catch - finally - { - try{ if (gzos != null) gzos.close(); } catch( Exception e ){} - try{ if (b64os != null) b64os.close(); } catch( Exception e ){} - try{ if (baos != null) baos.close(); } catch( Exception e ){} + finally { + try { + if (gzos != null) gzos.close(); + } catch (Exception e) { + } + try { + if (b64os != null) b64os.close(); + } catch (Exception e) { + } + try { + if (baos != null) baos.close(); + } catch (Exception e) { + } } // end finally // Return value according to relevant encoding. - try - { - if (baos != null) { - return new String( baos.toByteArray(), PREFERRED_ENCODING ); - } + try { + if (baos != null) { + return new String(baos.toByteArray(), PREFERRED_ENCODING); + } } // end try - catch (java.io.UnsupportedEncodingException uue) - { - if (baos != null) { - return new String( baos.toByteArray() ); - } + catch (java.io.UnsupportedEncodingException uue) { + if (baos != null) { + return new String(baos.toByteArray()); + } } // end catch - + return null; } // end if: compress - + // Else, don't compress. Better not to use streams at all then. - else - { + else { // Convert option to boolean in way that code likes it. boolean breakLines = dontBreakLines == 0; - - int len43 = len * 4 / 3; - byte[] outBuff = new byte[ ( len43 ) // Main 4:3 - + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding - + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines + + int len43 = len * 4 / 3; + byte[] outBuff = new byte[(len43) // Main 4:3 + + ((len % 3) > 0 ? 4 : 0) // Account for padding + + (breakLines ? (len43 / MAX_LINE_LENGTH) : 0)]; // New lines int d = 0; int e = 0; int len2 = len - 2; int lineLength = 0; - for( ; d < len2; d+=3, e+=4 ) - { - encode3to4( source, d+off, 3, outBuff, e, options ); + for (; d < len2; d += 3, e += 4) { + encode3to4(source, d + off, 3, outBuff, e, options); lineLength += 4; - if( breakLines && lineLength == MAX_LINE_LENGTH ) - { - outBuff[e+4] = NEW_LINE; + if (breakLines && lineLength == MAX_LINE_LENGTH) { + outBuff[e + 4] = NEW_LINE; e++; lineLength = 0; } // end if: end of line } // en dfor: each piece of array - if( d < len ) - { - encode3to4( source, d+off, len - d, outBuff, e, options ); + if (d < len) { + encode3to4(source, d + off, len - d, outBuff, e, options); e += 4; } // end if: some padding needed - + // Return value according to relevant encoding. - try - { - return new String( outBuff, 0, e, PREFERRED_ENCODING ); + try { + return new String(outBuff, 0, e, PREFERRED_ENCODING); } // end try - catch (java.io.UnsupportedEncodingException uue) - { - return new String( outBuff, 0, e ); + catch (java.io.UnsupportedEncodingException uue) { + return new String(outBuff, 0, e); } // end catch - + } // end else: don't compress - + } // end encodeBytes @@ -804,99 +808,92 @@ public class Base64 /* ******** D E C O D I N G M E T H O D S ******** */ - - + + /** * Decodes four bytes from array source * and writes the resulting bytes (up to three of them) * to destination. * The source and destination arrays can be manipulated - * anywhere along their length by specifying + * anywhere along their length by specifying * srcOffset and destOffset. * This method does not check to make sure your arrays * are large enough to accomodate srcOffset + 4 for * the source array or destOffset + 3 for * the destination array. - * This method returns the actual number of bytes that + * This method returns the actual number of bytes that * were converted from the Base64 encoding. - *

This is the lowest level of the decoding methods with - * all possible parameters.

- * + *

This is the lowest level of the decoding methods with + * all possible parameters.

* - * @param source the array to convert - * @param srcOffset the index where conversion begins + * @param source the array to convert + * @param srcOffset the index where conversion begins * @param destination the array to hold the conversion - * @param destOffset the index where output will be put - * @param options alphabet type is pulled from this (standard, url-safe, ordered) + * @param destOffset the index where output will be put + * @param options alphabet type is pulled from this (standard, url-safe, ordered) * @return the number of decoded bytes converted * @since 1.3 */ - private static int decode4to3( byte[] source, int srcOffset, byte[] destination, int destOffset, int options ) - { - byte[] DECODABET = getDecodabet( options ); - + private static int decode4to3(byte[] source, int srcOffset, byte[] destination, int destOffset, int options) { + byte[] DECODABET = getDecodabet(options); + // Example: Dk== - if( source[ srcOffset + 2] == EQUALS_SIGN ) - { + if (source[srcOffset + 2] == EQUALS_SIGN) { // Two ways to do the same thing. Don't know which way I like best. //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) // | ( ( DECODABET[ source[ srcOffset + 1] ] << 24 ) >>> 12 ); - int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) - | ( ( DECODABET[ source[ srcOffset + 1] ] & 0xFF ) << 12 ); - - destination[ destOffset ] = (byte)( outBuff >>> 16 ); + int outBuff = ((DECODABET[source[srcOffset]] & 0xFF) << 18) + | ((DECODABET[source[srcOffset + 1]] & 0xFF) << 12); + + destination[destOffset] = (byte) (outBuff >>> 16); return 1; } - + // Example: DkL= - else if( source[ srcOffset + 3 ] == EQUALS_SIGN ) - { + else if (source[srcOffset + 3] == EQUALS_SIGN) { // Two ways to do the same thing. Don't know which way I like best. //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ); - int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) - | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) - | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6 ); - - destination[ destOffset ] = (byte)( outBuff >>> 16 ); - destination[ destOffset + 1 ] = (byte)( outBuff >>> 8 ); + int outBuff = ((DECODABET[source[srcOffset]] & 0xFF) << 18) + | ((DECODABET[source[srcOffset + 1]] & 0xFF) << 12) + | ((DECODABET[source[srcOffset + 2]] & 0xFF) << 6); + + destination[destOffset] = (byte) (outBuff >>> 16); + destination[destOffset + 1] = (byte) (outBuff >>> 8); return 2; } - + // Example: DkLE - else - { - try{ - // Two ways to do the same thing. Don't know which way I like best. - //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) - // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) - // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ) - // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 ); - int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) - | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) - | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6) - | ( ( DECODABET[ source[ srcOffset + 3 ] ] & 0xFF ) ); + else { + try { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) + // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ) + // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 ); + int outBuff = ((DECODABET[source[srcOffset]] & 0xFF) << 18) + | ((DECODABET[source[srcOffset + 1]] & 0xFF) << 12) + | ((DECODABET[source[srcOffset + 2]] & 0xFF) << 6) + | ((DECODABET[source[srcOffset + 3]] & 0xFF)); - - destination[ destOffset ] = (byte)( outBuff >> 16 ); - destination[ destOffset + 1 ] = (byte)( outBuff >> 8 ); - destination[ destOffset + 2 ] = (byte)( outBuff ); - return 3; - }catch( Exception e){ - System.out.println(""+source[srcOffset]+ ": " + ( DECODABET[ source[ srcOffset ] ] ) ); - System.out.println(""+source[srcOffset+1]+ ": " + ( DECODABET[ source[ srcOffset + 1 ] ] ) ); - System.out.println(""+source[srcOffset+2]+ ": " + ( DECODABET[ source[ srcOffset + 2 ] ] ) ); - System.out.println(""+source[srcOffset+3]+ ": " + ( DECODABET[ source[ srcOffset + 3 ] ] ) ); + destination[destOffset] = (byte) (outBuff >> 16); + destination[destOffset + 1] = (byte) (outBuff >> 8); + destination[destOffset + 2] = (byte) (outBuff); + + return 3; + } catch (Exception e) { + System.out.println("" + source[srcOffset] + ": " + (DECODABET[source[srcOffset]])); + System.out.println("" + source[srcOffset + 1] + ": " + (DECODABET[source[srcOffset + 1]])); + System.out.println("" + source[srcOffset + 2] + ": " + (DECODABET[source[srcOffset + 2]])); + System.out.println("" + source[srcOffset + 3] + ": " + (DECODABET[source[srcOffset + 3]])); return -1; } // end catch } } // end decodeToBytes - - - - + + /** * Very low-level access to decoding ASCII characters in * the form of a byte array. Does not support automatically @@ -908,57 +905,50 @@ public class Base64 * @return decoded data * @since 1.3 */ - public static byte[] decode( byte[] source, int off, int len, int options ) - { - byte[] DECODABET = getDecodabet( options ); - - int len34 = len * 3 / 4; - byte[] outBuff = new byte[ len34 ]; // Upper limit on size of output - int outBuffPosn = 0; - - byte[] b4 = new byte[4]; - int b4Posn = 0; - int i = 0; - byte sbiCrop = 0; - byte sbiDecode = 0; - for( i = off; i < off+len; i++ ) - { - sbiCrop = (byte)(source[i] & 0x7f); // Only the low seven bits - sbiDecode = DECODABET[ sbiCrop ]; - - if( sbiDecode >= WHITE_SPACE_ENC ) // White space, Equals sign or better + public static byte[] decode(byte[] source, int off, int len, int options) { + byte[] DECODABET = getDecodabet(options); + + int len34 = len * 3 / 4; + byte[] outBuff = new byte[len34]; // Upper limit on size of output + int outBuffPosn = 0; + + byte[] b4 = new byte[4]; + int b4Posn = 0; + int i = 0; + byte sbiCrop = 0; + byte sbiDecode = 0; + for (i = off; i < off + len; i++) { + sbiCrop = (byte) (source[i] & 0x7f); // Only the low seven bits + sbiDecode = DECODABET[sbiCrop]; + + if (sbiDecode >= WHITE_SPACE_ENC) // White space, Equals sign or better { - if( sbiDecode >= EQUALS_SIGN_ENC ) - { - b4[ b4Posn++ ] = sbiCrop; - if( b4Posn > 3 ) - { - outBuffPosn += decode4to3( b4, 0, outBuff, outBuffPosn, options ); + if (sbiDecode >= EQUALS_SIGN_ENC) { + b4[b4Posn++] = sbiCrop; + if (b4Posn > 3) { + outBuffPosn += decode4to3(b4, 0, outBuff, outBuffPosn, options); b4Posn = 0; - + // If that was the equals sign, break out of 'for' loop - if( sbiCrop == EQUALS_SIGN ) + if (sbiCrop == EQUALS_SIGN) break; } // end if: quartet built - + } // end if: equals sign or better - + } // end if: white space, equals sign or better - else - { - System.err.println( "Bad Base64 input character at " + i + ": " + source[i] + "(decimal)" ); + else { + System.err.println("Bad Base64 input character at " + i + ": " + source[i] + "(decimal)"); return null; } // end else: } // each input character - - byte[] out = new byte[ outBuffPosn ]; - System.arraycopy( outBuff, 0, out, 0, outBuffPosn ); + + byte[] out = new byte[outBuffPosn]; + System.arraycopy(outBuff, 0, out, 0, outBuffPosn); return out; } // end decode - - - - + + /** * Decodes data from Base64 notation, automatically * detecting gzip-compressed data and decompressing it. @@ -967,87 +957,84 @@ public class Base64 * @return the decoded data * @since 1.4 */ - public static byte[] decode( String s ) - { - return decode( s, NO_OPTIONS ); - } - - + public static byte[] decode(String s) { + return decode(s, NO_OPTIONS); + } + + /** * Decodes data from Base64 notation, automatically * detecting gzip-compressed data and decompressing it. * - * @param s the string to decode - * @param options encode options such as URL_SAFE + * @param s the string to decode + * @param options encode options such as URL_SAFE * @return the decoded data * @since 1.4 */ - public static byte[] decode( String s, int options ) - { + public static byte[] decode(String s, int options) { byte[] bytes; - try - { - bytes = s.getBytes( PREFERRED_ENCODING ); + try { + bytes = s.getBytes(PREFERRED_ENCODING); } // end try - catch( java.io.UnsupportedEncodingException uee ) - { + catch (java.io.UnsupportedEncodingException uee) { bytes = s.getBytes(); } // end catch - // - + // + // Decode - bytes = decode( bytes, 0, bytes.length, options ); - - + bytes = decode(bytes, 0, bytes.length, options); + + // Check to see if it's gzip-compressed // GZIP Magic Two-Byte Number: 0x8b1f (35615) - if( bytes != null && bytes.length >= 4 ) - { - - int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00); - if( java.util.zip.GZIPInputStream.GZIP_MAGIC == head ) - { - java.io.ByteArrayInputStream bais = null; + if (bytes != null && bytes.length >= 4) { + + int head = ((int) bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00); + if (java.util.zip.GZIPInputStream.GZIP_MAGIC == head) { + java.io.ByteArrayInputStream bais = null; java.util.zip.GZIPInputStream gzis = null; java.io.ByteArrayOutputStream baos = null; byte[] buffer = new byte[2048]; - int length = 0; + int length = 0; - try - { + try { baos = new java.io.ByteArrayOutputStream(); - bais = new java.io.ByteArrayInputStream( bytes ); - gzis = new java.util.zip.GZIPInputStream( bais ); + bais = new java.io.ByteArrayInputStream(bytes); + gzis = new java.util.zip.GZIPInputStream(bais); - while( ( length = gzis.read( buffer ) ) >= 0 ) - { - baos.write(buffer,0,length); + while ((length = gzis.read(buffer)) >= 0) { + baos.write(buffer, 0, length); } // end while: reading input // No error? Get new bytes. bytes = baos.toByteArray(); } // end try - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { // Just return originally-decoded bytes } // end catch - finally - { - try{ if (baos != null) baos.close(); } catch( Exception e ){} - try{ if (gzis != null) gzis.close(); } catch( Exception e ){} - try{ if (bais != null) bais.close(); } catch( Exception e ){} + finally { + try { + if (baos != null) baos.close(); + } catch (Exception e) { + } + try { + if (gzis != null) gzis.close(); + } catch (Exception e) { + } + try { + if (bais != null) bais.close(); + } catch (Exception e) { + } } // end finally } // end if: gzipped } // end if: bytes.length >= 2 - + return bytes; } // end decode - - /** * Attempts to decode Base64 data and deserialize a Java * Object within. Returns null if there was an error. @@ -1056,295 +1043,289 @@ public class Base64 * @return The decoded and deserialized object * @since 1.5 */ - public static Object decodeToObject( String encodedObject ) - { + public static Object decodeToObject(String encodedObject) { // Decode and gunzip if necessary - byte[] objBytes = decode( encodedObject ); - - java.io.ByteArrayInputStream bais = null; - java.io.ObjectInputStream ois = null; + byte[] objBytes = decode(encodedObject); + + java.io.ByteArrayInputStream bais = null; + java.io.ObjectInputStream ois = null; Object obj = null; - - try - { - bais = new java.io.ByteArrayInputStream( objBytes ); - ois = new java.io.ObjectInputStream( bais ); - + + try { + bais = new java.io.ByteArrayInputStream(objBytes); + ois = new java.io.ObjectInputStream(bais); + obj = ois.readObject(); } // end try - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { e.printStackTrace(); obj = null; } // end catch - catch( java.lang.ClassNotFoundException e ) - { + catch (java.lang.ClassNotFoundException e) { e.printStackTrace(); obj = null; } // end catch - finally - { - try{ if (bais != null) bais.close(); } catch( Exception e ){} - try{ if (ois != null) ois.close(); } catch( Exception e ){} + finally { + try { + if (bais != null) bais.close(); + } catch (Exception e) { + } + try { + if (ois != null) ois.close(); + } catch (Exception e) { + } } // end finally - + return obj; } // end decodeObject - - - + + /** * Convenience method for encoding data to a file. * * @param dataToEncode byte array of data to encode in base64 form - * @param filename Filename for saving encoded data + * @param filename Filename for saving encoded data * @return true if successful, false otherwise - * * @since 2.1 */ - public static boolean encodeToFile( byte[] dataToEncode, String filename ) - { + public static boolean encodeToFile(byte[] dataToEncode, String filename) { boolean success = false; Base64.OutputStream bos = null; - try - { - bos = new Base64.OutputStream( - new java.io.FileOutputStream( filename ), Base64.ENCODE ); - bos.write( dataToEncode ); + try { + bos = new Base64.OutputStream( + new java.io.FileOutputStream(filename), Base64.ENCODE); + bos.write(dataToEncode); success = true; } // end try - catch( java.io.IOException e ) - { - + catch (java.io.IOException e) { + success = false; } // end catch: IOException - finally - { - try{ if (bos != null) bos.close(); } catch( Exception e ){} + finally { + try { + if (bos != null) bos.close(); + } catch (Exception e) { + } } // end finally - + return success; } // end encodeToFile - - + + /** * Convenience method for decoding data to a file. * * @param dataToDecode Base64-encoded data as a string - * @param filename Filename for saving decoded data + * @param filename Filename for saving decoded data * @return true if successful, false otherwise - * * @since 2.1 */ - public static boolean decodeToFile( String dataToDecode, String filename ) - { + public static boolean decodeToFile(String dataToDecode, String filename) { boolean success = false; Base64.OutputStream bos = null; - try - { - bos = new Base64.OutputStream( - new java.io.FileOutputStream( filename ), Base64.DECODE ); - bos.write( dataToDecode.getBytes( PREFERRED_ENCODING ) ); - success = true; + try { + bos = new Base64.OutputStream( + new java.io.FileOutputStream(filename), Base64.DECODE); + bos.write(dataToDecode.getBytes(PREFERRED_ENCODING)); + success = true; } // end try - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { success = false; } // end catch: IOException - finally - { - try{ if (bos != null) bos.close(); } catch( Exception e ){} + finally { + try { + if (bos != null) bos.close(); + } catch (Exception e) { + } } // end finally - + return success; } // end decodeToFile - - - - + + /** * Convenience method for reading a base64-encoded * file and decoding it. * * @param filename Filename for reading encoded data * @return decoded byte array or null if unsuccessful - * * @since 2.1 */ - public static byte[] decodeFromFile( String filename ) - { + public static byte[] decodeFromFile(String filename) { byte[] decodedData = null; Base64.InputStream bis = null; - try - { + try { // Set up some useful variables - java.io.File file = new java.io.File( filename ); + java.io.File file = new java.io.File(filename); byte[] buffer = null; - int length = 0; + int length = 0; int numBytes = 0; - + // Check for size of file - if( file.length() > Integer.MAX_VALUE ) - { - System.err.println( "File is too big for this convenience method (" + file.length() + " bytes)." ); + if (file.length() > Integer.MAX_VALUE) { + System.err.println("File is too big for this convenience method (" + file.length() + " bytes)."); return null; } // end if: file too big for int index - buffer = new byte[ (int)file.length() ]; - + buffer = new byte[(int) file.length()]; + // Open a stream - bis = new Base64.InputStream( - new java.io.BufferedInputStream( - new java.io.FileInputStream( file ) ), Base64.DECODE ); - + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream(file)), Base64.DECODE); + // Read until done - while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) + while ((numBytes = bis.read(buffer, length, 4096)) >= 0) length += numBytes; - + // Save in a variable to return - decodedData = new byte[ length ]; - System.arraycopy( buffer, 0, decodedData, 0, length ); - + decodedData = new byte[length]; + System.arraycopy(buffer, 0, decodedData, 0, length); + } // end try - catch( java.io.IOException e ) - { - System.err.println( "Error decoding from file " + filename ); + catch (java.io.IOException e) { + System.err.println("Error decoding from file " + filename); } // end catch: IOException - finally - { - try{ if (bis != null) bis.close(); } catch( Exception e) {} + finally { + try { + if (bis != null) bis.close(); + } catch (Exception e) { + } } // end finally - + return decodedData; } // end decodeFromFile - - - + + /** * Convenience method for reading a binary file * and base64-encoding it. * * @param filename Filename for reading binary data * @return base64-encoded string or null if unsuccessful - * * @since 2.1 */ - public static String encodeFromFile( String filename ) - { + public static String encodeFromFile(String filename) { String encodedData = null; Base64.InputStream bis = null; - try - { + try { // Set up some useful variables - java.io.File file = new java.io.File( filename ); - byte[] buffer = new byte[ Math.max((int)(file.length() * 1.4),40) ]; // Need max() for math on small files (v2.2.1) - int length = 0; + java.io.File file = new java.io.File(filename); + byte[] buffer = new byte[Math.max((int) (file.length() * 1.4), 40)]; // Need max() for math on small files (v2.2.1) + int length = 0; int numBytes = 0; - + // Open a stream - bis = new Base64.InputStream( - new java.io.BufferedInputStream( - new java.io.FileInputStream( file ) ), Base64.ENCODE ); - + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream(file)), Base64.ENCODE); + // Read until done - while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) + while ((numBytes = bis.read(buffer, length, 4096)) >= 0) length += numBytes; - + // Save in a variable to return - encodedData = new String( buffer, 0, length, Base64.PREFERRED_ENCODING ); - + encodedData = new String(buffer, 0, length, Base64.PREFERRED_ENCODING); + } // end try - catch( java.io.IOException e ) - { - System.err.println( "Error encoding from file " + filename ); + catch (java.io.IOException e) { + System.err.println("Error encoding from file " + filename); } // end catch: IOException - finally - { - try{ if (bis != null) bis.close(); } catch( Exception e) {} + finally { + try { + if (bis != null) bis.close(); + } catch (Exception e) { + } } // end finally - + return encodedData; - } // end encodeFromFile - - - - + } // end encodeFromFile + + /** * Reads infile and encodes it to outfile. * - * @param infile Input file + * @param infile Input file * @param outfile Output file * @return true if the operation is successful * @since 2.2 */ - public static boolean encodeFileToFile( String infile, String outfile ) - { + public static boolean encodeFileToFile(String infile, String outfile) { boolean success = false; java.io.InputStream in = null; java.io.OutputStream out = null; - try{ - in = new Base64.InputStream( - new java.io.BufferedInputStream( - new java.io.FileInputStream( infile ) ), - Base64.ENCODE ); - out = new java.io.BufferedOutputStream( new java.io.FileOutputStream( outfile ) ); + try { + in = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream(infile)), + Base64.ENCODE); + out = new java.io.BufferedOutputStream(new java.io.FileOutputStream(outfile)); byte[] buffer = new byte[65536]; // 64K int read = -1; - while( ( read = in.read(buffer) ) >= 0 ){ - out.write( buffer,0,read ); + while ((read = in.read(buffer)) >= 0) { + out.write(buffer, 0, read); } // end while: through file success = true; - } catch( java.io.IOException exc ){ + } catch (java.io.IOException exc) { exc.printStackTrace(); - } finally{ - try{ if (in != null) in.close(); } catch( Exception exc ){} - try{ if (out != null) out.close(); } catch( Exception exc ){} + } finally { + try { + if (in != null) in.close(); + } catch (Exception exc) { + } + try { + if (out != null) out.close(); + } catch (Exception exc) { + } } // end finally - + return success; } // end encodeFileToFile - - - + + /** * Reads infile and decodes it to outfile. * - * @param infile Input file + * @param infile Input file * @param outfile Output file * @return true if the operation is successful * @since 2.2 */ - public static boolean decodeFileToFile( String infile, String outfile ) - { + public static boolean decodeFileToFile(String infile, String outfile) { boolean success = false; java.io.InputStream in = null; java.io.OutputStream out = null; - try{ - in = new Base64.InputStream( - new java.io.BufferedInputStream( - new java.io.FileInputStream( infile ) ), - Base64.DECODE ); - out = new java.io.BufferedOutputStream( new java.io.FileOutputStream( outfile ) ); + try { + in = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream(infile)), + Base64.DECODE); + out = new java.io.BufferedOutputStream(new java.io.FileOutputStream(outfile)); byte[] buffer = new byte[65536]; // 64K int read = -1; - while( ( read = in.read(buffer) ) >= 0 ){ - out.write( buffer,0,read ); + while ((read = in.read(buffer)) >= 0) { + out.write(buffer, 0, read); } // end while: through file success = true; - } catch( java.io.IOException exc ){ + } catch (java.io.IOException exc) { exc.printStackTrace(); - } finally{ - try{ if (in != null) in.close(); } catch( Exception exc ){} - try{ if (out != null) out.close(); } catch( Exception exc ){} + } finally { + try { + if (in != null) in.close(); + } catch (Exception exc) { + } + try { + if (out != null) out.close(); + } catch (Exception exc) { + } } // end finally - + return success; } // end decodeFileToFile /* ******** I N N E R C L A S S I N P U T S T R E A M ******** */ - - - + + /** * A {@link Base64.InputStream} will read data from another * java.io.InputStream, given in the constructor, @@ -1353,65 +1334,61 @@ public class Base64 * @see Base64 * @since 1.3 */ - public static class InputStream extends java.io.FilterInputStream - { + public static class InputStream extends java.io.FilterInputStream { private boolean encode; // Encoding or decoding - private int position; // Current position in the buffer - private byte[] buffer; // Small buffer holding converted data - private int bufferLength; // Length of buffer (3 or 4) - private int numSigBytes; // Number of meaningful bytes in the buffer - private int lineLength; + private int position; // Current position in the buffer + private byte[] buffer; // Small buffer holding converted data + private int bufferLength; // Length of buffer (3 or 4) + private int numSigBytes; // Number of meaningful bytes in the buffer + private int lineLength; private boolean breakLines; // Break lines at less than 80 characters - private int options; // Record options used to create the stream. - private byte[] decodabet; // Local copies to avoid extra method calls - - + private int options; // Record options used to create the stream. + private byte[] decodabet; // Local copies to avoid extra method calls + + /** * Constructs a {@link Base64.InputStream} in DECODE mode. * * @param in the java.io.InputStream from which to read data. * @since 1.3 */ - public InputStream( java.io.InputStream in ) - { - this( in, DECODE ); + public InputStream(java.io.InputStream in) { + this(in, DECODE); } // end constructor - - + + /** * Constructs a {@link Base64.InputStream} in * either ENCODE or DECODE mode. - *

+ *

* Valid options:

          *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DONT_BREAK_LINES: don't break lines at 76 characters
          *     (only meaningful when encoding)
          *     Note: Technically, this makes your encoding non-compliant.
          *
- *

+ *

* Example: new Base64.InputStream( in, Base64.DECODE ) * - * - * @param in the java.io.InputStream from which to read data. + * @param in the java.io.InputStream from which to read data. * @param options Specified options * @see Base64#ENCODE * @see Base64#DECODE * @see Base64#DONT_BREAK_LINES * @since 2.0 */ - public InputStream( java.io.InputStream in, int options ) - { - super( in ); - this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; - this.encode = (options & ENCODE) == ENCODE; + public InputStream(java.io.InputStream in, int options) { + super(in); + this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; + this.encode = (options & ENCODE) == ENCODE; this.bufferLength = this.encode ? 4 : 3; - this.buffer = new byte[ this.bufferLength ]; - this.position = -1; - this.lineLength = 0; - this.options = options; // Record for later, mostly to determine which alphabet to use - this.decodabet = getDecodabet(options); + this.buffer = new byte[this.bufferLength]; + this.position = -1; + this.lineLength = 0; + this.options = options; // Record for later, mostly to determine which alphabet to use + this.decodabet = getDecodabet(options); } // end constructor - + /** * Reads enough of the input stream to convert * to/from Base64 and returns the next byte. @@ -1419,122 +1396,107 @@ public class Base64 * @return next byte * @since 1.3 */ - public int read() throws java.io.IOException - { + public int read() throws java.io.IOException { // Do we need to get data? - if( this.position < 0 ) - { - if( this.encode ) - { + if (this.position < 0) { + if (this.encode) { byte[] b3 = new byte[3]; int numBinaryBytes = 0; - for( int i = 0; i < 3; i++ ) - { - try - { + for (int i = 0; i < 3; i++) { + try { int b = this.in.read(); - + // If end of stream, b is -1. - if( b >= 0 ) - { - b3[i] = (byte)b; + if (b >= 0) { + b3[i] = (byte) b; numBinaryBytes++; } // end if: not end of stream - + } // end try: read - catch( java.io.IOException e ) - { + catch (java.io.IOException e) { // Only a problem if we got no data at all. - if( i == 0 ) + if (i == 0) throw e; - + } // end catch } // end for: each needed input byte - - if( numBinaryBytes > 0 ) - { - encode3to4( b3, 0, numBinaryBytes, this.buffer, 0, this.options ); + + if (numBinaryBytes > 0) { + encode3to4(b3, 0, numBinaryBytes, this.buffer, 0, this.options); this.position = 0; this.numSigBytes = 4; } // end if: got data - else - { + else { return -1; } // end else } // end if: encoding - + // Else decoding - else - { + else { byte[] b4 = new byte[4]; int i = 0; - for( i = 0; i < 4; i++ ) - { + for (i = 0; i < 4; i++) { // Read four "meaningful" bytes: int b = 0; - do{ b = this.in.read(); } - while( b >= 0 && this.decodabet[ b & 0x7f ] <= WHITE_SPACE_ENC ); - - if( b < 0 ) + do { + b = this.in.read(); + } + while (b >= 0 && this.decodabet[b & 0x7f] <= WHITE_SPACE_ENC); + + if (b < 0) break; // Reads a -1 if end of stream - - b4[i] = (byte)b; + + b4[i] = (byte) b; } // end for: each needed input byte - - if( i == 4 ) - { - this.numSigBytes = decode4to3( b4, 0, this.buffer, 0, this.options ); + + if (i == 4) { + this.numSigBytes = decode4to3(b4, 0, this.buffer, 0, this.options); this.position = 0; } // end if: got four characters - else if( i == 0 ){ + else if (i == 0) { return -1; } // end else if: also padded correctly - else - { + else { // Must have broken out from above. - throw new java.io.IOException( "Improperly padded Base64 input." ); + throw new java.io.IOException("Improperly padded Base64 input."); } // end - + } // end else: decode } // end else: get data - + // Got data? - if( this.position >= 0 ) - { + if (this.position >= 0) { // End of relevant data? - if( /*!encode &&*/ this.position >= this.numSigBytes ) + if ( /*!encode &&*/ this.position >= this.numSigBytes) return -1; - - if( this.encode && this.breakLines && this.lineLength >= MAX_LINE_LENGTH ) - { - this.lineLength = 0; + + if (this.encode && this.breakLines && this.lineLength >= MAX_LINE_LENGTH) { + this.lineLength = 0; return '\n'; } // end if - else - { - this.lineLength++; // This isn't important when decoding - // but throwing an extra "if" seems - // just as wasteful. - - int b = this.buffer[ this.position++ ]; + else { + this.lineLength++; // This isn't important when decoding + // but throwing an extra "if" seems + // just as wasteful. - if( this.position >= this.bufferLength ) - this.position = -1; + int b = this.buffer[this.position++]; + + if (this.position >= this.bufferLength) + this.position = -1; return b & 0xFF; // This is how you "cast" a byte that's - // intended to be unsigned. + // intended to be unsigned. } // end else } // end if: position >= 0 - + // Else error - else - { + else { // When JDK1.4 is more accepted, use an assertion here. - throw new java.io.IOException( "Error in Base64 code reading stream." ); + throw new java.io.IOException("Error in Base64 code reading stream."); } // end else } // end read - - + + /** * Calls {@link #read()} repeatedly until the end of stream * is reached or len bytes are read. @@ -1542,32 +1504,30 @@ public class Base64 * end of stream is encountered. * * @param dest array to hold values - * @param off offset for array - * @param len max number of bytes to read into array + * @param off offset for array + * @param len max number of bytes to read into array * @return bytes read into array or -1 if end of stream is encountered. * @since 1.3 */ - public int read( byte[] dest, int off, int len ) throws java.io.IOException - { + public int read(byte[] dest, int off, int len) throws java.io.IOException { int i; int b; - for( i = 0; i < len; i++ ) - { + for (i = 0; i < len; i++) { b = read(); - + //if( b < 0 && i == 0 ) // return -1; - - if( b >= 0 ) - dest[off + i] = (byte)b; - else if( i == 0 ) + + if (b >= 0) + dest[off + i] = (byte) b; + else if (i == 0) return -1; else break; // Out of 'for' loop } // end for: each byte read return i; } // end read - + } // end inner class InputStream @@ -1576,9 +1536,8 @@ public class Base64 /* ******** I N N E R C L A S S O U T P U T S T R E A M ******** */ - - - + + /** * A {@link Base64.OutputStream} will write data to another * java.io.OutputStream, given in the constructor, @@ -1587,67 +1546,64 @@ public class Base64 * @see Base64 * @since 1.3 */ - public static class OutputStream extends java.io.FilterOutputStream - { + public static class OutputStream extends java.io.FilterOutputStream { private boolean encode; - private int position; - private byte[] buffer; - private int bufferLength; - private int lineLength; + private int position; + private byte[] buffer; + private int bufferLength; + private int lineLength; private boolean breakLines; - private byte[] b4; // Scratch used in a few places + private byte[] b4; // Scratch used in a few places private boolean suspendEncoding; - private int options; // Record for later - private byte[] decodabet; // Local copies to avoid extra method calls - + private int options; // Record for later + private byte[] decodabet; // Local copies to avoid extra method calls + /** * Constructs a {@link Base64.OutputStream} in ENCODE mode. * * @param out the java.io.OutputStream to which data will be written. * @since 1.3 */ - public OutputStream( java.io.OutputStream out ) - { - this( out, ENCODE ); + public OutputStream(java.io.OutputStream out) { + this(out, ENCODE); } // end constructor - - + + /** * Constructs a {@link Base64.OutputStream} in * either ENCODE or DECODE mode. - *

+ *

* Valid options:

          *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DONT_BREAK_LINES: don't break lines at 76 characters
          *     (only meaningful when encoding)
          *     Note: Technically, this makes your encoding non-compliant.
          *
- *

+ *

* Example: new Base64.OutputStream( out, Base64.ENCODE ) * - * @param out the java.io.OutputStream to which data will be written. + * @param out the java.io.OutputStream to which data will be written. * @param options Specified options. * @see Base64#ENCODE * @see Base64#DECODE * @see Base64#DONT_BREAK_LINES * @since 1.3 */ - public OutputStream( java.io.OutputStream out, int options ) - { - super( out ); - this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; - this.encode = (options & ENCODE) == ENCODE; + public OutputStream(java.io.OutputStream out, int options) { + super(out); + this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; + this.encode = (options & ENCODE) == ENCODE; this.bufferLength = this.encode ? 3 : 4; - this.buffer = new byte[ this.bufferLength ]; - this.position = 0; - this.lineLength = 0; + this.buffer = new byte[this.bufferLength]; + this.position = 0; + this.lineLength = 0; this.suspendEncoding = false; - this.b4 = new byte[4]; - this.options = options; - this.decodabet = getDecodabet(options); + this.b4 = new byte[4]; + this.options = options; + this.decodabet = getDecodabet(options); } // end constructor - - + + /** * Writes the byte to the output stream after * converting to/from Base64 notation. @@ -1660,28 +1616,24 @@ public class Base64 * @param theByte the byte to write * @since 1.3 */ - public void write(int theByte) throws java.io.IOException - { + public void write(int theByte) throws java.io.IOException { // Encoding suspended? - if( this.suspendEncoding ) - { - super.out.write( theByte ); + if (this.suspendEncoding) { + super.out.write(theByte); return; } // end if: supsended - - // Encode? - if( this.encode ) - { - this.buffer[ this.position++ ] = (byte)theByte; - if( this.position >= this.bufferLength ) // Enough to encode. - { - this.out.write( encode3to4( this.b4, this.buffer, this.bufferLength, this.options ) ); - this.lineLength += 4; - if( this.breakLines && this.lineLength >= MAX_LINE_LENGTH ) - { - this.out.write( NEW_LINE ); - this.lineLength = 0; + // Encode? + if (this.encode) { + this.buffer[this.position++] = (byte) theByte; + if (this.position >= this.bufferLength) // Enough to encode. + { + this.out.write(encode3to4(this.b4, this.buffer, this.bufferLength, this.options)); + + this.lineLength += 4; + if (this.breakLines && this.lineLength >= MAX_LINE_LENGTH) { + this.out.write(NEW_LINE); + this.lineLength = 0; } // end if: end of line this.position = 0; @@ -1689,98 +1641,84 @@ public class Base64 } // end if: encoding // Else, Decoding - else - { + else { // Meaningful Base64 character? - if( this.decodabet[ theByte & 0x7f ] > WHITE_SPACE_ENC ) - { - this.buffer[ this.position++ ] = (byte)theByte; - if( this.position >= this.bufferLength ) // Enough to output. + if (this.decodabet[theByte & 0x7f] > WHITE_SPACE_ENC) { + this.buffer[this.position++] = (byte) theByte; + if (this.position >= this.bufferLength) // Enough to output. { - int len = Base64.decode4to3( this.buffer, 0, this.b4, 0, this.options ); - this.out.write( this.b4, 0, len ); + int len = Base64.decode4to3(this.buffer, 0, this.b4, 0, this.options); + this.out.write(this.b4, 0, len); //out.write( Base64.decode4to3( buffer ) ); this.position = 0; } // end if: enough to output } // end if: meaningful base64 character - else if( this.decodabet[ theByte & 0x7f ] != WHITE_SPACE_ENC ) - { - throw new java.io.IOException( "Invalid character in Base64 data." ); + else if (this.decodabet[theByte & 0x7f] != WHITE_SPACE_ENC) { + throw new java.io.IOException("Invalid character in Base64 data."); } // end else: not white space either } // end else: decoding } // end write - - - + + /** - * Calls {@link #write(int)} repeatedly until len + * Calls {@link #write(int)} repeatedly until len * bytes are written. * * @param theBytes array from which to read bytes - * @param off offset for array - * @param len max number of bytes to read into array + * @param off offset for array + * @param len max number of bytes to read into array * @since 1.3 */ - public void write( byte[] theBytes, int off, int len ) throws java.io.IOException - { + public void write(byte[] theBytes, int off, int len) throws java.io.IOException { // Encoding suspended? - if( this.suspendEncoding ) - { - super.out.write( theBytes, off, len ); + if (this.suspendEncoding) { + super.out.write(theBytes, off, len); return; } // end if: supsended - - for( int i = 0; i < len; i++ ) - { - write( theBytes[ off + i ] ); + + for (int i = 0; i < len; i++) { + write(theBytes[off + i]); } // end for: each byte written - + } // end write - - - + + /** * Method added by PHIL. [Thanks, PHIL. -Rob] * This pads the buffer without closing the stream. */ - public void flushBase64() throws java.io.IOException - { - if( this.position > 0 ) - { - if( this.encode ) - { - this.out.write( encode3to4( this.b4, this.buffer, this.position, this.options ) ); + public void flushBase64() throws java.io.IOException { + if (this.position > 0) { + if (this.encode) { + this.out.write(encode3to4(this.b4, this.buffer, this.position, this.options)); this.position = 0; } // end if: encoding - else - { - throw new java.io.IOException( "Base64 input not properly padded." ); + else { + throw new java.io.IOException("Base64 input not properly padded."); } // end else: decoding } // end if: buffer partially full } // end flush - - /** - * Flushes and closes (I think, in the superclass) the stream. + + /** + * Flushes and closes (I think, in the superclass) the stream. * * @since 1.3 */ - public void close() throws java.io.IOException - { + public void close() throws java.io.IOException { // 1. Ensure that pending characters are written flushBase64(); // 2. Actually close the stream // Base class both flushes and closes. super.close(); - + this.buffer = null; - this.out = null; + this.out = null; } // end close - - - + + /** * Suspends encoding of the stream. * May be helpful if you need to embed a piece of @@ -1788,13 +1726,12 @@ public class Base64 * * @since 1.5.1 */ - public void suspendEncoding() throws java.io.IOException - { + public void suspendEncoding() throws java.io.IOException { flushBase64(); this.suspendEncoding = true; } // end suspendEncoding - - + + /** * Resumes encoding of the stream. * May be helpful if you need to embed a piece of @@ -1802,14 +1739,12 @@ public class Base64 * * @since 1.5.1 */ - public void resumeEncoding() - { + public void resumeEncoding() { this.suspendEncoding = false; } // end resumeEncoding - - - + + } // end inner class OutputStream - - + + } // end class Base64 diff --git a/src/main/java/org/graylog2/syslog4j/util/OSDetectUtility.java b/src/main/java/org/graylog2/syslog4j/util/OSDetectUtility.java index 9fe1cbc..9c5b51f 100644 --- a/src/main/java/org/graylog2/syslog4j/util/OSDetectUtility.java +++ b/src/main/java/org/graylog2/syslog4j/util/OSDetectUtility.java @@ -1,77 +1,77 @@ package org.graylog2.syslog4j.util; /** -* OSDetectUtility provides operating system detection used to determine -* whether Syslog4j is running on a Unix platform. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: OSDetectUtility.java,v 1.4 2008/11/14 04:31:59 cvs Exp $ -*/ + * OSDetectUtility provides operating system detection used to determine + * whether Syslog4j is running on a Unix platform. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: OSDetectUtility.java,v 1.4 2008/11/14 04:31:59 cvs Exp $ + */ public final class OSDetectUtility { - private final static String[] UNIX_PLATFORMS = { - "Linux", - "Mac OS", - "Solaris", - "SunOS", - "MPE/iX", - "HP-UX", - "AIX", - "OS/390", - "FreeBSD", - "Irix", - "Digital Unix", - "FreeBSD", - "OSF1", - "OpenVMS" - }; + private final static String[] UNIX_PLATFORMS = { + "Linux", + "Mac OS", + "Solaris", + "SunOS", + "MPE/iX", + "HP-UX", + "AIX", + "OS/390", + "FreeBSD", + "Irix", + "Digital Unix", + "FreeBSD", + "OSF1", + "OpenVMS" + }; - private final static String[] WINDOWS_PLATFORMS = { - "Windows", - "OS/2" - }; - - private static boolean UNIX = false; - private static boolean WINDOWS = false; - - private OSDetectUtility() { - // - } - - private static boolean isMatch(String[] platforms) { - boolean match = false; - - String osName = System.getProperty("os.name"); - - if (osName != null && !"".equals(osName.trim())) { - osName = osName.toLowerCase(); - - for(int i=0; i -1) { - match = true; - break; - } - } - } - - return match; - } + private final static String[] WINDOWS_PLATFORMS = { + "Windows", + "OS/2" + }; - static { - UNIX = isMatch(UNIX_PLATFORMS); - WINDOWS = isMatch(WINDOWS_PLATFORMS); - } - - public static boolean isUnix() { - return UNIX; - } + private static boolean UNIX = false; + private static boolean WINDOWS = false; - public static boolean isWindows() { - return WINDOWS; - } + private OSDetectUtility() { + // + } + + private static boolean isMatch(String[] platforms) { + boolean match = false; + + String osName = System.getProperty("os.name"); + + if (osName != null && !"".equals(osName.trim())) { + osName = osName.toLowerCase(); + + for (int i = 0; i < platforms.length; i++) { + String platform = platforms[i].toLowerCase(); + + if (osName.indexOf(platform) > -1) { + match = true; + break; + } + } + } + + return match; + } + + static { + UNIX = isMatch(UNIX_PLATFORMS); + WINDOWS = isMatch(WINDOWS_PLATFORMS); + } + + public static boolean isUnix() { + return UNIX; + } + + public static boolean isWindows() { + return WINDOWS; + } } diff --git a/src/main/java/org/graylog2/syslog4j/util/SyslogUtility.java b/src/main/java/org/graylog2/syslog4j/util/SyslogUtility.java index 9794fd0..277208b 100644 --- a/src/main/java/org/graylog2/syslog4j/util/SyslogUtility.java +++ b/src/main/java/org/graylog2/syslog4j/util/SyslogUtility.java @@ -9,200 +9,259 @@ import org.graylog2.syslog4j.SyslogConstants; import org.graylog2.syslog4j.SyslogRuntimeException; /** -* SyslogUtility provides several common utility methods used within -* Syslog4j. -* -*

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy -* of the LGPL license is available in the META-INF folder in all -* distributions of Syslog4j and in the base directory of the "doc" ZIP.

-* -* @author <syslog4j@productivity.org> -* @version $Id: SyslogUtility.java,v 1.21 2010/11/28 01:38:08 cvs Exp $ -*/ + * SyslogUtility provides several common utility methods used within + * Syslog4j. + *

+ *

Syslog4j is licensed under the Lesser GNU Public License v2.1. A copy + * of the LGPL license is available in the META-INF folder in all + * distributions of Syslog4j and in the base directory of the "doc" ZIP.

+ * + * @author <syslog4j@productivity.org> + * @version $Id: SyslogUtility.java,v 1.21 2010/11/28 01:38:08 cvs Exp $ + */ public final class SyslogUtility implements SyslogConstants { - private static final long serialVersionUID = 915031554586613648L; - - private SyslogUtility() { - // - } - - public static final InetAddress getInetAddress(String host) throws SyslogRuntimeException { - InetAddress address = null; - - try { - address = InetAddress.getByName(host); - - } catch (UnknownHostException uhe) { - throw new SyslogRuntimeException(uhe); - } - - return address; - } - - public static final String getFacilityString(int syslogFacility) { - switch(syslogFacility) { - case FACILITY_KERN: return "kern"; - case FACILITY_USER: return "user"; - case FACILITY_MAIL: return "mail"; - case FACILITY_DAEMON: return "daemon"; - case FACILITY_AUTH: return "auth"; - case FACILITY_SYSLOG: return "syslog"; - case FACILITY_LPR: return "lpr"; - case FACILITY_NEWS: return "news"; - case FACILITY_UUCP: return "uucp"; - case FACILITY_CRON: return "cron"; - case FACILITY_AUTHPRIV: return "authpriv"; - case FACILITY_FTP: return "ftp"; - case FACILITY_LOCAL0: return "local0"; - case FACILITY_LOCAL1: return "local1"; - case FACILITY_LOCAL2: return "local2"; - case FACILITY_LOCAL3: return "local3"; - case FACILITY_LOCAL4: return "local4"; - case FACILITY_LOCAL5: return "local5"; - case FACILITY_LOCAL6: return "local6"; - case FACILITY_LOCAL7: return "local7"; - - default: return "UNKNOWN"; - } - } - - public static final int getFacility(String facilityName) { - String _facilityName = facilityName; - - if (facilityName == null) { - return -1; - - } else { - _facilityName = facilityName.trim(); - } - - if("KERN".equalsIgnoreCase(_facilityName)) { return FACILITY_KERN; - } else if("USER".equalsIgnoreCase(facilityName)) { return FACILITY_USER; - } else if("MAIL".equalsIgnoreCase(facilityName)) { return FACILITY_MAIL; - } else if("DAEMON".equalsIgnoreCase(facilityName)) { return FACILITY_DAEMON; - } else if("AUTH".equalsIgnoreCase(facilityName)) { return FACILITY_AUTH; - } else if("SYSLOG".equalsIgnoreCase(facilityName)) { return FACILITY_SYSLOG; - } else if("LPR".equalsIgnoreCase(facilityName)) { return FACILITY_LPR; - } else if("NEWS".equalsIgnoreCase(facilityName)) { return FACILITY_NEWS; - } else if("UUCP".equalsIgnoreCase(facilityName)) { return FACILITY_UUCP; - } else if("CRON".equalsIgnoreCase(facilityName)) { return FACILITY_CRON; - } else if("AUTHPRIV".equalsIgnoreCase(facilityName)) { return FACILITY_AUTHPRIV; - } else if("FTP".equalsIgnoreCase(facilityName)) { return FACILITY_FTP; - } else if("LOCAL0".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL0; - } else if("LOCAL1".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL1; - } else if("LOCAL2".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL2; - } else if("LOCAL3".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL3; - } else if("LOCAL4".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL4; - } else if("LOCAL5".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL5; - } else if("LOCAL6".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL6; - } else if("LOCAL7".equalsIgnoreCase(facilityName)) { return FACILITY_LOCAL7; - } else { return -1; - } - } - - public static final int getLevel(String levelName) { - String _levelName = levelName; - - if (levelName == null) { - return -1; - - } else { - _levelName = levelName.trim(); - } - - if("DEBUG".equalsIgnoreCase(_levelName)) { return LEVEL_DEBUG; - } else if("INFO".equalsIgnoreCase(_levelName)) { return LEVEL_INFO; - } else if("NOTICE".equalsIgnoreCase(_levelName)) { return LEVEL_NOTICE; - } else if("WARN".equalsIgnoreCase(_levelName)) { return LEVEL_WARN; - } else if("ERROR".equalsIgnoreCase(_levelName)) { return LEVEL_ERROR; - } else if("CRITICAL".equalsIgnoreCase(_levelName)) { return LEVEL_CRITICAL; - } else if("ALERT".equalsIgnoreCase(_levelName)) { return LEVEL_ALERT; - } else if("EMERGENCY".equalsIgnoreCase(_levelName)) { return LEVEL_EMERGENCY; - } else { return -1; - } - } + private static final long serialVersionUID = 915031554586613648L; + + private SyslogUtility() { + // + } + + public static final InetAddress getInetAddress(String host) throws SyslogRuntimeException { + InetAddress address = null; - public static final boolean isClassExists(String className) { - try { - Class.forName(className); - return true; - - } catch (ClassNotFoundException cnfe) { - // - } - - return false; - } - - public static final String getLocalName() { - String localName = SEND_LOCAL_NAME_DEFAULT_VALUE; - try { - InetAddress addr = InetAddress.getLocalHost(); - localName = addr.getHostName(); - + address = InetAddress.getByName(host); + } catch (UnknownHostException uhe) { - // + throw new SyslogRuntimeException(uhe); } - + + return address; + } + + public static final String getFacilityString(int syslogFacility) { + switch (syslogFacility) { + case FACILITY_KERN: + return "kern"; + case FACILITY_USER: + return "user"; + case FACILITY_MAIL: + return "mail"; + case FACILITY_DAEMON: + return "daemon"; + case FACILITY_AUTH: + return "auth"; + case FACILITY_SYSLOG: + return "syslog"; + case FACILITY_LPR: + return "lpr"; + case FACILITY_NEWS: + return "news"; + case FACILITY_UUCP: + return "uucp"; + case FACILITY_CRON: + return "cron"; + case FACILITY_AUTHPRIV: + return "authpriv"; + case FACILITY_FTP: + return "ftp"; + case FACILITY_LOCAL0: + return "local0"; + case FACILITY_LOCAL1: + return "local1"; + case FACILITY_LOCAL2: + return "local2"; + case FACILITY_LOCAL3: + return "local3"; + case FACILITY_LOCAL4: + return "local4"; + case FACILITY_LOCAL5: + return "local5"; + case FACILITY_LOCAL6: + return "local6"; + case FACILITY_LOCAL7: + return "local7"; + + default: + return "UNKNOWN"; + } + } + + public static final int getFacility(String facilityName) { + String _facilityName = facilityName; + + if (facilityName == null) { + return -1; + + } else { + _facilityName = facilityName.trim(); + } + + if ("KERN".equalsIgnoreCase(_facilityName)) { + return FACILITY_KERN; + } else if ("USER".equalsIgnoreCase(facilityName)) { + return FACILITY_USER; + } else if ("MAIL".equalsIgnoreCase(facilityName)) { + return FACILITY_MAIL; + } else if ("DAEMON".equalsIgnoreCase(facilityName)) { + return FACILITY_DAEMON; + } else if ("AUTH".equalsIgnoreCase(facilityName)) { + return FACILITY_AUTH; + } else if ("SYSLOG".equalsIgnoreCase(facilityName)) { + return FACILITY_SYSLOG; + } else if ("LPR".equalsIgnoreCase(facilityName)) { + return FACILITY_LPR; + } else if ("NEWS".equalsIgnoreCase(facilityName)) { + return FACILITY_NEWS; + } else if ("UUCP".equalsIgnoreCase(facilityName)) { + return FACILITY_UUCP; + } else if ("CRON".equalsIgnoreCase(facilityName)) { + return FACILITY_CRON; + } else if ("AUTHPRIV".equalsIgnoreCase(facilityName)) { + return FACILITY_AUTHPRIV; + } else if ("FTP".equalsIgnoreCase(facilityName)) { + return FACILITY_FTP; + } else if ("LOCAL0".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL0; + } else if ("LOCAL1".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL1; + } else if ("LOCAL2".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL2; + } else if ("LOCAL3".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL3; + } else if ("LOCAL4".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL4; + } else if ("LOCAL5".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL5; + } else if ("LOCAL6".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL6; + } else if ("LOCAL7".equalsIgnoreCase(facilityName)) { + return FACILITY_LOCAL7; + } else { + return -1; + } + } + + public static final int getLevel(String levelName) { + String _levelName = levelName; + + if (levelName == null) { + return -1; + + } else { + _levelName = levelName.trim(); + } + + if ("DEBUG".equalsIgnoreCase(_levelName)) { + return LEVEL_DEBUG; + } else if ("INFO".equalsIgnoreCase(_levelName)) { + return LEVEL_INFO; + } else if ("NOTICE".equalsIgnoreCase(_levelName)) { + return LEVEL_NOTICE; + } else if ("WARN".equalsIgnoreCase(_levelName)) { + return LEVEL_WARN; + } else if ("ERROR".equalsIgnoreCase(_levelName)) { + return LEVEL_ERROR; + } else if ("CRITICAL".equalsIgnoreCase(_levelName)) { + return LEVEL_CRITICAL; + } else if ("ALERT".equalsIgnoreCase(_levelName)) { + return LEVEL_ALERT; + } else if ("EMERGENCY".equalsIgnoreCase(_levelName)) { + return LEVEL_EMERGENCY; + } else { + return -1; + } + } + + public static final boolean isClassExists(String className) { + try { + Class.forName(className); + return true; + + } catch (ClassNotFoundException cnfe) { + // + } + + return false; + } + + public static final String getLocalName() { + String localName = SEND_LOCAL_NAME_DEFAULT_VALUE; + + try { + InetAddress addr = InetAddress.getLocalHost(); + localName = addr.getHostName(); + + } catch (UnknownHostException uhe) { + // + } + return localName; - } - - public static final byte[] getBytes(SyslogCharSetIF syslogCharSet, String data) { - byte[] dataBytes = null; - - try { - dataBytes = data.getBytes(syslogCharSet.getCharSet()); - - } catch (UnsupportedEncodingException uee) { - dataBytes = data.getBytes(); - } - - return dataBytes; - } - - public static final String newString(SyslogCharSetIF syslogCharSet, byte[] dataBytes) { - String data = newString(syslogCharSet,dataBytes,dataBytes.length); - - return data; - } + } - public static final String newString(SyslogCharSetIF syslogCharSet, byte[] dataBytes, int dataLength) { - String data = null; - - try { - data = new String(dataBytes,0,dataLength,syslogCharSet.getCharSet()); - - } catch (UnsupportedEncodingException uee) { - data = new String(dataBytes); - } - - return data; - } + public static final byte[] getBytes(SyslogCharSetIF syslogCharSet, String data) { + byte[] dataBytes = null; - public static final String getLevelString(int level) { - switch(level) { - case SyslogConstants.LEVEL_DEBUG: return "DEBUG"; - case SyslogConstants.LEVEL_INFO: return "INFO"; - case SyslogConstants.LEVEL_NOTICE: return "NOTICE"; - case SyslogConstants.LEVEL_WARN: return "WARN"; - case SyslogConstants.LEVEL_ERROR: return "ERROR"; - case SyslogConstants.LEVEL_CRITICAL: return "CRITICAL"; - case SyslogConstants.LEVEL_ALERT: return "ALERT"; - case SyslogConstants.LEVEL_EMERGENCY: return "EMERGENCY"; - - default: - return "UNKNOWN"; - } - } - - - public static void sleep(long duration) { - try { - Thread.sleep(duration); - - } catch (InterruptedException ie) { - // - } - } + try { + dataBytes = data.getBytes(syslogCharSet.getCharSet()); + + } catch (UnsupportedEncodingException uee) { + dataBytes = data.getBytes(); + } + + return dataBytes; + } + + public static final String newString(SyslogCharSetIF syslogCharSet, byte[] dataBytes) { + String data = newString(syslogCharSet, dataBytes, dataBytes.length); + + return data; + } + + public static final String newString(SyslogCharSetIF syslogCharSet, byte[] dataBytes, int dataLength) { + String data = null; + + try { + data = new String(dataBytes, 0, dataLength, syslogCharSet.getCharSet()); + + } catch (UnsupportedEncodingException uee) { + data = new String(dataBytes); + } + + return data; + } + + public static final String getLevelString(int level) { + switch (level) { + case SyslogConstants.LEVEL_DEBUG: + return "DEBUG"; + case SyslogConstants.LEVEL_INFO: + return "INFO"; + case SyslogConstants.LEVEL_NOTICE: + return "NOTICE"; + case SyslogConstants.LEVEL_WARN: + return "WARN"; + case SyslogConstants.LEVEL_ERROR: + return "ERROR"; + case SyslogConstants.LEVEL_CRITICAL: + return "CRITICAL"; + case SyslogConstants.LEVEL_ALERT: + return "ALERT"; + case SyslogConstants.LEVEL_EMERGENCY: + return "EMERGENCY"; + + default: + return "UNKNOWN"; + } + } + + + public static void sleep(long duration) { + try { + Thread.sleep(duration); + + } catch (InterruptedException ie) { + // + } + } }