Package com.fluenda.parcefone.event

Class CefRev23

java.lang.Object

com.fluenda.parcefone.event.CommonEvent

com.fluenda.parcefone.event.CefRev23

public class CefRev23
extends CommonEvent

Implements the Common Event Format (CEF) as documented by revision 23 (Retrieved on August 2016).

Constructor Summary

Constructors

Constructor	Description
CefRev23()	Default constructor with date locale set to English
CefRev23(Locale locale)	Standard constructor with locale for date objects

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getExtension(boolean populatedOnly)	Get map of named extensions
Map<String,Object>	getExtension(boolean populatedOnly, boolean includeCustomExtensions)	Get map of named extensions after applying specified filtering
Map<String,Object>	getHeader()	Get map of named headers
void	setExtension(Map<String,String> extensions)	Set extensions using named key to object value
void	setExtension(Map<String,String> extensions, boolean allowNulls)	Set extensions using named key to object value with specified handling for null values
void	setHeader(Map<String,Object> headers)	Set headers using named key to object value

Methods inherited from class java.lang.Object

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

Constructor Detail

CefRev23

public CefRev23(Locale locale)

Standard constructor with locale for date objects

Parameters:

locale - Locale for date objects

CefRev23

public CefRev23()

Default constructor with date locale set to English

Method Detail

setHeader

public void setHeader(Map<String,Object> headers)
               throws CEFHandlingException

Description copied from class: CommonEvent

Set headers using named key to object value

Specified by:

setHeader in class CommonEvent

Parameters:

headers - A map containing the keys and values of headers of CEF event

Throws:

CEFHandlingException - when it has issues writing the values of the headers

getHeader

public Map<String,Object> getHeader()
                                   throws CEFHandlingException

Description copied from class: CommonEvent

Get map of named headers

Specified by:

getHeader in class CommonEvent

Returns:

A map containing the keys and values of headers

Throws:

CEFHandlingException - when it has issues reading the headers of CEF event

setExtension

public void setExtension(Map<String,String> extensions)
                  throws CEFHandlingException

Description copied from class: CommonEvent

Set extensions using named key to object value

Specified by:

setExtension in class CommonEvent

Parameters:

extensions - A map containing the keys and values of extensions of CEF event

Throws:

CEFHandlingException - when it has issues populating the extensions

setExtension

public void setExtension(Map<String,String> extensions,
                         boolean allowNulls)
                  throws CEFHandlingException

Description copied from class: CommonEvent

Set extensions using named key to object value with specified handling for null values

Specified by:

setExtension in class CommonEvent

Parameters:

extensions - A map containing the keys and values of extensions of CEF event

allowNulls - If true, extensions with an empty value will be seen as null. If false, parsing may fail depending on extension types

Throws:

CEFHandlingException - when it has issues populating the extensions

getExtension

public Map<String,Object> getExtension(boolean populatedOnly)
                                      throws CEFHandlingException

Description copied from class: CommonEvent

Get map of named extensions

Specified by:

getExtension in class CommonEvent

Parameters:

populatedOnly - Boolean defining if Map should include all fields supported by CefRev23

Returns:

A map containing the keys and values of CEF extensions

Throws:

CEFHandlingException - when it hits issues (e.g. IllegalAccessException) reading the extensions

getExtension

public Map<String,Object> getExtension(boolean populatedOnly,
                                             boolean includeCustomExtensions)
                                      throws CEFHandlingException

Description copied from class: CommonEvent

Get map of named extensions after applying specified filtering

Specified by:

getExtension in class CommonEvent

Parameters:

populatedOnly - Boolean defining if Map should include all fields supported by CefRev23

includeCustomExtensions - Boolean defining if Map should include parsed keys that are not supported part of the base CEF Rev23 specification

Returns:

A map containing the keys and values of CEF extensions

Throws:

CEFHandlingException - when it hits issues (e.g. IllegalAccessException) reading the extensions