SyslogIF (syslog4j-graylog2 0.9.60 API)

All Superinterfaces:

Serializable, SyslogConstants

All Known Implementing Classes:

AbstractNetSyslog, AbstractSyslog, MultipleSyslog, PooledTCPNetSyslog, SSLTCPNetSyslog, TCPNetSyslog, UDPNetSyslog, UnixSocketSyslog, UnixSyslog
```
public interface SyslogIF
extends SyslogConstants
```
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.

Version:

$Id: SyslogIF.java,v 1.9 2010/02/11 04:59:22 cvs Exp $

Author:

<syslog4j@productivity.org>

Field Summary
- Fields inherited from interface org.graylog2.syslog4j.SyslogConstants
  AF_UNIX, CACHE_HOST_ADDRESS_DEFAULT, CHAR_SET_DEFAULT, CRLF, FACILITY_ALERT, FACILITY_AUDIT, FACILITY_AUTH, FACILITY_AUTHPRIV, FACILITY_CLOCK2, FACILITY_CRON, FACILITY_DAEMON, FACILITY_FTP, FACILITY_KERN, FACILITY_LOCAL0, FACILITY_LOCAL1, FACILITY_LOCAL2, FACILITY_LOCAL3, FACILITY_LOCAL4, FACILITY_LOCAL5, FACILITY_LOCAL6, FACILITY_LOCAL7, FACILITY_LPR, FACILITY_MAIL, FACILITY_NEWS, FACILITY_NTP, FACILITY_SYSLOG, FACILITY_USER, FACILITY_UUCP, IDENT_SUFFIX_DEFAULT, INCLUDE_IDENT_IN_MESSAGE_MODIFIER_DEFAULT, JNA_NATIVE_CLASS, LEVEL_ALERT, LEVEL_CRITICAL, LEVEL_DEBUG, LEVEL_EMERGENCY, LEVEL_ERROR, LEVEL_INFO, LEVEL_NOTICE, LEVEL_WARN, LF, MAX_MESSAGE_LENGTH_DEFAULT, MAX_MESSAGE_LENGTH_RFC5424, MAX_QUEUE_SIZE_DEFAULT, MAX_SHUTDOWN_WAIT_DEFAULT, OPTION_LOG_CONS, OPTION_LOG_NDELAY, OPTION_LOG_NOWAIT, OPTION_LOG_ODELAY, OPTION_LOG_PERROR, OPTION_LOG_PID, OPTION_NONE, SEND_LOCAL_NAME_DEFAULT, SEND_LOCAL_NAME_DEFAULT_VALUE, SEND_LOCAL_TIMESTAMP_DEFAULT, SERVER_SHUTDOWN_WAIT_DEFAULT, SERVER_SOCKET_BACKLOG_DEFAULT, SHUTDOWN_INTERVAL, SOCK_DGRAM, SOCK_STREAM, SPLIT_MESSAGE_BEGIN_TEXT_DEFAULT, SPLIT_MESSAGE_END_TEXT_DEFAULT, STRUCTURED_DATA_APP_NAME_DEFAULT_VALUE, STRUCTURED_DATA_EMPTY_VALUE, STRUCTURED_DATA_NILVALUE, STRUCTURED_DATA_PROCESS_ID_DEFAULT_VALUE, SYSLOG_BUFFER_SIZE, SYSLOG_DATEFORMAT, SYSLOG_DATEFORMAT_RFC5424, SYSLOG_FACILITY_DEFAULT, SYSLOG_HOST_DEFAULT, SYSLOG_LIBRARY_DEFAULT, SYSLOG_MESSAGE_MODIFIER_PREFIX_DEFAULT, SYSLOG_MESSAGE_MODIFIER_SUFFIX_DEFAULT, SYSLOG_PATH_DEFAULT, SYSLOG_POOL_CONFIG_MAX_ACTIVE_DEFAULT, SYSLOG_POOL_CONFIG_MAX_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_MAX_WAIT_DEFAULT, SYSLOG_POOL_CONFIG_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT, SYSLOG_POOL_CONFIG_MIN_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_NUM_TESTS_PER_EVICTION_RUN_DEFAULT, SYSLOG_POOL_CONFIG_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS_DEFAULT, SYSLOG_POOL_CONFIG_TEST_ON_BORROW_DEFAULT, SYSLOG_POOL_CONFIG_TEST_ON_RETURN_DEFAULT, SYSLOG_POOL_CONFIG_TEST_WHILE_IDLE_DEFAULT, SYSLOG_POOL_CONFIG_TIME_BETWEEN_EVICTION_RUNS_MILLIS_DEFAULT, SYSLOG_PORT_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_FIRST_NUMBER_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_LAST_NUMBER_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PAD_CHAR_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_PREFIX_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_SUFFIX_DEFAULT, SYSLOG_SEQUENTIAL_MESSAGE_MODIFIER_USE_PADDING_DEFAULT, SYSLOG_SOCKET_FAMILY_DEFAULT, SYSLOG_SOCKET_LIBRARY_DEFAULT, SYSLOG_SOCKET_PATH_DEFAULT, SYSLOG_SOCKET_PROTOCOL_DEFAULT, SYSLOG_SOCKET_TYPE_DEFAULT, TCP, TCP_DELIMITER_SEQUENCE_DEFAULT, TCP_FRESH_CONNECTION_INTERVAL_DEFAULT, TCP_KEEP_ALIVE_DEFAULT, TCP_MAX_ACTIVE_SOCKETS_BEHAVIOR_DEFAULT, TCP_MAX_ACTIVE_SOCKETS_DEFAULT, TCP_PERSISTENT_CONNECTION_DEFAULT, TCP_REUSE_ADDRESS_DEFAULT, TCP_SET_BUFFER_SIZE_DEFAULT, TCP_SO_LINGER_DEFAULT, TCP_SO_LINGER_SECONDS_DEFAULT, THREAD_LOOP_INTERVAL_DEFAULT, THREAD_PRIORITY_DEFAULT, THREADED_DEFAULT, THROW_EXCEPTION_ON_INITIALIZE_DEFAULT, THROW_EXCEPTION_ON_WRITE_DEFAULT, TRUNCATE_MESSAGE_DEFAULT, UDP, UNIX_SOCKET, UNIX_SYSLOG, USE_DAEMON_THREAD_DEFAULT, USE_STRUCTURED_DATA_DEFAULT, WRITE_RETRIES_DEFAULT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`alert(String message)`
`void`	`alert(SyslogMessageIF message)`
`void`	`backLog(int level, String message, String reason)`
`void`	`backLog(int level, String message, Throwable reasonThrowable)`
`void`	`critical(String message)`
`void`	`critical(SyslogMessageIF message)`
`void`	`debug(String message)`
`void`	`debug(SyslogMessageIF message)`
`void`	`emergency(String message)`
`void`	`emergency(SyslogMessageIF message)`
`void`	`error(String message)`
`void`	`error(SyslogMessageIF message)`
`void`	`flush()`
`SyslogConfigIF`	`getConfig()`
`SyslogMessageProcessorIF`	`getMessageProcessor()`
`String`	`getProtocol()`
`SyslogMessageProcessorIF`	`getStructuredMessageProcessor()`
`void`	`info(String message)`
`void`	`info(SyslogMessageIF message)`
`void`	`initialize(String protocol, SyslogConfigIF config)`
`void`	`log(int level, String message)`
`void`	`log(int level, String message, Date datetime)`
`void`	`log(int level, SyslogMessageIF message)`
`void`	`log(int level, SyslogMessageIF message, Date datetime)`
`void`	`notice(String message)`
`void`	`notice(SyslogMessageIF message)`
`void`	`setMessageProcessor(SyslogMessageProcessorIF messageProcessor)`
`void`	`setStructuredMessageProcessor(SyslogMessageProcessorIF messageProcessor)`
`void`	`shutdown()`
`void`	`warn(String message)`
`void`	`warn(SyslogMessageIF message)`

Method Detail

initialize

void initialize(String protocol,
                SyslogConfigIF config)
         throws SyslogRuntimeException

Throws:: SyslogRuntimeException

getProtocol
```
String getProtocol()
```

getConfig
```
SyslogConfigIF getConfig()
```

backLog

void backLog(int level,
             String message,
             Throwable reasonThrowable)

backLog

void backLog(int level,
             String message,
             String reason)

log

void log(int level,
         String message)

log

void log(int level,
         String message,
         Date datetime)

debug
```
void debug(String message)
```

info
```
void info(String message)
```

notice
```
void notice(String message)
```

warn
```
void warn(String message)
```

error
```
void error(String message)
```

critical
```
void critical(String message)
```

alert
```
void alert(String message)
```

emergency
```
void emergency(String message)
```

log

void log(int level,
         SyslogMessageIF message)

log

void log(int level,
         SyslogMessageIF message,
         Date datetime)

debug
```
void debug(SyslogMessageIF message)
```

info
```
void info(SyslogMessageIF message)
```

notice
```
void notice(SyslogMessageIF message)
```

warn
```
void warn(SyslogMessageIF message)
```

error
```
void error(SyslogMessageIF message)
```

critical

void critical(SyslogMessageIF message)

alert
```
void alert(SyslogMessageIF message)
```

emergency

void emergency(SyslogMessageIF message)

flush

void flush()
    throws SyslogRuntimeException

Throws:: SyslogRuntimeException

shutdown

void shutdown()
       throws SyslogRuntimeException

Throws:: SyslogRuntimeException

setMessageProcessor

void setMessageProcessor(SyslogMessageProcessorIF messageProcessor)

getMessageProcessor

SyslogMessageProcessorIF getMessageProcessor()

setStructuredMessageProcessor

void setStructuredMessageProcessor(SyslogMessageProcessorIF messageProcessor)

getStructuredMessageProcessor

SyslogMessageProcessorIF getStructuredMessageProcessor()

Interface SyslogIF

Field Summary

Fields inherited from interface org.graylog2.syslog4j.SyslogConstants

Method Summary

Method Detail

initialize

getProtocol

getConfig

backLog

backLog

log

log

debug

info

notice

warn

error

critical

alert

emergency

log

log

debug

info

notice

warn

error

critical

alert

emergency

flush

shutdown

setMessageProcessor

getMessageProcessor

setStructuredMessageProcessor

getStructuredMessageProcessor