com.exalead.papi.framework.connectors.event

Interface Event

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ErrorEvent, MessageEvent

All Known Implementing Classes:

FlatErrorEvent, FlatEvent

public interface Event
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() An code to identify the error.
java.lang.String	getComponentName() The name of the component that generated this event For example JDBC_CONNECTOR By default the component name is set to the simple name of the class that generated this event.
java.lang.Long	getCreationTimeStamp() A timestamp to log the creation date of the event.
java.lang.String	getIdentifier() A document identifier.
java.lang.String	getLabel() A human readable short text to describe briefly the event The title is displayed in the UI The title must not exceed 256 string length() size
java.lang.Long	getModificationTimeStamp() A timestamp to log the modification date of the event.
java.lang.String	getReportingCodePointer() Returns the class that created this event For internal use only
java.util.Map<java.lang.Class<? extends java.io.Serializable>,java.lang.Iterable<? extends java.io.Serializable>>	getSubContexts() A map that contains all the context object WARNING this Map is immutable, you cannot add context when you get event contexts
<T extends java.io.Serializable> java.lang.Iterable<T>	getSubContexts(java.lang.Class<T> aClass) Lists all contexts of a given type

Method Detail

getCreationTimeStamp

java.lang.Long getCreationTimeStamp()

A timestamp to log the creation date of the event. By default it is the date at which event has been created The time stamp is displayed in the event list of the UI

Returns:

getModificationTimeStamp

java.lang.Long getModificationTimeStamp()

A timestamp to log the modification date of the event. By default it is the date at which event has been modified in the backend The time stamp is displayed in the event list of the UI

Returns:

getCode

java.lang.String getCode()

An code to identify the error. This code may be used to filter errors This code may contain informations about the component that generated this event For example INCREMENTAL_QUERY-UNKNOWN or INCREMENTAL_DELETE-CONNECTION_ERROR (example based on JDBC connector) By default the code is UNKNOWN This code is displayed in the event list of admin UI The code length must not exceed 128 string length() size

Returns:

getComponentName

java.lang.String getComponentName()

The name of the component that generated this event For example JDBC_CONNECTOR By default the component name is set to the simple name of the class that generated this event. If this event is created inside a Connector this field is immutable and the value is the name of the connector The name of the component must not exceed 128 string length() size

Returns:

the name of the component that generated this event

getLabel

java.lang.String getLabel()

A human readable short text to describe briefly the event The title is displayed in the UI The title must not exceed 256 string length() size

Returns:

getReportingCodePointer

java.lang.String getReportingCodePointer()

Returns the class that created this event For internal use only

Returns:

getIdentifier

java.lang.String getIdentifier()

A document identifier. May be whatever the connector needs to display to identify a document For example

• if your connector handles a text file the identifier will be the file path followed by the line number (:)
• if your connector reads entries in a database the identifier will be the query that failed with its parameters (not a prepared statement)
• if your connector consumes results of a webservice the identifier will be the last object with its parameters you client got from the webservice

The identifier is used to know

• if the connector always fails on the same item
• which item caused a failure to guide the administrator to the source of the problem
• if the item on which connector fails is known by the administrator as being corrupted

Returns:

getSubContexts

java.util.Map<java.lang.Class<? extends java.io.Serializable>,java.lang.Iterable<? extends java.io.Serializable>> getSubContexts()

A map that contains all the context object WARNING this Map is immutable, you cannot add context when you get event contexts

Returns:

getSubContexts

<T extends java.io.Serializable> java.lang.Iterable<T> getSubContexts(java.lang.Class<T> aClass)

Lists all contexts of a given type

Parameters:

aClass -

Returns: