atg.endeca.index

Class RecordStoreDocumentSubmitter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.index.RecordSubmitterImpl

atg.endeca.index.RecordStoreDocumentSubmitter

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, RecordSubmitter, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, DocumentSubmitter, java.util.EventListener

public class RecordStoreDocumentSubmitter
extends atg.endeca.index.RecordSubmitterImpl
implements DocumentSubmitter

A document submitter that sends documents to an CAS record store. Depends upon the IndexingOutputConfig being an EndecaIndexingOutputConfig and creating a RecordStoreDocumentSubmitterSession. Selects a CAS record store using an RecordStoreAggregateSessionImpl instance, so may send to multiple record stores (based on current locale) in a single session.

Created: November 04 2011

See Also:

EndecaIndexingOutputConfig

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.repository.search.indexing.DocumentSubmitter

INDEXING_MODE_FULL, INDEXING_MODE_INCREMENTAL

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
RecordStoreDocumentSubmitter()

Method Summary

Modifier and Type	Method and Description
protected atg.endeca.index.AbstractRecordStoreAggregateSession	createSession(java.lang.String pIndexingMode) Create an instance of RecordStoreAggregateSessionImpl.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
int	getBatchSize() Returns property batchSize.
java.lang.String	getCASHostName() Return the hostname of our CAS service.
int	getCASPort() Return out CAS port.
java.lang.String	getDefaultLanguageForRecordStores()
java.util.Locale	getDefaultLocale() Get the default locale for the RecordSubmitter.
java.lang.String	getDefaultRecordStoreName() The "default" record store name.
java.lang.String	getEndecaDataStoreType() Returns property endecaDataStoreType.
java.util.Map<java.lang.String,java.lang.String>	getEveryRecordPropertyValues() Returns property everyRecordPropertyValues.
java.lang.String	getIdPropertyName() Returns property idPropertyName.
atg.endeca.index.configuration.IndexingApplicationConfiguration	getIndexingApplicationConfiguration() Returns property indexingApplicationConfiguration.
protected java.lang.String	getLanguageNameForLocale(java.util.Locale pLocale) Returns the language code of given locale
java.io.File	getPersistVariantSuffixesDir() Returns property persistVariantSuffixesDir.
java.util.Map<java.lang.String,java.lang.String>	getPropertyNameReplacementMap() Returns property propertyNameReplacementMap.
atg.endeca.index.RecordIdSetProvider	getRecordIdSetProvider() Returns property RecordIdSetProvider.
java.lang.String	getRecordStoreName(java.util.Locale pLocale, java.lang.Object pObject) Build up the record store name from endecaBaseApplicationName + "_" + the language of the passed in locale + endecaDataStoreType.
protected void	initSession(atg.endeca.index.AbstractRecordStoreAggregateSession pSession, java.lang.String pIndexingMode)
boolean	isEnabled() Returns property enabled.
boolean	isFlushAfterEveryRecord() Returns property flushAfterEveryRecord.
boolean	isForceIndexingCancellationOnException() Returns property forceIndexingCancellationOnException.
boolean	isPersistVariantsPerRepositoryId() Returns property persistVariantsPerRepositoryId.
boolean	isPortSsl() Returns property portSsl.
boolean	isResetActive()
boolean	isSynchronizeAroundGetService() Returns property synchronizeAroundGetService.
void	setBatchSize(int pBatchSize) Sets property batchSize.
void	setDefaultLanguageForRecordStores(java.lang.String pDefaultLanguageForRecordStores)
void	setDefaultLocale(java.util.Locale pDefaultLocale)
void	setEnabled(boolean pEnabled) Sets property enabled.
void	setEndecaDataStoreType(java.lang.String pEndecaDataStoreType) Sets property endecaDataStoreType.
void	setEveryRecordPropertyValues(java.util.Map<java.lang.String,java.lang.String> pEveryRecordPropertyValues) Sets property everyRecordPropertyValues.
void	setFlushAfterEveryRecord(boolean pFlushAfterEveryRecord) Sets property flushAfterEveryRecord.
void	setForceIndexingCancellationOnException(boolean pForceIndexingCancellationOnException) Sets property forceIndexingCancellationOnException.
void	setIdPropertyName(java.lang.String pIdPropertyName) Sets property idPropertyName.
void	setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration) Sets property indexingApplicationConfiguration.
void	setPersistVariantsPerRepositoryId(boolean pPersistVariantsPerRepositoryId) Sets property persistVariantsPerRepositoryId.
void	setPersistVariantSuffixesDir(java.io.File pPersistVariantSuffixesDir) Sets property persistVariantSuffixesDir.
void	setPortSsl(boolean pPortSsl) Sets property portSsl.
void	setPropertyNameReplacementMap(java.util.Map<java.lang.String,java.lang.String> pPropertyNameReplacementMap) Sets property propertyNameReplacementMap.
void	setRecordIdSetProvider(atg.endeca.index.RecordIdSetProvider pRecordIdSetProvider) Sets property RecordIdSetProvider.
void	setResetActive(boolean pResetActive)
void	setSynchronizeAroundGetService(boolean pSynchronizeAroundGetService) Sets property synchronizeAroundGetService.

Methods inherited from class atg.endeca.index.RecordSubmitterImpl

beginSession, cancelSession, endSession, getPersistKeysDir, getPersistKeyToRecordStoreName, setPersistKeysDir, setPersistKeyToRecordStoreName, shouldIgnoreSessionEnd

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.repository.search.indexing.DocumentSubmitter

beginSession, cancelSession, endSession

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RecordStoreDocumentSubmitter

public RecordStoreDocumentSubmitter()

Method Detail

getCASHostName

public java.lang.String getCASHostName()

Return the hostname of our CAS service.

getCASPort

public int getCASPort()

Return out CAS port.

setDefaultLocale

public void setDefaultLocale(java.util.Locale pDefaultLocale)

Overrides:

setDefaultLocale in class atg.endeca.index.RecordSubmitterImpl

getDefaultLocale

public java.util.Locale getDefaultLocale()

Description copied from interface: RecordSubmitter

Get the default locale for the RecordSubmitter. Used when the current context has no locale.

Specified by:

getDefaultLocale in interface RecordSubmitter

Overrides:

getDefaultLocale in class atg.endeca.index.RecordSubmitterImpl

setDefaultLanguageForRecordStores

public void setDefaultLanguageForRecordStores(java.lang.String pDefaultLanguageForRecordStores)

Overrides:

setDefaultLanguageForRecordStores in class atg.endeca.index.RecordSubmitterImpl

getDefaultLanguageForRecordStores

public java.lang.String getDefaultLanguageForRecordStores()

Overrides:

getDefaultLanguageForRecordStores in class atg.endeca.index.RecordSubmitterImpl

setEndecaDataStoreType

public void setEndecaDataStoreType(java.lang.String pEndecaDataStoreType)

Sets property endecaDataStoreType. The type of the endeca data store. This is typically one of "schema", "data", or "dimvals".

getEndecaDataStoreType

public java.lang.String getEndecaDataStoreType()

Returns property endecaDataStoreType. The type of the endeca data store. This is typically one of "schema", "data", or "dimvals".

setIdPropertyName

public void setIdPropertyName(java.lang.String pIdPropertyName)

Sets property idPropertyName. The name each record's ID property.

getIdPropertyName

public java.lang.String getIdPropertyName()

Returns property idPropertyName. The name of each records ID property.

setFlushAfterEveryRecord

public void setFlushAfterEveryRecord(boolean pFlushAfterEveryRecord)

Sets property flushAfterEveryRecord. Whether to flush after every record. This is much slower, but can be useful for debugging.

isFlushAfterEveryRecord

public boolean isFlushAfterEveryRecord()

Returns property flushAfterEveryRecord. Whether to flush after every record. This is much slower, but can be useful for debugging.

isResetActive

public boolean isResetActive()

setResetActive

public void setResetActive(boolean pResetActive)

getLanguageNameForLocale

protected java.lang.String getLanguageNameForLocale(java.util.Locale pLocale)

Returns the language code of given locale

Parameters:

pLocale - - locale

getRecordStoreName

public java.lang.String getRecordStoreName(java.util.Locale pLocale,
                                           java.lang.Object pObject)

Build up the record store name from endecaBaseApplicationName + "_" + the language of the passed in locale + endecaDataStoreType.

Parameters:

pLocale - the locale to use for the language name. If null, the property defaultLocale will be used instead.

getDefaultRecordStoreName

public java.lang.String getDefaultRecordStoreName()

The "default" record store name.

setBatchSize

public void setBatchSize(int pBatchSize)

Sets property batchSize. The number of records to queue up before sending over the wire to the RecordStore. Note that setting this property has not effect on already running RecordStoreDocumentSubmitterSessionImpl.

getBatchSize

public int getBatchSize()

Returns property batchSize. The number of records to queue up before sending over the wire to the RecordStore.

setEnabled

public void setEnabled(boolean pEnabled)

Sets property enabled. Whether this document submitter is enabled. If false, does everything except create a record store connection and write records.

isEnabled

public boolean isEnabled()

Returns property enabled. Whether this document submitter is enabled. If false, does everything except create a record store connection and write records.

setPortSsl

public void setPortSsl(boolean pPortSsl)

Sets property portSsl. Set to true if SSL is to be used for this DocumentSubmitter

Parameters:

pPortSsl - portSsl

isPortSsl

public boolean isPortSsl()

Returns property portSsl. Returns true if SSL is to be used for this DocumentSubmitter

Returns:

the portSsl property

setPersistVariantSuffixesDir

public void setPersistVariantSuffixesDir(java.io.File pPersistVariantSuffixesDir)

Sets property persistVariantSuffixesDir. The file to which variant suffixes should be saved at the end of a session.

getPersistVariantSuffixesDir

public java.io.File getPersistVariantSuffixesDir()

Returns property persistVariantSuffixesDir. The file to which variant suffixes should be saved at the end of a session.

setSynchronizeAroundGetService

public void setSynchronizeAroundGetService(boolean pSynchronizeAroundGetService)

Sets property synchronizeAroundGetService. Whether to do a class synchronization around getService().

isSynchronizeAroundGetService

public boolean isSynchronizeAroundGetService()

Returns property synchronizeAroundGetService. Whether to do a class synchronization around getService().

setPersistVariantsPerRepositoryId

public void setPersistVariantsPerRepositoryId(boolean pPersistVariantsPerRepositoryId)

Sets property persistVariantsPerRepositoryId. Whether to persist variants an a per-repository ID basis. Should only be set to true if persisting a relatively small number of items (not for products/skus, for example).

isPersistVariantsPerRepositoryId

public boolean isPersistVariantsPerRepositoryId()

Returns property persistVariantsPerRepositoryId. Whether to persist variants an a per-repository ID basis. Should only be set to true if persisting a relatively small number of items (not for products/skus, for example).

setIndexingApplicationConfiguration

public void setIndexingApplicationConfiguration(atg.endeca.index.configuration.IndexingApplicationConfiguration pIndexingApplicationConfiguration)

Sets property indexingApplicationConfiguration. The Endeca host and application configuration.

getIndexingApplicationConfiguration

public atg.endeca.index.configuration.IndexingApplicationConfiguration getIndexingApplicationConfiguration()

Returns property indexingApplicationConfiguration. The Endeca host and application configuration.

setPropertyNameReplacementMap

public void setPropertyNameReplacementMap(java.util.Map<java.lang.String,java.lang.String> pPropertyNameReplacementMap)

Sets property propertyNameReplacementMap. A map for translating property names.

getPropertyNameReplacementMap

public java.util.Map<java.lang.String,java.lang.String> getPropertyNameReplacementMap()

Returns property propertyNameReplacementMap. A map for translating property names.

setEveryRecordPropertyValues

public void setEveryRecordPropertyValues(java.util.Map<java.lang.String,java.lang.String> pEveryRecordPropertyValues)

Sets property everyRecordPropertyValues. Property values that should be added to every record submitted.

getEveryRecordPropertyValues

public java.util.Map<java.lang.String,java.lang.String> getEveryRecordPropertyValues()

Returns property everyRecordPropertyValues. Property values that should be added to every record submitted.

setForceIndexingCancellationOnException

public void setForceIndexingCancellationOnException(boolean pForceIndexingCancellationOnException)

Sets property forceIndexingCancellationOnException. Whether to cancel indexing on any exception. This should be considered a work-around, and should not be enabled by default.

isForceIndexingCancellationOnException

public boolean isForceIndexingCancellationOnException()

Returns property forceIndexingCancellationOnException. Whether to cancel indexing on any exception. This should be considered a work-around, and should not be enabled by default.

setRecordIdSetProvider

public void setRecordIdSetProvider(atg.endeca.index.RecordIdSetProvider pRecordIdSetProvider)

Sets property RecordIdSetProvider. Provides a set of record ids for a given repository item .

getRecordIdSetProvider

public atg.endeca.index.RecordIdSetProvider getRecordIdSetProvider()

Returns property RecordIdSetProvider. Provides a set of record ids for a given repository item .

doStartService

public void doStartService()
                    throws ServiceException

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up hidden: true

createSession

protected atg.endeca.index.AbstractRecordStoreAggregateSession createSession(java.lang.String pIndexingMode)
                                                                      throws IndexingException

Create an instance of RecordStoreAggregateSessionImpl.

Specified by:

createSession in class atg.endeca.index.RecordSubmitterImpl

Parameters:

pIndexingMode - the indexing mode to use for the session

Throws:

IndexingException

initSession

protected void initSession(atg.endeca.index.AbstractRecordStoreAggregateSession pSession,
                           java.lang.String pIndexingMode)

Overrides:

initSession in class atg.endeca.index.RecordSubmitterImpl