Class DefaultKeyProvider

java.lang.Object

com.github.palindromicity.syslog.DefaultKeyProvider

All Implemented Interfaces:

KeyProvider

public class DefaultKeyProvider
extends Object
implements KeyProvider

Default implementation of KeyProvider.

This implementation uses the SyslogFieldKeys for values.

Constructor Summary

Constructors

Constructor	Description
DefaultKeyProvider()

Method Summary

Modifier and Type	Method	Description
String	getHeaderAppName()	Provides the key name for the HEADER APP-NAME @see Section 6.2.5.
String	getHeaderFacility()	Provides the key name for the Facility from the HEADER PRI @see Section 6.2.1.
String	getHeaderHostName()	Provides the key name for the HEADER HOSTNAME @see Section 6.2.4.
String	getHeaderMessageId()	Provides the key name for the HEADER MSGID @see Section 6.2.7.
String	getHeaderPriority()	Provides the key name for the HEADER PRI @see Section 6.2.1.
String	getHeaderProcessId()	Provides the key name for the HEADER PROCID @see Section 6.2.6.
String	getHeaderSeverity()	Provides the key name for the Severity from the HEADER PRI @see Section 6.2.1.
String	getHeaderTimeStamp()	Provides the key name for the HEADER TIMESTAMP @see Section 6.2.3.
String	getHeaderVersion()	Provides the key name for the HEADER VERSION @see Section 6.2.2.
String	getMessage()	Provides the key name for the MSG @see Section 6.4.
String	getStructuredBase()	The base String used for all STRUCTURED_DATA keys.
String	getStructuredElementIdFormat()	Provides a String.format String for producing key name for the STRUCTURED_DATA SD-ID @see Section 6.3.2.
String	getStructuredElementIdParamNameFormat()	Provides a String.format String for producing key name for the STRUCTURED_DATA SD-PARAM @see Section 6.3.3.
Pattern	getStructuredElementIdParamNamePattern()	Provides Pattern that will match and capture the SD-ID and SD-PARAM PARAM-NAME as defined in the return from KeyProvider.getStructuredElementIdParamNameFormat().

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultKeyProvider

public DefaultKeyProvider()

Method Details

getMessage

public String getMessage()

Description copied from interface: KeyProvider

Provides the key name for the MSG @see Section 6.4.

Specified by:

getMessage in interface KeyProvider

Returns:

MSG key name

getHeaderAppName

public String getHeaderAppName()

Description copied from interface: KeyProvider

Provides the key name for the HEADER APP-NAME @see Section 6.2.5.

Specified by:

getHeaderAppName in interface KeyProvider

Returns:

APP-NAME key name

getHeaderHostName

public String getHeaderHostName()

Description copied from interface: KeyProvider

Provides the key name for the HEADER HOSTNAME @see Section 6.2.4.

Specified by:

getHeaderHostName in interface KeyProvider

Returns:

HOSTNAME key name

getHeaderPriority

public String getHeaderPriority()

Description copied from interface: KeyProvider

Provides the key name for the HEADER PRI @see Section 6.2.1.

Specified by:

getHeaderPriority in interface KeyProvider

Returns:

PRI key name

getHeaderSeverity

public String getHeaderSeverity()

Description copied from interface: KeyProvider

Provides the key name for the Severity from the HEADER PRI @see Section 6.2.1.

Specified by:

getHeaderSeverity in interface KeyProvider

Returns:

PRI key name

getHeaderFacility

public String getHeaderFacility()

Description copied from interface: KeyProvider

Provides the key name for the Facility from the HEADER PRI @see Section 6.2.1.

Specified by:

getHeaderFacility in interface KeyProvider

Returns:

PRI key name

getHeaderProcessId

public String getHeaderProcessId()

Description copied from interface: KeyProvider

Provides the key name for the HEADER PROCID @see Section 6.2.6.

Specified by:

getHeaderProcessId in interface KeyProvider

Returns:

PROCID key name

getHeaderTimeStamp

public String getHeaderTimeStamp()

Description copied from interface: KeyProvider

Provides the key name for the HEADER TIMESTAMP @see Section 6.2.3.

Specified by:

getHeaderTimeStamp in interface KeyProvider

Returns:

TIMESTAMP key name

getHeaderMessageId

public String getHeaderMessageId()

Description copied from interface: KeyProvider

Provides the key name for the HEADER MSGID @see Section 6.2.7.

Specified by:

getHeaderMessageId in interface KeyProvider

Returns:

MSGID key name

getHeaderVersion

public String getHeaderVersion()

Description copied from interface: KeyProvider

Provides the key name for the HEADER VERSION @see Section 6.2.2.

Specified by:

getHeaderVersion in interface KeyProvider

Returns:

VERSION key name

getStructuredBase

public String getStructuredBase()

Description copied from interface: KeyProvider

The base String used for all STRUCTURED_DATA keys. syslog.structuredData. for example. This can be useful to find all STRUCTURED_DATA keys

Specified by:

getStructuredBase in interface KeyProvider

Returns:

STRUCTURED_DATA base key name

See Also:

• Section 6.3

getStructuredElementIdFormat

public String getStructuredElementIdFormat()

Description copied from interface: KeyProvider

Provides a String.format String for producing key name for the STRUCTURED_DATA SD-ID @see Section 6.3.2. The format String supports one parameter %s that will be passed the SD-ID value. The format must begin with the value returned from KeyProvider.getStructuredBase() For example:

   syslog.structuredData.%s
 

Specified by:

getStructuredElementIdFormat in interface KeyProvider

Returns:

SD-ID format String

getStructuredElementIdParamNameFormat

public String getStructuredElementIdParamNameFormat()

Description copied from interface: KeyProvider

Provides a String.format String for producing key name for the STRUCTURED_DATA SD-PARAM @see Section 6.3.3. The format String supports two parameters %s that will be passed the SD-ID value and the SD-PARAM PARAM-NAME. The format must begin with the value returned from KeyProvider.getStructuredBase() For example:

   syslog.structuredData.%s.%s
 

Specified by:

getStructuredElementIdParamNameFormat in interface KeyProvider

Returns:

SD-PARAM format String

getStructuredElementIdParamNamePattern

public Pattern getStructuredElementIdParamNamePattern()

Description copied from interface: KeyProvider

Provides Pattern that will match and capture the SD-ID and SD-PARAM PARAM-NAME as defined in the return from KeyProvider.getStructuredElementIdParamNameFormat().

Specified by:

getStructuredElementIdParamNamePattern in interface KeyProvider

Returns:

Pattern