com.cloudbees.syslog.sender

Class AbstractSyslogMessageSender

java.lang.Object

com.cloudbees.syslog.sender.AbstractSyslogMessageSender

All Implemented Interfaces:

SyslogMessageSender

Direct Known Subclasses:

TcpSyslogMessageSender, UdpSyslogMessageSender

public abstract class AbstractSyslogMessageSender
extends Object
implements SyslogMessageSender

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultAppName
protected Facility	defaultFacility
protected String	defaultMessageHostname
protected Severity	defaultSeverity
protected InternalLogger	logger
protected MessageFormat	messageFormat Format of messages accepted by the remote syslog server (RFC_3164 or RFC_5424)
protected AtomicInteger	sendCounter
protected AtomicLong	sendDurationInNanosCounter
protected AtomicInteger	sendErrorCounter
protected static Charset	UTF_8

Fields inherited from interface com.cloudbees.syslog.sender.SyslogMessageSender

DEFAULT_INET_ADDRESS_TTL_IN_MILLIS, DEFAULT_INET_ADDRESS_TTL_IN_NANOS, DEFAULT_SYSLOG_HOST, DEFAULT_SYSLOG_MESSAGE_FORMAT, DEFAULT_SYSLOG_PORT

Constructor Summary

Constructors

Constructor and Description
AbstractSyslogMessageSender()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultAppName()
Facility	getDefaultFacility()
String	getDefaultMessageHostname()
Severity	getDefaultSeverity()
MessageFormat	getMessageFormat()
int	getSendCount()
long	getSendDurationInMillis() Human readable view of getSendDurationInNanos()
long	getSendDurationInNanos() Human readable view of getSendDurationInNanos()
int	getSendErrorCount()
void	sendMessage(CharArrayWriter message) Send the given text message
void	sendMessage(CharSequence message) Send the given message ; the Syslog fields (appName, severity, priority, hostname ...) are the default values of the MessageSender.
abstract void	sendMessage(SyslogMessage message) Send the given SyslogMessage.
void	setDefaultAppName(String defaultAppName)
void	setDefaultFacility(Facility defaultFacility)
void	setDefaultMessageHostname(String defaultHostname)
void	setDefaultSeverity(Severity defaultSeverity)
void	setMessageFormat(MessageFormat messageFormat)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UTF_8

protected static final Charset UTF_8

logger

protected final InternalLogger logger

defaultAppName

protected String defaultAppName

defaultFacility

protected Facility defaultFacility

defaultMessageHostname

protected String defaultMessageHostname

defaultSeverity

protected Severity defaultSeverity

messageFormat

protected MessageFormat messageFormat

Format of messages accepted by the remote syslog server (RFC_3164 or RFC_5424)

sendCounter

protected final AtomicInteger sendCounter

sendDurationInNanosCounter

protected final AtomicLong sendDurationInNanosCounter

sendErrorCounter

protected final AtomicInteger sendErrorCounter

Constructor Detail

AbstractSyslogMessageSender

public AbstractSyslogMessageSender()

Method Detail

sendMessage

public void sendMessage(CharArrayWriter message)
                 throws IOException

Send the given text message

Specified by:

sendMessage in interface SyslogMessageSender

Parameters:

message -

Throws:

IOException

sendMessage

public void sendMessage(CharSequence message)
                 throws IOException

Description copied from interface: SyslogMessageSender

Send the given message ; the Syslog fields (appName, severity, priority, hostname ...) are the default values of the MessageSender.

Specified by:

sendMessage in interface SyslogMessageSender

Parameters:

message - the message to send

Throws:

IOException

sendMessage

public abstract void sendMessage(@Nonnull
               SyslogMessage message)
                          throws IOException

Send the given SyslogMessage.

Specified by:

sendMessage in interface SyslogMessageSender

Parameters:

message - the message to send

Throws:

IOException

getDefaultAppName

public String getDefaultAppName()

getDefaultFacility

public Facility getDefaultFacility()

getMessageFormat

public MessageFormat getMessageFormat()

getDefaultMessageHostname

public String getDefaultMessageHostname()

getSendCount

public int getSendCount()

getSendDurationInMillis

public long getSendDurationInMillis()

Human readable view of getSendDurationInNanos()

Returns:

total duration spent sending syslog messages

getSendDurationInNanos

public long getSendDurationInNanos()

Human readable view of getSendDurationInNanos()

Returns:

total duration spent sending syslog messages

getSendErrorCount

public int getSendErrorCount()

getDefaultSeverity

public Severity getDefaultSeverity()

setDefaultAppName

public void setDefaultAppName(String defaultAppName)

setDefaultMessageHostname

public void setDefaultMessageHostname(String defaultHostname)

setDefaultFacility

public void setDefaultFacility(Facility defaultFacility)

setMessageFormat

public void setMessageFormat(MessageFormat messageFormat)

setDefaultSeverity

public void setDefaultSeverity(Severity defaultSeverity)

toString

public String toString()

Overrides:

toString in class Object