com.exalead.papi.framework.connectors.event

Interface EventBuilder<E extends Event,B extends EventBuilder<E,B>>

All Known Subinterfaces:

ErrorEventBuilder, MessageEventBuilder

All Known Implementing Classes:

FlatErrorEvent, FlatEvent

public interface EventBuilder<E extends Event,B extends EventBuilder<E,B>>

Method Summary

Modifier and Type	Method and Description
<CTX extends java.io.Serializable> B	addContext(CTX context) Adds a context to the event being created
<CTX extends java.io.Serializable> B	addContexts(java.lang.Iterable<CTX> context) Adds a list of context to the event being created
E	emit() Sends a event to the backend.
B	withCode(java.lang.String code) Sets the code of the Event being created Throws an IllegalAccessError if length() of the String is more than 128 long
B	withComponentName(java.lang.String componentName) Sets the component name of the Event being created Throws an IllegalAccessError if length() of the String is more than 128 long
B	withCreationTimeStamp(java.util.Date timeStamp) Sets the time stamp of the Event being created Throws an IllegalAccessError if time stamp is more than an hour before current environment time
B	withIdentifier(java.lang.String identifier) Sets the identifier of the event that is currently built
B	withLabel(java.lang.String label) Sets the title of the Event being created Throws an IllegalAccessError if length() of the String is more than 256 long

Method Detail

withIdentifier

B withIdentifier(java.lang.String identifier)

Sets the identifier of the event that is currently built

Parameters:

identifier - the identifier of the target event Event.getIdentifier()

Returns:

withCreationTimeStamp

B withCreationTimeStamp(java.util.Date timeStamp)

Sets the time stamp of the Event being created Throws an IllegalAccessError if time stamp is more than an hour before current environment time

Parameters:

timeStamp - the time stamp value

Returns:

withCode

B withCode(java.lang.String code)

Sets the code of the Event being created Throws an IllegalAccessError if length() of the String is more than 128 long

Parameters:

code -

Returns:

withComponentName

B withComponentName(java.lang.String componentName)

Sets the component name of the Event being created Throws an IllegalAccessError if length() of the String is more than 128 long

Parameters:

code -

Returns:

withLabel

B withLabel(java.lang.String label)

Sets the title of the Event being created Throws an IllegalAccessError if length() of the String is more than 256 long

Parameters:

code -

Returns:

addContext

<CTX extends java.io.Serializable> B addContext(CTX context)

Adds a context to the event being created

Parameters:

context -

Returns:

addContexts

<CTX extends java.io.Serializable> B addContexts(java.lang.Iterable<CTX> context)

Adds a list of context to the event being created

Parameters:

context -

Returns:

emit

E emit()

Sends a event to the backend. If the event is an error and it occurs too many times a runtime exception will be thrown by this method If the event is a message you cannot report more than 10.000 message per scan. When this number is reached a runtime exception is thrown

Parameters:

event -