org.nuxeo.ecm.core.search.api.events
Interface IndexingEventConf

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IndexingEventDescriptor

public interface IndexingEventConf
extends java.io.Serializable

Indexing Event Configuration:

Stores index related operations that are to be performed for the given event. These operations typically apply to a document that is passed along with the event, although instances of this class don't handle it.

Author:

Georges Racinet

Field Summary

static java.lang.String	INDEX
static java.lang.String	NEVER
static java.lang.String	ONLY_ASYNC
static java.lang.String	ONLY_SYNC
static java.lang.String	RE_INDEX
static java.lang.String	SYNC_ASYNC
static java.lang.String	UN_INDEX

Method Summary

java.lang.String	getAction() Get the action to perform.
java.lang.String	getMode() Define the mode used to perform the operation ONLY_ASYNC ="Asynchronous" ONLY_SYNC ="Synchronous" SYNC_ASYNC ="Both"
java.util.Set<java.lang.String>	getRelevantResources() Lists the resources that are impacted by the event.
boolean	isRecursive() Must the operation recurse on documents ?

Field Detail

INDEX

static final java.lang.String INDEX

See Also:

Constant Field Values

UN_INDEX

static final java.lang.String UN_INDEX

See Also:

Constant Field Values

RE_INDEX

static final java.lang.String RE_INDEX

See Also:

Constant Field Values

ONLY_ASYNC

static final java.lang.String ONLY_ASYNC

See Also:

Constant Field Values

ONLY_SYNC

static final java.lang.String ONLY_SYNC

See Also:

Constant Field Values

SYNC_ASYNC

static final java.lang.String SYNC_ASYNC

See Also:

Constant Field Values

NEVER

static final java.lang.String NEVER

See Also:

Constant Field Values

Method Detail

getAction

java.lang.String getAction()

Get the action to perform.

Returns:

a string

isRecursive

boolean isRecursive()

Must the operation recurse on documents ?

Returns:

a boolean

getRelevantResources

java.util.Set<java.lang.String> getRelevantResources()

Lists the resources that are impacted by the event.

This allows to restrict the event to some resources. For instance, the actions that the event signals can require a reindexing of security policies without changing other resources, e.g, the full text, whose indexing can be very costly.

Returns:

the set of resource names, as registered against the Search Service, or null to mean all.

getMode

java.lang.String getMode()

Define the mode used to perform the operation ONLY_ASYNC ="Asynchronous" ONLY_SYNC ="Synchronous" SYNC_ASYNC ="Both"

Returns:

a String