com.exalead.mercury.mami.connect.v10

Class PushConfig

java.lang.Object

com.exalead.mercury.mami.connect.v10.PushConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class PushConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Specifies how documents are sent to the indexing-server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	automaticRestartOnFailure
boolean	buffer
static boolean	DEFAULT_AUTOMATIC_RESTART_ON_FAILURE
static boolean	DEFAULT_BUFFER
static boolean	DEFAULT_PROFILE_PUSH_OPERATIONS
static boolean	DEFAULT_TRIGGER_INDEXING_AFTER_SCAN
boolean	profilePushOperations
boolean	triggerIndexingAfterScan

Constructor Summary

Constructors

Constructor and Description
PushConfig()
PushConfig(PushConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PushConfig.
static PushConfig	fromString(java.lang.String s) String representation of this PushConfig.
boolean	isAutomaticRestartOnFailure() When a scan throws a PushAPIException does this connector automatically restart? This allows the connector to retry a scan operation when a component in the indexing chain crashes. Set this option to false to disable the retry behavior.
boolean	isBuffer() Enables buffering of documents in the connector to send them as batches to the indexing server.
boolean	isProfilePushOperations() Enables profiling of push operations.
boolean	isTriggerIndexingAfterScan() Always triggers an indexing job after a completed scan.
PushConfig	makeCopy() Creates and returns a deep copy of this PushConfig.
static PushConfig	readFrom(java.io.InputStream is) Read this PushConfig from an XML fragment.
void	setAutomaticRestartOnFailure(boolean automaticRestartOnFailure) When a scan throws a PushAPIException does this connector automatically restart? This allows the connector to retry a scan operation when a component in the indexing chain crashes. Set this option to false to disable the retry behavior.
void	setBuffer(boolean buffer) Enables buffering of documents in the connector to send them as batches to the indexing server.
void	setProfilePushOperations(boolean profilePushOperations) Enables profiling of push operations.
void	setTriggerIndexingAfterScan(boolean triggerIndexingAfterScan) Always triggers an indexing job after a completed scan.
java.lang.String	toString() String representation of this PushConfig.
PushConfig	withAutomaticRestartOnFailure(boolean automaticRestartOnFailure)
PushConfig	withAutomaticRestartOnFailure(java.lang.Boolean automaticRestartOnFailure)
PushConfig	withBuffer(boolean buffer)
PushConfig	withBuffer(java.lang.Boolean buffer)
PushConfig	withProfilePushOperations(boolean profilePushOperations)
PushConfig	withProfilePushOperations(java.lang.Boolean profilePushOperations)
PushConfig	withTriggerIndexingAfterScan(boolean triggerIndexingAfterScan)
PushConfig	withTriggerIndexingAfterScan(java.lang.Boolean triggerIndexingAfterScan)
void	writeTo(java.io.OutputStream os) Write this PushConfig as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

buffer

public boolean buffer

DEFAULT_BUFFER

public static final boolean DEFAULT_BUFFER

See Also:

Constant Field Values

triggerIndexingAfterScan

public boolean triggerIndexingAfterScan

DEFAULT_TRIGGER_INDEXING_AFTER_SCAN

public static final boolean DEFAULT_TRIGGER_INDEXING_AFTER_SCAN

See Also:

Constant Field Values

profilePushOperations

public boolean profilePushOperations

DEFAULT_PROFILE_PUSH_OPERATIONS

public static final boolean DEFAULT_PROFILE_PUSH_OPERATIONS

See Also:

Constant Field Values

automaticRestartOnFailure

public boolean automaticRestartOnFailure

DEFAULT_AUTOMATIC_RESTART_ON_FAILURE

public static final boolean DEFAULT_AUTOMATIC_RESTART_ON_FAILURE

See Also:

Constant Field Values

Constructor Detail

PushConfig

public PushConfig()

PushConfig

public PushConfig(PushConfig o)

Copy constructor

Method Detail

setBuffer

public void setBuffer(boolean buffer)

Enables buffering of documents in the connector to send them as batches to the indexing server.

isBuffer

public boolean isBuffer()

Enables buffering of documents in the connector to send them as batches to the indexing server.

withBuffer

public PushConfig withBuffer(boolean buffer)

withBuffer

public PushConfig withBuffer(java.lang.Boolean buffer)

setTriggerIndexingAfterScan

public void setTriggerIndexingAfterScan(boolean triggerIndexingAfterScan)

Always triggers an indexing job after a completed scan.

isTriggerIndexingAfterScan

public boolean isTriggerIndexingAfterScan()

Always triggers an indexing job after a completed scan.

withTriggerIndexingAfterScan

public PushConfig withTriggerIndexingAfterScan(boolean triggerIndexingAfterScan)

withTriggerIndexingAfterScan

public PushConfig withTriggerIndexingAfterScan(java.lang.Boolean triggerIndexingAfterScan)

setProfilePushOperations

public void setProfilePushOperations(boolean profilePushOperations)

Enables profiling of push operations.
The profiling can be costly on small documents.

isProfilePushOperations

public boolean isProfilePushOperations()

Enables profiling of push operations.
The profiling can be costly on small documents.

withProfilePushOperations

public PushConfig withProfilePushOperations(boolean profilePushOperations)

withProfilePushOperations

public PushConfig withProfilePushOperations(java.lang.Boolean profilePushOperations)

setAutomaticRestartOnFailure

public void setAutomaticRestartOnFailure(boolean automaticRestartOnFailure)

When a scan throws a PushAPIException does this connector automatically restart?
This allows the connector to retry a scan operation when a component in the indexing chain crashes.
Set this option to false to disable the retry behavior.

isAutomaticRestartOnFailure

public boolean isAutomaticRestartOnFailure()

When a scan throws a PushAPIException does this connector automatically restart?
This allows the connector to retry a scan operation when a component in the indexing chain crashes.
Set this option to false to disable the retry behavior.

withAutomaticRestartOnFailure

public PushConfig withAutomaticRestartOnFailure(boolean automaticRestartOnFailure)

withAutomaticRestartOnFailure

public PushConfig withAutomaticRestartOnFailure(java.lang.Boolean automaticRestartOnFailure)

makeCopy

public PushConfig makeCopy()

Creates and returns a deep copy of this PushConfig.

readFrom

public static PushConfig readFrom(java.io.InputStream is)
                           throws javax.xml.bind.JAXBException

Read this PushConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this PushConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static PushConfig fromString(java.lang.String s)
                             throws javax.xml.bind.JAXBException,
                                    java.io.UnsupportedEncodingException

String representation of this PushConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PushConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this PushConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException