com.cloudbees.syslog

Class SyslogMessage

java.lang.Object

com.cloudbees.syslog.SyslogMessage

public class SyslogMessage
extends Object

Syslog message as defined in RFC 5424 - The Syslog Protocol. Also compatible with RFC-3164: The BSD syslog Protocol,

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
static char	NILVALUE
protected static ConcurrentDateFormat	rfc3164DateFormat
protected static ConcurrentDateFormat	rfc3339DateFormat
static char	SP

Constructor Summary

Constructors

Constructor and Description
SyslogMessage()

Method Summary

Modifier and Type	Method and Description
String	getAppName()
protected String	getEscapedParamValue(String paramValue)
Facility	getFacility()
String	getHostname()
CharArrayWriter	getMsg()
String	getMsgId()
String	getProcId()
Set<SDElement>	getSDElements()
Severity	getSeverity()
Date	getTimestamp()
void	setAppName(String appName)
void	setFacility(Facility facility)
void	setHostname(String hostname)
void	setMsg(CharArrayWriter msg)
void	setMsgId(String msgId)
void	setProcId(String procId)
void	setSDElements(Set<SDElement> ssde)
void	setSeverity(Severity severity)
void	setTimestamp(Date timestamp)
String	toRfc3164SyslogMessage() Generates an RFC-3164 message.
void	toRfc3164SyslogMessage(Writer out) Generates an RFC-3164 message.
String	toRfc5424SyslogMessage() Generates an RFC-5424 message.
void	toRfc5424SyslogMessage(Writer out) Generates an RFC-5424 message.
String	toRfc5425SyslogMessage() Generates an RFC-5425 message.
void	toRfc5425SyslogMessage(Writer out) Generates an RFC-5425 message.
String	toSyslogMessage(MessageFormat messageFormat) Generates a Syslog message complying to the RFC-5424 format or to the RFC-3164 format.
void	toSyslogMessage(MessageFormat messageFormat, Writer out) Generates a Syslog message complying to the RFC-5424 format or to the RFC-3164 format.
SyslogMessage	withAppName(String appName)
SyslogMessage	withFacility(Facility facility)
SyslogMessage	withHostname(String hostname)
SyslogMessage	withMsg(CharArrayWriter msg)
SyslogMessage	withMsg(String msg)
SyslogMessage	withMsgId(String msgId)
SyslogMessage	withProcId(String procId)
SyslogMessage	withSDElement(SDElement sde)
SyslogMessage	withSeverity(Severity severity)
SyslogMessage	withTimestamp(Date timestamp)
SyslogMessage	withTimestamp(long timestamp)
protected void	writeNillableValue(String value, Writer out)
protected void	writeSDElement(SDElement sde, Writer out)
protected void	writeSDParam(SDParam sdp, Writer out)
protected void	writeStructuredDataOrNillableValue(Set<SDElement> ssde, Writer out)

Methods inherited from class java.lang.Object

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

Field Detail

SP

public static final char SP

See Also:

Constant Field Values

NILVALUE

public static final char NILVALUE

See Also:

Constant Field Values

rfc3339DateFormat

protected static final ConcurrentDateFormat rfc3339DateFormat

rfc3164DateFormat

protected static final ConcurrentDateFormat rfc3164DateFormat

Constructor Detail

SyslogMessage

public SyslogMessage()

Method Detail

getFacility

public Facility getFacility()

setFacility

public void setFacility(Facility facility)

withFacility

public SyslogMessage withFacility(Facility facility)

getSeverity

public Severity getSeverity()

setSeverity

public void setSeverity(Severity severity)

withSeverity

public SyslogMessage withSeverity(Severity severity)

getTimestamp

public Date getTimestamp()

setTimestamp

public void setTimestamp(Date timestamp)

withTimestamp

public SyslogMessage withTimestamp(long timestamp)

withTimestamp

public SyslogMessage withTimestamp(Date timestamp)

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

withHostname

public SyslogMessage withHostname(String hostname)

getAppName

public String getAppName()

setAppName

public void setAppName(String appName)

withAppName

public SyslogMessage withAppName(String appName)

getProcId

public String getProcId()

setProcId

public void setProcId(String procId)

withProcId

public SyslogMessage withProcId(String procId)

getMsgId

public String getMsgId()

setMsgId

public void setMsgId(String msgId)

withMsgId

public SyslogMessage withMsgId(String msgId)

getMsg

public CharArrayWriter getMsg()

setMsg

public void setMsg(CharArrayWriter msg)

withMsg

public SyslogMessage withMsg(CharArrayWriter msg)

withMsg

public SyslogMessage withMsg(String msg)

getSDElements

public Set<SDElement> getSDElements()

setSDElements

public void setSDElements(Set<SDElement> ssde)

withSDElement

public SyslogMessage withSDElement(SDElement sde)

toSyslogMessage

public String toSyslogMessage(MessageFormat messageFormat)

Generates a Syslog message complying to the RFC-5424 format or to the RFC-3164 format.

Parameters:

messageFormat - message format, not null

toSyslogMessage

public void toSyslogMessage(@Nonnull
                            MessageFormat messageFormat,
                            @Nonnull
                            Writer out)
                     throws IOException

Generates a Syslog message complying to the RFC-5424 format or to the RFC-3164 format.

Parameters:

messageFormat - message format

out - output Writer

Throws:

IOException

toRfc5425SyslogMessage

public String toRfc5425SyslogMessage()

Generates an RFC-5425 message.

toRfc5425SyslogMessage

public void toRfc5425SyslogMessage(Writer out)
                            throws IOException

Generates an RFC-5425 message.

Throws:

IOException

toRfc5424SyslogMessage

public String toRfc5424SyslogMessage()

Generates an RFC-5424 message.

toRfc5424SyslogMessage

public void toRfc5424SyslogMessage(Writer out)
                            throws IOException

Generates an RFC-5424 message. The priority is calculated by facility * 8 + severity, see RFC-5424, Section 6.2.1

Throws:

IOException

toRfc3164SyslogMessage

public String toRfc3164SyslogMessage()

Generates an RFC-3164 message.

See Also:

toRfc3164SyslogMessage(java.io.Writer)

toRfc3164SyslogMessage

public void toRfc3164SyslogMessage(Writer out)
                            throws IOException

Generates an RFC-3164 message.

Throws:

IOException

writeNillableValue

protected void writeNillableValue(@Nullable
                                  String value,
                                  @Nonnull
                                  Writer out)
                           throws IOException

Throws:

IOException

writeStructuredDataOrNillableValue

protected void writeStructuredDataOrNillableValue(@Nullable
                                                  Set<SDElement> ssde,
                                                  @Nonnull
                                                  Writer out)
                                           throws IOException

Throws:

IOException

writeSDElement

protected void writeSDElement(@Nonnull
                              SDElement sde,
                              @Nonnull
                              Writer out)
                       throws IOException

Throws:

IOException

writeSDParam

protected void writeSDParam(@Nonnull
                            SDParam sdp,
                            @Nonnull
                            Writer out)
                     throws IOException

Throws:

IOException

getEscapedParamValue

protected String getEscapedParamValue(String paramValue)