org.apache.nifi.processors.windows.event.log

Class ConsumeWindowsEventLog

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"ingest","event","windows"})
 @TriggerSerially
 @CapabilityDescription(value="Registers a Windows Event Log Subscribe Callback to receive FlowFiles from Events on Windows.  These can be filtered via channel and XPath.")
 @WritesAttributes(value=@WritesAttribute(attribute="mime.type",description="Will set a MIME type value of application/xml."))
public class ConsumeWindowsEventLog
extends AbstractSessionFactoryProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_XML
static PropertyDescriptor	CHANNEL
static String	DEFAULT_CHANNEL
static int	DEFAULT_MAX_BUFFER
static int	DEFAULT_MAX_QUEUE_SIZE
static String	DEFAULT_XPATH
private ErrorLookup	errorLookup
private WEvtApi.EVT_SUBSCRIBE_CALLBACK	evtSubscribeCallback
static PropertyDescriptor	INACTIVE_DURATION_TO_RECONNECT
private long	inactiveDurationToReconnect
private com.sun.jna.platform.win32.Kernel32	kernel32
private Throwable	kernel32Error
private long	lastActivityTimestamp
static PropertyDescriptor	MAX_BUFFER_SIZE
static PropertyDescriptor	MAX_EVENT_QUEUE_SIZE
private String	name
static String	PROCESSOR_ALREADY_SUBSCRIBED
static List<PropertyDescriptor>	PROPERTY_DESCRIPTORS
private String	provenanceUri
static PropertyDescriptor	QUERY
static Relationship	REL_SUCCESS
static Set<Relationship>	RELATIONSHIPS
private BlockingQueue<String>	renderedXMLs
private ProcessSessionFactory	sessionFactory
private com.sun.jna.platform.win32.WinNT.HANDLE	subscriptionHandle
static String	UNABLE_TO_SUBSCRIBE
private WEvtApi	wEvtApi
private Throwable	wEvtApiError

Constructor Summary

Constructors

Constructor and Description
ConsumeWindowsEventLog() Framework constructor
ConsumeWindowsEventLog(WEvtApi wEvtApi, com.sun.jna.platform.win32.Kernel32 kernel32) Constructor that allows injection of JNA interfaces

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private boolean	isSubscribed()
private boolean	isSubscriptionHandleOpen()
private com.sun.jna.platform.win32.Kernel32	loadKernel32()
private WEvtApi	loadWEvtApi()
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
private int	processQueue(ProcessSession session) Create FlowFiles from received logs.
void	stop() Cleanup
private String	subscribe(ProcessContext context) Register subscriber via native call
private void	unsubscribe()

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

DEFAULT_CHANNEL

public static final String DEFAULT_CHANNEL

See Also:

Constant Field Values

DEFAULT_XPATH

public static final String DEFAULT_XPATH

See Also:

Constant Field Values

DEFAULT_MAX_BUFFER

public static final int DEFAULT_MAX_BUFFER

See Also:

Constant Field Values

DEFAULT_MAX_QUEUE_SIZE

public static final int DEFAULT_MAX_QUEUE_SIZE

See Also:

Constant Field Values

CHANNEL

public static final PropertyDescriptor CHANNEL

QUERY

public static final PropertyDescriptor QUERY

MAX_BUFFER_SIZE

public static final PropertyDescriptor MAX_BUFFER_SIZE

MAX_EVENT_QUEUE_SIZE

public static final PropertyDescriptor MAX_EVENT_QUEUE_SIZE

INACTIVE_DURATION_TO_RECONNECT

public static final PropertyDescriptor INACTIVE_DURATION_TO_RECONNECT

PROPERTY_DESCRIPTORS

public static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS

REL_SUCCESS

public static final Relationship REL_SUCCESS

RELATIONSHIPS

public static final Set<Relationship> RELATIONSHIPS

APPLICATION_XML

public static final String APPLICATION_XML

See Also:

Constant Field Values

UNABLE_TO_SUBSCRIBE

public static final String UNABLE_TO_SUBSCRIBE

See Also:

Constant Field Values

PROCESSOR_ALREADY_SUBSCRIBED

public static final String PROCESSOR_ALREADY_SUBSCRIBED

See Also:

Constant Field Values

wEvtApi

private final WEvtApi wEvtApi

kernel32

private final com.sun.jna.platform.win32.Kernel32 kernel32

errorLookup

private final ErrorLookup errorLookup

name

private final String name

wEvtApiError

private Throwable wEvtApiError

kernel32Error

private Throwable kernel32Error

renderedXMLs

private BlockingQueue<String> renderedXMLs

evtSubscribeCallback

private WEvtApi.EVT_SUBSCRIBE_CALLBACK evtSubscribeCallback

subscriptionHandle

private com.sun.jna.platform.win32.WinNT.HANDLE subscriptionHandle

sessionFactory

private ProcessSessionFactory sessionFactory

provenanceUri

private String provenanceUri

inactiveDurationToReconnect

private long inactiveDurationToReconnect

lastActivityTimestamp

private long lastActivityTimestamp

Constructor Detail

ConsumeWindowsEventLog

public ConsumeWindowsEventLog()

Framework constructor

ConsumeWindowsEventLog

public ConsumeWindowsEventLog(WEvtApi wEvtApi,
                              com.sun.jna.platform.win32.Kernel32 kernel32)

Constructor that allows injection of JNA interfaces

Parameters:

wEvtApi - event api interface

kernel32 - kernel interface

Method Detail

loadWEvtApi

private WEvtApi loadWEvtApi()

loadKernel32

private com.sun.jna.platform.win32.Kernel32 loadKernel32()

subscribe

private String subscribe(ProcessContext context)

Register subscriber via native call

Parameters:

context - the process context

isSubscriptionHandleOpen

private boolean isSubscriptionHandleOpen()

isSubscribed

private boolean isSubscribed()

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws AlreadySubscribedException

Throws:

AlreadySubscribedException

stop

@OnStopped
public void stop()

Cleanup

unsubscribe

private void unsubscribe()

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

Throws:

ProcessException

processQueue

private int processQueue(ProcessSession session)

Create FlowFiles from received logs.

Returns:

the number of created FlowFiles

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor