org.nuxeo.ecm.core.search.api.events
Class IndexingEventDescriptor

java.lang.Object
  org.nuxeo.ecm.core.search.api.events.IndexingEventDescriptor

All Implemented Interfaces:

java.io.Serializable, IndexingEventConf

public class IndexingEventDescriptor
extends java.lang.Object
implements IndexingEventConf

Author:

Georges Racinet

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.nuxeo.ecm.core.search.api.events.IndexingEventConf

INDEX, NEVER, ONLY_ASYNC, ONLY_SYNC, RE_INDEX, SYNC_ASYNC, UN_INDEX

Constructor Summary

IndexingEventDescriptor()

IndexingEventDescriptor(java.lang.String action, java.util.Set<java.lang.String> resources, boolean recursive, java.lang.String name)

IndexingEventDescriptor(java.lang.String action, java.util.Set<java.lang.String> resources, boolean recursive, java.lang.String name, java.lang.String mode)

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.lang.String	getName()
java.util.Set<java.lang.String>	getRelevantResources() Lists the resources that are impacted by the event.
boolean	isRecursive() Must the operation recurse on documents ?

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexingEventDescriptor

public IndexingEventDescriptor()

IndexingEventDescriptor

public IndexingEventDescriptor(java.lang.String action,
                               java.util.Set<java.lang.String> resources,
                               boolean recursive,
                               java.lang.String name)

IndexingEventDescriptor

public IndexingEventDescriptor(java.lang.String action,
                               java.util.Set<java.lang.String> resources,
                               boolean recursive,
                               java.lang.String name,
                               java.lang.String mode)

Method Detail

getAction

public java.lang.String getAction()

Description copied from interface: IndexingEventConf

Get the action to perform.

Specified by:

getAction in interface IndexingEventConf

Returns:

a string

getRelevantResources

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

Description copied from interface: IndexingEventConf

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.

Specified by:

getRelevantResources in interface IndexingEventConf

Returns:

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

isRecursive

public boolean isRecursive()

Description copied from interface: IndexingEventConf

Must the operation recurse on documents ?

Specified by:

isRecursive in interface IndexingEventConf

Returns:

a boolean

getName

public java.lang.String getName()

getMode

public java.lang.String getMode()

Description copied from interface: IndexingEventConf

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

Specified by:

getMode in interface IndexingEventConf

Returns:

a String