com.cloudbees.syslog.sender

Class TcpSyslogMessageSender

java.lang.Object

com.cloudbees.syslog.sender.AbstractSyslogMessageSender

com.cloudbees.syslog.sender.TcpSyslogMessageSender

All Implemented Interfaces:

SyslogMessageSender, Closeable, AutoCloseable

@ThreadSafe
public class TcpSyslogMessageSender
extends AbstractSyslogMessageSender
implements Closeable

See RFC 6587 - Transmission of Syslog Messages over TCP

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
static int	SETTING_MAX_RETRY
static int	SETTING_SOCKET_CONNECT_TIMEOUT_IN_MILLIS_DEFAULT_VALUE
protected CachingReference<InetAddress>	syslogServerHostnameReference InetAddress of the remote Syslog Server.
protected int	syslogServerPort Listen port of the remote Syslog server.
protected AtomicInteger	trySendErrorCounter Number of exceptions trying to send message.

Fields inherited from class com.cloudbees.syslog.sender.AbstractSyslogMessageSender

defaultAppName, defaultFacility, defaultMessageHostname, defaultSeverity, logger, messageFormat, sendCounter, sendDurationInNanosCounter, sendErrorCounter, 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
TcpSyslogMessageSender()

Method Summary

Modifier and Type	Method and Description
void	close()
int	getMaxRetryCount()
int	getSocketConnectTimeoutInMillis()
String	getSyslogServerHostname()
int	getSyslogServerPort()
int	getTrySendErrorCounter()
boolean	isSsl()
void	sendMessage(SyslogMessage message) Send the given SyslogMessage.
void	setMaxRetryCount(int maxRetryCount)
void	setPostfix(String postfix)
void	setSocketConnectTimeoutInMillis(int socketConnectTimeoutInMillis)
void	setSsl(boolean ssl)
void	setSyslogServerHostname(String syslogServerHostname) Set the hostname or IP of the syslog server to which messages will be sent.
void	setSyslogServerPort(int syslogServerPort) Set the port number of the syslog server to which messages will be sent.
String	toString()

Methods inherited from class com.cloudbees.syslog.sender.AbstractSyslogMessageSender

getDefaultAppName, getDefaultFacility, getDefaultMessageHostname, getDefaultSeverity, getMessageFormat, getSendCount, getSendDurationInMillis, getSendDurationInNanos, getSendErrorCount, sendMessage, sendMessage, setDefaultAppName, setDefaultFacility, setDefaultMessageHostname, setDefaultSeverity, setMessageFormat

Methods inherited from class java.lang.Object

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

Field Detail

SETTING_SOCKET_CONNECT_TIMEOUT_IN_MILLIS_DEFAULT_VALUE

public static final int SETTING_SOCKET_CONNECT_TIMEOUT_IN_MILLIS_DEFAULT_VALUE

See Also:

Constant Field Values

SETTING_MAX_RETRY

public static final int SETTING_MAX_RETRY

See Also:

Constant Field Values

syslogServerHostnameReference

protected CachingReference<InetAddress> syslogServerHostnameReference

InetAddress of the remote Syslog Server. The InetAddress is refreshed regularly to handle DNS changes (default SyslogMessageSender.DEFAULT_INET_ADDRESS_TTL_IN_MILLIS) Default value: SyslogMessageSender.DEFAULT_SYSLOG_HOST

syslogServerPort

protected int syslogServerPort

Listen port of the remote Syslog server. Default: SyslogMessageSender.DEFAULT_SYSLOG_PORT

trySendErrorCounter

protected final AtomicInteger trySendErrorCounter

Number of exceptions trying to send message.

Constructor Detail

TcpSyslogMessageSender

public TcpSyslogMessageSender()

Method Detail

sendMessage

public void sendMessage(@Nonnull
                        SyslogMessage message)
                 throws IOException

Description copied from class: AbstractSyslogMessageSender

Send the given SyslogMessage.

Specified by:

sendMessage in interface SyslogMessageSender

Specified by:

sendMessage in class AbstractSyslogMessageSender

Parameters:

message - the message to send

Throws:

IOException

setSyslogServerHostname

public void setSyslogServerHostname(String syslogServerHostname)

Description copied from class: AbstractSyslogMessageSender

Set the hostname or IP of the syslog server to which messages will be sent.

Specified by:

setSyslogServerHostname in class AbstractSyslogMessageSender

Parameters:

syslogServerHostname - The hostname or IP address of the syslog server.

setSyslogServerPort

public void setSyslogServerPort(int syslogServerPort)

Description copied from class: AbstractSyslogMessageSender

Set the port number of the syslog server to which messages will be sent.

Specified by:

setSyslogServerPort in class AbstractSyslogMessageSender

Parameters:

syslogServerPort - The port to which syslog messages will be sent.

getSyslogServerHostname

@Nullable
public String getSyslogServerHostname()

getSyslogServerPort

public int getSyslogServerPort()

isSsl

public boolean isSsl()

setSsl

public void setSsl(boolean ssl)

getSocketConnectTimeoutInMillis

public int getSocketConnectTimeoutInMillis()

getMaxRetryCount

public int getMaxRetryCount()

getTrySendErrorCounter

public int getTrySendErrorCounter()

setSocketConnectTimeoutInMillis

public void setSocketConnectTimeoutInMillis(int socketConnectTimeoutInMillis)

setMaxRetryCount

public void setMaxRetryCount(int maxRetryCount)

setPostfix

public void setPostfix(String postfix)

toString

public String toString()

Overrides:

toString in class AbstractSyslogMessageSender

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException