com.github.palindromicity.syslog

Interface KeyProvider

All Known Implementing Classes:

DefaultKeyProvider

public interface KeyProvider

KeyProvider defines an interface for classes that can be used to provide Map keys used for Syslog 5424 message parts.

Method Summary

Modifier and Type	Method and 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 getStructuredElementIdParamNameFormat().

Method Detail

getMessage

String getMessage()

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

Returns:

MSG key name

getHeaderAppName

String getHeaderAppName()

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

Returns:

APP-NAME key name

getHeaderHostName

String getHeaderHostName()

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

Returns:

HOSTNAME key name

getHeaderPriority

String getHeaderPriority()

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

Returns:

PRI key name

getHeaderSeverity

String getHeaderSeverity()

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

Returns:

PRI key name

getHeaderFacility

String getHeaderFacility()

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

Returns:

PRI key name

getHeaderProcessId

String getHeaderProcessId()

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

Returns:

PROCID key name

getHeaderTimeStamp

String getHeaderTimeStamp()

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

Returns:

TIMESTAMP key name

getHeaderMessageId

String getHeaderMessageId()

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

Returns:

MSGID key name

getHeaderVersion

String getHeaderVersion()

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

Returns:

VERSION key name

getStructuredBase

String getStructuredBase()

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

Returns:

STRUCTURED_DATA base key name

See Also:

Section 6.3

getStructuredElementIdFormat

String getStructuredElementIdFormat()

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 getStructuredBase() For example:

    syslog.structuredData.%s
 

Returns:

SD-ID format String

getStructuredElementIdParamNameFormat

String getStructuredElementIdParamNameFormat()

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 getStructuredBase() For example:

    syslog.structuredData.%s.%s
 

Returns:

SD-PARAM format String

getStructuredElementIdParamNamePattern

Pattern getStructuredElementIdParamNamePattern()

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

Returns:

Pattern