Package com.norconex.committer.amazoncloudsearch

Class AmazonCloudSearchCommitter

java.lang.Object

com.norconex.committer.core.AbstractCommitter<AmazonCloudSearchCommitterConfig>

com.norconex.committer.core.batch.AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

com.norconex.committer.amazoncloudsearch.AmazonCloudSearchCommitter

All Implemented Interfaces:

BatchConsumer, Committer, Configurable<AmazonCloudSearchCommitterConfig>, AutoCloseable

public class AmazonCloudSearchCommitter
extends AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

Commits documents to Amazon CloudSearch.

Authentication:

An access key and security key are required to connect to and interact with CloudSearch. For enhanced security, it is best to use one of the methods described in DefaultAWSCredentialsProviderChain for setting them (environment variables, system properties, profile file, etc). Do not explicitly set "accessKey" and "secretKey" on this class if you want to rely on safer methods.

CloudSearch ID limitations:

As of this writing, CloudSearch has a 128 characters length limitation on its "id" field. In addition, certain characters are not allowed. By default, an error will result from trying to submit documents with an invalid ID. You can get around this by setting AmazonCloudSearchCommitterConfig.setFixBadIds(boolean) to true. It will truncate references that are too long and append a hash code to it to keep uniqueness. It will also convert invalid characters to underscore. This approach is not 100% collision-free (uniqueness), but it should safely cover the vast majority of cases.

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COULDSEARCH_ID_FIELD	CloudSearch mandatory ID field
static final Pattern	FIELD_PATTERN	CouldSearch mandatory field pattern.

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
AmazonCloudSearchCommitter()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected void	closeBatchCommitter()	Subclasses can perform additional closing logic by overriding this method.
protected void	commitBatch(Iterator<CommitterRequest> it)	Commits the supplied batch.
boolean	equals(Object o)
AmazonCloudSearchCommitterConfig	getConfiguration()
int	hashCode()
protected void	initBatchCommitter()	Subclasses can perform additional initialization by overriding this method.
String	toString()

Methods inherited from class com.norconex.committer.core.batch.AbstractBatchCommitter

consume, doClean, doClose, doDelete, doInit, doUpsert, getInitializedQueue

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

FIELD_PATTERN

public static final Pattern FIELD_PATTERN

CouldSearch mandatory field pattern. Characters not matching the pattern will be replaced by an underscore.

COULDSEARCH_ID_FIELD

public static final String COULDSEARCH_ID_FIELD

CloudSearch mandatory ID field

See Also:

• Constant Field Values

Constructor Details

AmazonCloudSearchCommitter

public AmazonCloudSearchCommitter()

Method Details

initBatchCommitter

protected void initBatchCommitter()
                           throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The committer context and committer queue will be already initialized when invoking AbstractCommitter.getCommitterContext() and AbstractBatchCommitter.getInitializedQueue(), respectively.

Overrides:

initBatchCommitter in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

Throws:

CommitterException - error initializing

commitBatch

protected void commitBatch(Iterator<CommitterRequest> it)
                    throws CommitterException

Description copied from class: AbstractBatchCommitter

Commits the supplied batch.

Specified by:

commitBatch in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

Parameters:

it - the batch to commit

Throws:

CommitterException - could not commit the batch

closeBatchCommitter

protected void closeBatchCommitter()
                            throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Overrides:

closeBatchCommitter in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

Throws:

CommitterException - error closing committer

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractBatchCommitter<AmazonCloudSearchCommitterConfig>

getConfiguration

public AmazonCloudSearchCommitterConfig getConfiguration()