com.endeca.soleng.eac.toolkit.component

Class ForgeComponent

java.lang.Object

com.endeca.soleng.eac.toolkit.base.EacElement

com.endeca.soleng.eac.toolkit.base.Provisionable

com.endeca.soleng.eac.toolkit.component.Component

com.endeca.soleng.eac.toolkit.component.BatchComponent

com.endeca.soleng.eac.toolkit.component.ForgeComponent

public class ForgeComponent
extends com.endeca.soleng.eac.toolkit.component.BatchComponent

Field Summary

Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir

Constructor Summary

Constructors

Constructor and Description
ForgeComponent()

Method Summary

Modifier and Type	Method and Description
void	archiveCumulativePartials()
void	archiveState()
com.endeca.eac.client.ComponentType	buildEacStub()
void	cleanCumulativePartials()
void	cleanDirs()
com.endeca.soleng.eac.toolkit.utility.CopyUtility	createConfigCopyUtility()
com.endeca.soleng.eac.toolkit.utility.CopyUtility	createIncomingDataCopyUtility()
static void	extractZip(File zipFile, File outputDir) extracts the content of the given zip file into a target destination folder.
void	fetchPartialsToCumulativeDir()
List<String>	getArgs()
void	getConfig() Retrieves pipeline and config for Forge to process.
String	getConfigDir()
String	getConfigHost()
void	getConfigSnapshot(String configSnapshotDir) Copies the IFCR configuration from the ConfigSnapshots Directory to the Forge Output Directory.
String	getCredentialsMap()
String	getCumulativePartialsDir()
void	getData() Retrieves the application's data and dimensions files to Forge's input directory for processing.
String	getForgeGroup()
void	getIncomingData() Retrieves incoming data for Forge to process.
String	getIncomingDataDir()
String	getIncomingDataFileName()
String	getIncomingDataHost()
String	getInputDir()
String	getJpsConfigPath()
int	getNumPartialsBackups()
int	getNumPartitions()
int	getNumStateArchives()
String	getOpssJarsDir()
String	getOutputDir()
void	getPartialData()
void	getPartialIncomingData()
String	getPipelineFile()
void	getPostForgeDimensions()
String	getPostForgeDimsPath()
String	getStateDir()
String	getTempDir()
int	getWebServicePort()
protected void	initializeEacStub(com.endeca.eac.client.ForgeComponentType stub)
boolean	isDataReady()
boolean	isPartialDataReady()
void	removeBaselineDataReadyFlag()
String	retrieveCurrentConfigurationSnapshot(String directoryName) Retieves the name of the current configuration snapshot in the directory given.
void	setArgs(List<String> args)
void	setCredentialsMap(String credentialsMap)
void	setInputDir(String inputDir)
void	setJpsConfigPath(String jpsConfigPath)
void	setNumPartitions(int numPartitions)
void	setOpssJarsDir(String opssJarsDir)
void	setOutputDir(String outputDir)
void	setPipelineFile(String pipelineFile)
void	setStateDir(String stateDir)
void	setTempDir(String tempDir)
void	setWebServicePort(int webServicePort)
void	timestampPartials()

Methods inherited from class com.endeca.soleng.eac.toolkit.component.BatchComponent

run, runInParallel

Methods inherited from class com.endeca.soleng.eac.toolkit.component.Component

archiveLogDir, cleanDir, constructArchiveLogDir, constructCleanDir, getCaFile, getCertFile, getCipher, getCustomDirectories, getDEFAULT_CIPHER, getDirProperties, getHost, getHostId, getLongPropertyValueOrDefault, getMaxMissedStatusChecksAllowed, getMaxWaitTimeSeconds, getMinWaitTimeSeconds, getNumLogBackups, getNumMissedStatusChecks, getProperties, getProperty, getSlowPollingIntervalMs, getSslConfig, getStandardPollingIntervalMs, getStatus, incrementMissedStatusQueries, initializeEacStub, isActive, isDefined, isDefinitionChanged, isFailed, isHotUpdateDefinitionChange, isSkipTestingForFilesDuringCleanup, removeDefinition, setCaFile, setCertFile, setCipher, setCustomDirectories, setDefinition, setDefinition, setHost, setHostId, setNumMissedStatusChecks, setProperties, setSslConfig, start, stop, updateDefinition, updateEacDefinition, updateEacDefinition, waitForFinished

Methods inherited from class com.endeca.soleng.eac.toolkit.base.Provisionable

getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition

Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir

Methods inherited from class java.lang.Object

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

Constructor Detail

ForgeComponent

public ForgeComponent()

Method Detail

cleanDirs

public void cleanDirs()
               throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                      com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                      com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                      InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

cleanCumulativePartials

public void cleanCumulativePartials()
                             throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                    com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                    com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                    InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

getData

public void getData()
             throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                    com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                    InterruptedException,
                    com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Retrieves the application's data and dimensions files to Forge's input directory for processing.

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

getPartialData

public void getPartialData()
                    throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                           com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                           InterruptedException,
                           com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

createIncomingDataCopyUtility

public com.endeca.soleng.eac.toolkit.utility.CopyUtility createIncomingDataCopyUtility()
                                                                                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                                                                       com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                                                                       com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                                                                       InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

removeBaselineDataReadyFlag

public void removeBaselineDataReadyFlag()
                                 throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

getIncomingData

public void getIncomingData()
                     throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                            com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                            com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                            InterruptedException

Retrieves incoming data for Forge to process. In this implementation, the data is assumed to be extracted data files found in the directory identified in the custom incomingDataDir directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

getPartialIncomingData

public void getPartialIncomingData()
                            throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                   com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                   com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                   InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

timestampPartials

public void timestampPartials()
                       throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                              com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                              com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                              InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

fetchPartialsToCumulativeDir

public void fetchPartialsToCumulativeDir()
                                  throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                         com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                         InterruptedException,
                                         com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

createConfigCopyUtility

public com.endeca.soleng.eac.toolkit.utility.CopyUtility createConfigCopyUtility()
                                                                          throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                                                                 com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                                                                 InterruptedException,
                                                                                 com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

getConfig

public void getConfig()
               throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                      com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                      InterruptedException,
                      com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Retrieves pipeline and config for Forge to process. In this implementation, all files in the specified config directory are retrieved.

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

getConfigSnapshot

public void getConfigSnapshot(String configSnapshotDir)
                       throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                              com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                              InterruptedException,
                              com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Copies the IFCR configuration from the ConfigSnapshots Directory to the Forge Output Directory. This step is triggered as part of baseline operation

Parameters:

configSnapshotDir - Path of the configSnapshotDirectory

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

extractZip

public static void extractZip(File zipFile,
                              File outputDir)
                       throws IOException

extracts the content of the given zip file into a target destination folder. If the target directory is not specified, the content would be extracted to the same directory.

Parameters:

zipFile -

outputDir -

Throws:

IOException

retrieveCurrentConfigurationSnapshot

public String retrieveCurrentConfigurationSnapshot(String directoryName)
                                            throws IOException

Retieves the name of the current configuration snapshot in the directory given.

Parameters:

directoryName - The directory name containing the configuration files and current file tracker file

Returns:

The name of the most current configuration snapshot

Throws:

IOException - is thrown if there was a problem reading the file or retrieving the most current value

getPostForgeDimensions

public void getPostForgeDimensions()
                            throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                   com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                   InterruptedException,
                                   com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

archiveState

public void archiveState()
                  throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                         com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                         com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                         InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

isDataReady

public boolean isDataReady()

isPartialDataReady

public boolean isPartialDataReady()
                           throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                  com.endeca.soleng.eac.toolkit.exception.AppControlException,
                                  com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                  com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                  InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.AppControlException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

archiveCumulativePartials

public void archiveCumulativePartials()
                               throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                      com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                      com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                      InterruptedException

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

buildEacStub

public com.endeca.eac.client.ComponentType buildEacStub()

Overrides:

buildEacStub in class com.endeca.soleng.eac.toolkit.component.Component

initializeEacStub

protected void initializeEacStub(com.endeca.eac.client.ForgeComponentType stub)

getForgeGroup

public String getForgeGroup()

getIncomingDataHost

public String getIncomingDataHost()

getIncomingDataDir

public String getIncomingDataDir()

getIncomingDataFileName

public String getIncomingDataFileName()

getConfigHost

public String getConfigHost()

getConfigDir

public String getConfigDir()

getPostForgeDimsPath

public String getPostForgeDimsPath()

getCumulativePartialsDir

public String getCumulativePartialsDir()

getNumStateArchives

public int getNumStateArchives()

getNumPartialsBackups

public int getNumPartialsBackups()

getArgs

public List<String> getArgs()

setArgs

public void setArgs(List<String> args)

getInputDir

public String getInputDir()

setInputDir

public void setInputDir(String inputDir)

getNumPartitions

public int getNumPartitions()

setNumPartitions

public void setNumPartitions(int numPartitions)

getOutputDir

public String getOutputDir()

setOutputDir

public void setOutputDir(String outputDir)

getPipelineFile

public String getPipelineFile()

setPipelineFile

public void setPipelineFile(String pipelineFile)

getStateDir

public String getStateDir()

setStateDir

public void setStateDir(String stateDir)

getTempDir

public String getTempDir()

setTempDir

public void setTempDir(String tempDir)

getCredentialsMap

public String getCredentialsMap()

setCredentialsMap

public void setCredentialsMap(String credentialsMap)

getJpsConfigPath

public String getJpsConfigPath()

setJpsConfigPath

public void setJpsConfigPath(String jpsConfigPath)

getOpssJarsDir

public String getOpssJarsDir()

setOpssJarsDir

public void setOpssJarsDir(String opssJarsDir)

getWebServicePort

public int getWebServicePort()

setWebServicePort

public void setWebServicePort(int webServicePort)